mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-24 23:43:10 +02:00
Update README.md
This commit is contained in:
parent
c27340eddc
commit
49a655f78e
1 changed files with 13 additions and 0 deletions
13
README.md
13
README.md
|
@ -38,6 +38,19 @@ mainChannel.on('notification', notification => {
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `useSharedConnection(channel: string): SharedConnection`
|
||||||
|
使いまわし可能なチャンネル(=パラメータを持たないチャンネル)に接続します。
|
||||||
|
このメソッドを用いて接続したチャンネル接続は内部的に使いまわされるため、プログラム上の複数の場所から呼び出してもコネクションを無駄に増やさずに済みます。
|
||||||
|
|
||||||
|
### `connectToChannel(channel: string, params?: any): NonSharedConnection`
|
||||||
|
チャンネルに接続します。返り値はそのチャンネルへのコネクションインスタンスです。
|
||||||
|
|
||||||
|
### メッセージの受信
|
||||||
|
チャンネル接続インスタンスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。
|
||||||
|
|
||||||
|
### メッセージの送信
|
||||||
|
チャンネル接続インスタンスの`send`メソッドを使用してメッセージをサーバーに送信することができます。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
Loading…
Reference in a new issue