node-pocket-api v0.2.8

node-pocket-api

node lib for Pocket API

Install

install the pocket api with npm/yarn.

npm install node-pocket-api

yarn add node-pocket-api

How to use

Refer to Pocket API for request and response

Refer to Authentication for requestToken and accessToken

// js
const { Pocket } = require('node-pocket-api');

// ts
import { Pocket } from 'node-pocket-api';

const consumerKey = '<your consumer_key>';
const redirectUri = '<your redirect_uri>';  // eg. 'localhost:3000/redirect'
const config = {
    consumerKey: consumerKey,
    redirectUri: redirectUri,
};
const pocket = new Pocket(config);

requestToken

// requestToken
const data = {
    consumer_key: consumerKey,
    redirect_uri: redirectUri,
};
const requestToken = await pocket.getRequestToken(data);

getAuthorizeUrl

// getAuthorizeUrl
const authorizeUrl = await pocket.getAuthorizeUrl();

accessToken

// accessToken
const data = {
    consumer_key: consumerKey,
    code: requestToken,
};
const accessToken = await pocket.getAccessToken(data);

addItems

// addItems
const data = {
    consumer_key: consumerKey,
    access_token: accessToken,
    url: `http://pocket.co/${faker.lorem.word()}`,
    title: faker.name.title(),
    time: dayjs().unix(),
};

const response = await pocket.addItems(data);

modifyItems

// modifyItems
const data = {
    consumer_key: process.env.POCKET_CONSUMER_KEY
        ? process.env.POCKET_CONSUMER_KEY
        : "",
    access_token: pocket.accessToken,
    actions: [
        {
            action: "archive",
            item_id: "229279689",
            time: dayjs().unix(),
        },
    ],
};
const response = await pocket.modifyItems(data);

retrieveItems

// retrieveItems
const data = {
    consumer_key: process.env.POCKET_CONSUMER_KEY
        ? process.env.POCKET_CONSUMER_KEY
        : "",
    access_token: pocket.accessToken,
};

const response = await pocket.retrieveItems(data);

you can also get requestToken and accessToken like this:

// requestToken without data
const requestToken = await pocket.getRequestToken();

// accessToken without data
const accessToken = await pocket.getAccessToken();

other set value function like this:

pocket.setConsumerKey(consumerKey);

pocket.setRedirectUri(redirectUri);

pocket.setRequestToken(requestToken);

pocket.setAccessToken(accessToken);

Requirement

• install yarn
• install node (v14+)

Testing and run

// run test case
$ yarn run test

// publish to npm
$ yarn publish