- Notifications
You must be signed in to change notification settings - Fork1
Updated version of node-oauth that uses async functions rather than callbacks.
License
SimplyNate/simply-oauth
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This is a fork ofnode-oauth to modernize the API with async functions and ES6+ features.
Original work byCiaran Jessup:node-oauth
This library provides a simple API for querying OAuth endpoints.
npm install simply-oauth
All four request types (GET, POST, PUT, DELETE) follow the same invocation and response flow.
Invoke the desired request type viaoauth.[get|post|put|delete].
Each method returns aPromise. The promise resolves into an object with three potential keys:{ error, data, response }
error:undefinedorNumber- Undefined if no error, else holds the response status code (
404,500, etc.)
- Undefined if no error, else holds the response status code (
data:String- data returned from the response
response:IncomingMessage- object containing all the response headers/information.IncomingMessage Docs
ThePromise rejects if it encounters an operational or Node.js error during the request.3XX -5XX Response Codes are NOT thrown as errors from thePromise.
const{ OAuth}=require('simply-oauth');constoauth=newOAuth('http://requestUrl.com',// Request Token URL'http://accessUrl.com',// Access Token URL'consumerKey',// Application Consumer Key'consumerSecret',// Application Consumer Secret'1.0A',// OAuth Versionnull,// Authorize Callback'HMAC-SHA1'// Signature Method);
try{const{ error, data, response}=awaitoauth.get('http://url.com','oauth_token','oauth_secret');if(error){// Handle response error}constparsedData=JSON.parse(data);}catch(e){// Handle execution error}
constpostData={someKey:'someValue'};try{const{ error, data, response}=awaitoauth.post('http://url.com','oauth_token','oauth_secret',postData);if(error){// Handle response error}}catch(e){// Handle execution error}
constputData={someKey:'someValue'};try{const{ error, data, response}=awaitoauth.put('http://url.com','oauth_token','oauth_secret',putData);if(error){// Handle response error}}catch(e){// Handle execution error}
try{const{ error, data, response}=awaitoauth.delete('http://url.com','oauth_token','oauth_secret');if(error){// Handle response error}}catch(e){// Handle execution error}
This package supports sending the following types of data:
StringBufferObject
About
Updated version of node-oauth that uses async functions rather than callbacks.