FoundKey/README.md
2021-05-16 22:23:23 +09:00

2 KiB

misskey.js

Install

coming soon

Usage

Authenticate

todo

API request

都度インスタンスやトークンを指定する場合

import * as Misskey from 'misskey-js';

const meta = await Misskey.api.request('https://misskey.test', 'meta', { detail: true }, 'TOKEN');

最初にインスタンスやトークンを指定し、以後のリクエストでその情報を使いまわす場合

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

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);
});

useSharedConnection(channel: string): SharedConnection

使いまわし可能なチャンネル(=パラメータを持たないチャンネル)に接続します。 このメソッドを用いて接続したチャンネル接続は内部的に使いまわされるため、プログラム上の複数の場所から呼び出してもコネクションを無駄に増やさずに済みます。

connectToChannel(channel: string, params?: any): NonSharedConnection

チャンネルに接続します。返り値はそのチャンネルへのコネクションインスタンスです。

メッセージの受信

チャンネル接続インスタンスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。

メッセージの送信

チャンネル接続インスタンスのsendメソッドを使用してメッセージをサーバーに送信することができます。