# lark-js-sdk

> Third-party JavaScript Lark (Feishu, 飞书) SDK written in TypeScript

Latest version **0.1.2** (published 2021-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install lark-js-sdk
pnpm add lark-js-sdk
yarn add lark-js-sdk
bun add lark-js-sdk
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2021-01-05 |
| First published | 2020-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 141.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Dizy |
| Maintainers | dizy |
| Keywords | feishu, lark, sdk, api, client |

## Links

- npm: https://www.npmjs.com/package/lark-js-sdk
- Repository: https://github.com/dizys/lark-js-sdk
- Homepage: https://github.com/dizys/lark-js-sdk#readme
- Issues: https://github.com/dizys/lark-js-sdk/issues
- npm.io page: https://npm.io/package/lark-js-sdk

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2021-01-05
- 0.1.1 — 2020-07-25
- 0.1.0 — 2020-07-25

## README

[![npm](https://img.shields.io/npm/v/lark-js-sdk?style=flat)](https://www.npmjs.com/package/lark-js-sdk)

# lark-js-sdk

Third-party JavaScript Lark (Feishu, 飞书) SDK written in TypeScript

## Installation

```bash
npm install --save lark-js-sdk
```

## Quick Start

Send message to groups that the bot is in:

```js
import {Lark} from 'lark-js-sdk';

async function sendMessage() {
  let lark = new Lark('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

  let {groups} = await lark.bot.group.getList();

  let chatIds = groups.map(group => group.chat_id);

  for (let chatId of chatIds) {
    let {message_id} = await lark.message.send({
      chat_id: chatId,
      msg_type: 'text',
      content: {text: 'Hello, Lark!'},
    });

    console.log(`Message (${message_id}) sent!`);
  }
}

sendMessage();
```

Add user

```js
import {Lark} from 'lark-js-sdk';

let lark = new Lark('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

lark.contact.user
  .add({
    name: 'Dizy',
    mobile: '18900000000',
    department_ids: ['od-234355343342acdbef33'],
    need_send_notification: true,
  })
  .then(data => {
    let {user_info} = data;

    console.log('User added:', user_info);
  });
```

Use Feishu API Endpoint instead:

```js
import {Feishu, Lark} from 'lark-js-sdk';

let feishu = new Feishu('<YOUR_APP_ID>', '<YOUR_APP_SECRET>');

// or

let feishu = new Lark(
  '<YOUR_APP_ID>',
  '<YOUR_APP_SECRET>',
  'https://open.feishu.cn/open-apis/',
);

// Feishu has the same apis as Lark...
```

## License

MIT, see the [LICENSE](/LICENSE) file for details.

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