@masochistme/sdk

3.2.5 • Public • Published

Masochist.ME SDK

SDK abstracting communication with the Masochist.ME API.

Documentation

NPM package

GitHub repository

Usage

We recommend using the latest version of the SDK as it is still under rapid development:

yarn add @masochistme/sdk@latest

To be able to use the MasochistSDK in your application, you will need to pass a configuration file to the SDK instance with two parameters:

  • host - the basic path to the MasochistAPI (usually http://masochist.me:3002)
  • accessToken - your personal API token
import { SDK } from "@masochistme/sdk/dist/v1/sdk";

const config = {
  host:        "http://masochist.me:3002",
  accessToken: "your_super_secret_access_token",
};

const sdk = new SDK(config);

You can use the SDK without having the personal access token, but you will be limited to only use selected endpoints. To get one, contact Arcyvilk#6666.

Modules

MasochistSDK allows you to retrieve and manipulate data from the following categories:

Readme

Keywords

none

Package Sidebar

Install

npm i @masochistme/sdk

Weekly Downloads

0

Version

3.2.5

License

MIT

Unpacked Size

270 kB

Total Files

228

Last publish

Collaborators

  • arcyvilk