NPM for Pocket

A promised based npm for the Pocket API

Install

First, install the pocket api with npm.

npm install pocket-api

How to use

Please review the Pocket API for expected inputs and outputs and authentication flow. Specifically Step 3, where you need to redirect the user to Pocket for authorization, which is not covered in this npm.

Version ^0.3.0 is a breaking change

let getPocket = require('pocket-api')

let consumer_key = 'your consumer_key';
let redirect_uri = 'your redirect_uri';  // eg. 'localhost:8000/redirect'

let pocket = new getPocket(consumer_key, redirect_uri);


//returns request_token
let response = await pocket.getRequestToken()

// Once you have you have received you request token, you have to send you user to the getPocket site
// It must also include a redirect URL, example:
// https://getpocket.com/auth/authorize?request_token=YOUR_REQUEST_TOKEN&redirect_uri=YOUR_REDIRECT_URI
// Please refer to the getPocket API site

// returns access token
let response = await pocket.getAccessToken()

//returns articles
let response = await pocket.getArticles(parameter_object)

//returns success
let response = await pocket.addArticles(add_object)

// modify a URL, returns success
let response = await pocket.modifyArticles(actions_array)

The below methods set the access token and request token respectively

//sets request_token
pocket.setRequestToken(request_token)

//sets access_token
pocket.setAccessToken(access_token)

Finally, the API does still support callbacks, it is depreciated and will be removed in a future release.

Example:

pocket.getRequestToken( function( data ) {
	console.log( data );
	//returns request_token
});