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

1// js
2const { Pocket } = require('node-pocket-api');
3
4// ts
5import { Pocket } from 'node-pocket-api';
6
7const consumerKey = '<your consumer_key>';
8const redirectUri = '<your redirect_uri>';  // eg. 'localhost:3000/redirect'
9const config = {
10    consumerKey: consumerKey,
11    redirectUri: redirectUri,
12};
13const pocket = new Pocket(config);

requestToken

1// requestToken
2const data = {
3    consumer_key: consumerKey,
4    redirect_uri: redirectUri,
5};
6const requestToken = await pocket.getRequestToken(data);

getAuthorizeUrl

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

accessToken

1// accessToken
2const data = {
3    consumer_key: consumerKey,
4    code: requestToken,
5};
6const accessToken = await pocket.getAccessToken(data);

addItems

1// addItems
2const data = {
3    consumer_key: consumerKey,
4    access_token: accessToken,
5    url: `http://pocket.co/${faker.lorem.word()}`,
6    title: faker.name.title(),
7    time: dayjs().unix(),
8};
9
10const response = await pocket.addItems(data);

modifyItems

1// modifyItems
2const data = {
3    consumer_key: process.env.POCKET_CONSUMER_KEY
4        ? process.env.POCKET_CONSUMER_KEY
5        : "",
6    access_token: pocket.accessToken,
7    actions: [
8        {
9            action: "archive",
10            item_id: "229279689",
11            time: dayjs().unix(),
12        },
13    ],
14};
15const response = await pocket.modifyItems(data);

retrieveItems

1// retrieveItems
2const data = {
3    consumer_key: process.env.POCKET_CONSUMER_KEY
4        ? process.env.POCKET_CONSUMER_KEY
5        : "",
6    access_token: pocket.accessToken,
7};
8
9const response = await pocket.retrieveItems(data);

you can also get requestToken and accessToken like this:

1// requestToken without data
2const requestToken = await pocket.getRequestToken();
3
4// accessToken without data
5const accessToken = await pocket.getAccessToken();

other set value function like this:

1pocket.setConsumerKey(consumerKey);
2
3pocket.setRedirectUri(redirectUri);
4
5pocket.setRequestToken(requestToken);
6
7pocket.setAccessToken(accessToken);

Requirement

• install yarn
• install node (v14+)

Testing and run

1// run test case
2$ yarn run test
3
4// publish to npm
5$ yarn publish