# remarkable-node

> Unofficial reMarkable api wrapper for node.js based on [these unofficial docs](https://github.com/splitbrain/ReMarkableAPI/wiki).

Latest version **0.0.2** (published 2019-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install remarkable-node
pnpm add remarkable-node
yarn add remarkable-node
bun add remarkable-node
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-12-29 |
| First published | 2019-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | kevlened |
| Maintainers | kevlened |

## Links

- npm: https://www.npmjs.com/package/remarkable-node
- Repository: git@github.com:kevlened/remarkable-node
- npm.io page: https://npm.io/package/remarkable-node

## Dependencies (4)

- [got](https://npm.io/package/got.md) ^10.2.0
- [uuid](https://npm.io/package/uuid.md) ^3.3.3
- [getmac](https://npm.io/package/getmac.md) ^5.0.0
- [hex-lite](https://npm.io/package/hex-lite.md) ^1.5.0

## Recent versions

- 0.0.2 (latest) — 2019-12-29

## README

# remarkable-node
Unofficial reMarkable api wrapper for node.js based on [these unofficial docs](https://github.com/splitbrain/ReMarkableAPI/wiki).

## Install
`yarn add remarkable-node`

## Usage

```js
import { Remarkable, ItemTypes } from 'remarkable-node';
// const { Remarkable, ItemTypes } = require('remarkable-node');

(async () => {
    const client = new Remarkable();

    // create a code at https://my.remarkable.com/connect/desktop
    const token = await client.register({code: 'created code'});

    // (optional) skip registration in the future with `new Remarkable({token})`
    console.log(token);

    // List items
    const items = await client.listItems();

    // property list: https://github.com/splitbrain/ReMarkableAPI/wiki/Storage
    for (const item of items) {
        if (item.Type === ItemTypes.CollectionType) {
            // Do something with the collection
        } else if (item.Type === ItemTypes.DocumentType) {
            // Do something with the document
        }
    }

    // Get an item
    const item = await client.getItem({id: 'some uuid'});

    // Delete an item
    await client.deleteItem({id: 'some uuid'});
})();
```

### 

## License
MIT

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