From 015d169423d42e1ee0b72d8fd77dc423dbe701a9 Mon Sep 17 00:00:00 2001 From: syuilo Date: Sun, 11 Jul 2021 19:33:21 +0900 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 965bee7c28..259c05c08e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ npm i misskey-js todo ## API request +APIを利用する際は、利用するサーバーの情報とアクセストークンを与えて`APIClient`クラスのインスタンスを初期化し、そのインスタンスの`request`メソッドを呼び出してリクエストを行います。 + ``` ts import * as Misskey from 'misskey-js'; @@ -36,9 +38,11 @@ const cli = new Misskey.api.APIClient({ const meta = await cli.request('meta', { detail: true }); ``` +`request`の第一引数には呼び出すエンドポイント名、第二引数にはパラメータオブジェクトを渡します。レスポンスはPromiseとして返ります。 + ## Streaming misskey.jsのストリーミングでは、二つのクラスが提供されます。 -ひとつは、ストリーミングのコネクション自体を司る`Stream`クラスと、もうひとつはストリーミングのチャンネルの概念を表す`Channel`クラスです。 +ひとつは、ストリーミングのコネクション自体を司る`Stream`クラスと、もうひとつはストリーミング上のチャンネルの概念を表す`Channel`クラスです。 ストリーミングを利用する際は、まず`Stream`クラスのインスタンスを初期化し、その後で`Stream`インスタンスのメソッドを利用して`Channel`クラスのインスタンスを取得する形になります。 ``` ts