From 49a655f78e17f75e98f4e053723f2150a294ae8d Mon Sep 17 00:00:00 2001 From: syuilo Date: Sun, 16 May 2021 22:23:23 +0900 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4dc761c7c9..6b74895989 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,19 @@ mainChannel.on('notification', notification => { }); ``` +### `useSharedConnection(channel: string): SharedConnection` +使いまわし可能なチャンネル(=パラメータを持たないチャンネル)に接続します。 +このメソッドを用いて接続したチャンネル接続は内部的に使いまわされるため、プログラム上の複数の場所から呼び出してもコネクションを無駄に増やさずに済みます。 + +### `connectToChannel(channel: string, params?: any): NonSharedConnection` +チャンネルに接続します。返り値はそのチャンネルへのコネクションインスタンスです。 + +### メッセージの受信 +チャンネル接続インスタンスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。 + +### メッセージの送信 +チャンネル接続インスタンスの`send`メソッドを使用してメッセージをサーバーに送信することができます。 + ---