rtm-typescript v1.3.3

rtm-typescript

WARNING: THIS PACKAGE IS NOT READY FOR CONSUMPTION YET. USE AT YOUR OWN RISK

Install

npm install rtm-typescript

Features

This package currently only supports a few of the RTM API methods. Please come back later...

API Request Throttling

To avoid hitting the RTM Api rate limit, this client will throttle requests to once per second. If you wish to disable this behaviour, set throttle to false in the configuration object.

Usage

import { initialiseApi, ClientPermissions } from "rtm-typescript";

const runMyCode = async () => {
  const key = "my-api-key";
  const secret = "my-shared-secret";

  const client = initialiseApi({
    key,
    secret,
    permissions: ClientPermissions.Read,
  });

  const result = await client.tasks.getList({ list_id: "2" });

  console.log(result);
};

For more information, check out the API Documentation