UserManual Node.js

Node.js wrapper for the UserManual API

Installation

Install the package with:

npm install --save usermanual-api

or

yarn add usermanual-api

Usage

Table of Contents

• Import
• Authentication
• Documents

Import

In JavaScript

const { UserManual } = require('usermanual-api')

In TypeScript

import { UserManual } from 'usermanual-api';

Authentication

Get the API key for your project from your UserManual Dashboard → Settings → API Keys.

const usermanual = new UserManual({
  apiKey: 'YOUR API KEY',
});

Usages with TypeScript

import { UserManual } from 'usermanual-api';
const usermanual = new UserManual({
  apiKey: 'YOUR API KEY'
});

const getDocument = async () => {
  const document = await usermanual.getPDFDocument('55d18942-75c9-4ac6-b9eb-055b107ffa36');
};
getDocument();

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/usermanual-com/usermanual-node.

License

The repository is available as open source under the terms of the MIT License.