45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
# misskey.js
|
|
|
|
## Install
|
|
coming soon
|
|
|
|
# Usage
|
|
## Authenticate
|
|
todo
|
|
|
|
## API request
|
|
都度インスタンスやトークンを指定する場合
|
|
``` ts
|
|
import * as Misskey from 'misskey-js';
|
|
|
|
const meta = await Misskey.api.request('https://misskey.test', 'meta', { detail: true }, 'TOKEN');
|
|
```
|
|
|
|
最初にインスタンスやトークンを指定し、以後のリクエストでその情報を使いまわす場合
|
|
``` ts
|
|
import * as Misskey from 'misskey-js';
|
|
|
|
const cli = new Misskey.api.APIClient({
|
|
origin: 'https://misskey.test'
|
|
});
|
|
cli.i = { token: 'TOKEN' };
|
|
|
|
const meta = await cli.request('meta', { detail: true });
|
|
```
|
|
|
|
## Streaming
|
|
``` ts
|
|
import * as Misskey from 'misskey-js';
|
|
|
|
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
|
|
const mainChannel = stream.useSharedConnection('main');
|
|
mainChannel.on('notification', notification => {
|
|
console.log('notification received', notification);
|
|
});
|
|
```
|
|
|
|
---
|
|
|
|
<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>
|