Package Exports

readwise-reader-api
readwise-reader-api/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (readwise-reader-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

An unofficial JavaScript/TypeScript client for the Readwise Reader API

This client provides a convenient way to interact with the Readwise Reader API, suitable for both JavaScript and TypeScript applications.

Installation

npm install readwise-reader-api

Usage

Prerequisites

Obtain a Readwise API token here
Store in .env or in an environment variable.

export READWISE_TOKEN=<api_token>

JavaScript

const { getDocuments, getDocumentById, saveDocument } = require('readwise-reader-api');

// Fetch Documents
getDocuments('new', 'article', '2021-01-01T00:00:00Z')
  .then(documents => console.log(documents))
  .catch(error => console.error('Error:', error));

// Fetch a Specific Document by ID
getDocumentById('document_id')
  .then(document => console.log(document))
  .catch(error => console.error('Error:', error));

// Save a New Document
saveDocument('http://example.com')
  .then(([success, response]) => console.log(success, response))
  .catch(error => console.error('Error:', error));

TypeScript

import { getDocuments, getDocumentById, saveDocument } from 'readwise-reader-api';
import { Document, PostResponse } from 'readwise-reader-api/types';

// Fetch Documents
async function fetchDocuments(): Promise<void> {
    try {
        const documents: Document[] = await getDocuments('new', 'article', '2021-01-01T00:00:00Z');
        console.log(documents);
    } catch (error) {
        console.error('Error:', error);
    }
}

// Fetch a Specific Document by ID
async function fetchDocumentById(): Promise<void> {
    try {
        const document: Document | null = await getDocumentById('document_id');
        console.log(document);
    } catch (error) {
        console.error('Error:', error);
    }
}

// Save a New Document
async function saveNewDocument(): Promise<void> {
    try {
        const [success, response]: [boolean, PostResponse] = await saveDocument('http://example.com');
        console.log(success, response);
    } catch (error) {
        console.error('Error:', error);
    }
}

API Reference

getDocuments(location?: string, category?: string, updatedAfter?: string): Promise<Document[]>
getDocumentById(id: string): Promise<Document | null>
saveDocument(url: string): Promise<[boolean, PostResponse]>

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the ISC License.