# rtm-typescript

> Strongly typed SDK client for the Remember the Milk API

Latest version **1.3.3** (published 2023-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install rtm-typescript
pnpm add rtm-typescript
yarn add rtm-typescript
bun add rtm-typescript
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2023-11-09 |
| First published | 2023-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 103.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Wainwright |
| Maintainers | ben.wainwright |

## Links

- npm: https://www.npmjs.com/package/rtm-typescript
- Repository: https://github.com/benwainwright/rtm-typescript
- Homepage: https://github.com/benwainwright/rtm-typescript#readme
- Issues: https://github.com/benwainwright/rtm-typescript/issues
- npm.io page: https://npm.io/package/rtm-typescript

## Dependencies (2)

- [@commitlint/cli](https://npm.io/package/@commitlint/cli.md) ^18.2.0
- [file-tree-walker-ts](https://npm.io/package/file-tree-walker-ts.md) ^2.0.2

## Recent versions

- 1.3.3 (latest) — 2023-11-09
- 1.3.2 — 2023-11-09
- 1.3.1 — 2023-11-09
- 1.3.0 — 2023-11-09
- 1.2.17 — 2023-11-04
- 1.2.16 — 2023-11-04
- 1.2.15 — 2023-11-04
- 1.2.14 — 2023-11-03
- 1.2.13 — 2023-11-03
- 1.2.12 — 2023-11-03
- 1.2.11 — 2023-11-03
- 1.2.10 — 2023-11-03
- 1.2.9 — 2023-11-03
- 1.2.8 — 2023-11-03
- 1.2.7 — 2023-11-03
- … 9 more at https://npm.io/package/rtm-typescript/versions

## README

# rtm-typescript

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/benwainwright/rtm-typescript/main.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=benwainwright_rtm-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=benwainwright_rtm-typescript)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=benwainwright_rtm-typescript&metric=coverage)](https://sonarcloud.io/summary/new_code?id=benwainwright_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](https://www.rememberthemilk.com/services/api/ratelimit.rtm), 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

```TypeScript
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](./docs/README.md)

---
_Source: https://npm.io/package/rtm-typescript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._