misskey/README.md

113 lines
3.0 KiB
Markdown
Raw Normal View History

2021-05-14 02:54:41 +00:00
# misskey.js
2021-05-16 15:07:01 +00:00
**Strongly-typed official Misskey SDK for browsers/Node.js.**
2021-06-12 13:50:45 +00:00
[![Test](https://github.com/misskey-dev/misskey.js/actions/workflows/test.yml/badge.svg)](https://github.com/misskey-dev/misskey.js/actions/workflows/test.yml)
2021-05-23 08:17:14 +00:00
[![NPM](https://nodei.co/npm/misskey-js.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/misskey-js)
2021-05-16 15:07:01 +00:00
JavaScript(TypeScript)用の公式MisskeySDKです。ブラウザ/Node.js上で動作します。
以下が提供されています:
- ユーザー認証
- APIリクエスト
- ストリーミング
- ユーティリティ関数
- Misskeyの各種モデル(ノート、ユーザー等)の型定義
2021-05-14 02:54:41 +00:00
2021-05-14 03:00:58 +00:00
## Install
2021-05-23 08:16:14 +00:00
```
npm i misskey-js
```
2021-05-14 03:00:58 +00:00
2021-05-14 02:54:41 +00:00
# Usage
2021-05-16 09:30:42 +00:00
## Authenticate
todo
2021-05-14 02:54:41 +00:00
## API request
2021-05-16 09:27:21 +00:00
``` ts
import * as Misskey from 'misskey-js';
const cli = new Misskey.api.APIClient({
2021-05-23 03:15:28 +00:00
origin: 'https://misskey.test',
credential: 'TOKEN',
2021-05-16 09:27:21 +00:00
});
const meta = await cli.request('meta', { detail: true });
```
2021-05-14 02:54:41 +00:00
## Streaming
2021-05-16 09:33:08 +00:00
``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const mainChannel = stream.useChannel('main');
2021-05-16 09:33:08 +00:00
mainChannel.on('notification', notification => {
console.log('notification received', notification);
});
```
2021-05-14 03:00:10 +00:00
2021-05-23 04:34:36 +00:00
### チャンネルへの接続
チャンネルへの接続は`useChannel`メソッドを使用します。
2021-05-16 13:23:23 +00:00
2021-05-23 04:34:36 +00:00
パラメータなし
2021-05-17 15:07:17 +00:00
``` ts
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const mainChannel = stream.useChannel('main');
2021-05-17 15:07:17 +00:00
```
2021-05-23 04:34:36 +00:00
パラメータあり
2021-05-17 15:07:17 +00:00
``` ts
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const messagingChannel = stream.useChannel('messaging', {
2021-05-17 15:07:17 +00:00
otherparty: 'xxxxxxxxxx',
});
```
### チャンネルから切断
`dispose`メソッドを呼び出します。
``` ts
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const mainChannel = stream.useChannel('main');
2021-05-17 15:07:17 +00:00
mainChannel.dispose();
```
2021-05-16 13:23:23 +00:00
### メッセージの受信
チャンネル接続インスタンスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。
2021-05-17 15:07:17 +00:00
``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const mainChannel = stream.useChannel('main');
2021-05-17 15:07:17 +00:00
mainChannel.on('notification', notification => {
console.log('notification received', notification);
});
```
2021-05-16 13:23:23 +00:00
### メッセージの送信
チャンネル接続インスタンスの`send`メソッドを使用してメッセージをサーバーに送信することができます。
2021-05-17 15:07:17 +00:00
``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
2021-05-23 04:34:36 +00:00
const messagingChannel = stream.useChannel('messaging', {
2021-05-17 15:07:17 +00:00
otherparty: 'xxxxxxxxxx',
});
messagingChannel.send('read', {
id: 'xxxxxxxxxx'
});
```
2021-05-14 03:00:58 +00:00
---
2021-05-14 03:00:10 +00:00
<div align="center">
<a href="https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md"><img src="./i-want-you.png" width="300"></a>
</div>