@narkdown/client/README.md

Get unlimited response of Notion API

# @narkdown/client

> Get unlimited response of Notion API

[![codecov](https://codecov.io/gh/narkdown/client/branch/main/graph/badge.svg)](https://codecov.io/gh/narkdown/client)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
[![npm version](https://badge.fury.io/js/@narkdown%2Fclient.svg)](https://badge.fury.io/js/@narkdown%2Fclient)
[![license: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)

## Why?

This is an extension of the [`@notionhq/client`](https://github.com/makenotion/notion-sdk-js) to obtain total results for the [Paginated endpoints](https://developers.notion.com/reference/pagination#paginated-endpoints) of the Notion API.

The goal is to obtain a total results using the same interface as the Notion API.

## Install

```
$ npm install @narkdown/client
```

## Usage

```javascript
const {NarkdownClient} = require('@narkdown/client');

// Initializing a client
const narkdown = new NarkdownClient({
  auth: process.env.NOTION_TOKEN,
});
```

## API

> It extends [@notionhq/client](https://github.com/makenotion/notion-sdk-js)
>
> See the complete list of endpoints in the [Notion API reference](https://developers.notion.com/reference)

### `unlimited.blocks.children.list`

> Unlimited version of [Retrieve block children](https://developers.notion.com/reference/get-block-children)

```javascript
const {NarkdownClient} = require('@narkdown/client');

const narkdown = new NarkdownClient({auth: process.env.NOTION_API_KEY});

(async () => {
  const blockId = 'b55c9c91-384d-452b-81db-d1ef79372b75';
  const response = await narkdown.unlimited.blocks.children.list({
    block_id: blockId,
  });
  console.log(response);
})();
```

### `unlimited.databases.query`

> Unlimited version of [Query a database](https://developers.notion.com/reference/post-database-query)

```javascript
const {NarkdownClient} = require('@narkdown/client');

const narkdown = new NarkdownClient({auth: process.env.NOTION_API_KEY});

(async () => {
  const databaseId = '897e5a76-ae52-4b48-9fdf-e71f5945d1af';
  const response = await narkdown.unlimited.databases.query({
    database_id: databaseId,
    filter: {
      or: [
        {
          property: 'In stock',
          checkbox: {
            equals: true,
          },
        },
        {
          property: 'Cost of next trip',
          number: {
            greater_than_or_equal_to: 2,
          },
        },
      ],
    },
    sorts: [
      {
        property: 'Last ordered',
        direction: 'ascending',
      },
    ],
  });
  console.log(response);
})();
```

### `unlimited.databases.list`

> Unlimited version of [List databases (deprecated)](https://developers.notion.com/reference/get-databases)

```javascript
const {NarkdownClient} = require('@narkdown/client');

const narkdown = new NarkdownClient({auth: process.env.NOTION_API_KEY});

(async () => {
  const response = await narkdown.unlimited.databases.list();
  console.log(response);
})();
```

### `unlimited.users.list`

> Unlimited version of [List all users](https://developers.notion.com/reference/get-users)

```javascript
const {NarkdownClient} = require('@narkdown/client');

const narkdown = new NarkdownClient({auth: process.env.NOTION_API_KEY});

(async () => {
  const response = await narkdown.unlimited.users.list();
  console.log(response);
})();
```

### `unlimited.search`

> Unlimited version of [Search](https://developers.notion.com/reference/post-search)

```javascript
const {NarkdownClient} = require('@narkdown/client');

const narkdown = new NarkdownClient({auth: process.env.NOTION_API_KEY});

(async () => {
  const response = await narkdown.unlimited.search({
    query: 'External tasks',
    sort: {
      direction: 'ascending',
      timestamp: 'last_edited_time',
    },
  });
  console.log(response);
})();
```

## Related

- [makenotion/notion-sdk-js](https://github.com/makenotion/notion-sdk-js)

## License

[MIT](LICENSE)