OpenSource/Sharkey
OpenSource/Sharkey
1
0
Fork 0
mirror of https://activitypub.software/TransFem-org/Sharkey.git synced 2024-12-16 22:39:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
syuilo 2021-07-13 22:08:55 +09:00 committed by GitHub
parent 42b611de9b
commit 170e84360c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -23,6 +23,17 @@ npm i misskey-js
``` ```
# Usage # Usage
インポートは以下のようにまとめて行えます。
``` ts
import * as Misskey from 'misskey-js';
```
便宜上、以後のコード例は上記のように`* as Misskey`としてインポートしている前提のものになります。
まとめてインポートを行うとTree-Shakingできなくなるので、適宜変更をおすすめします。
## Authenticate ## Authenticate
todo todo
@ -30,8 +41,6 @@ todo
APIを利用する際は、利用するサーバーの情報とアクセストークンを与えて`APIClient`クラスのインスタンスを初期化し、そのインスタンスの`request`メソッドを呼び出してリクエストを行います。 APIを利用する際は、利用するサーバーの情報とアクセストークンを与えて`APIClient`クラスのインスタンスを初期化し、そのインスタンスの`request`メソッドを呼び出してリクエストを行います。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const cli = new Misskey.api.APIClient({ const cli = new Misskey.api.APIClient({
origin: 'https://misskey.test', origin: 'https://misskey.test',
credential: 'TOKEN', credential: 'TOKEN',
@ -48,8 +57,6 @@ misskey.jsのストリーミングでは、二つのクラスが提供されま
ストリーミングを利用する際は、まず`Stream`クラスのインスタンスを初期化し、その後で`Stream`インスタンスのメソッドを利用して`Channel`クラスのインスタンスを取得する形になります。 ストリーミングを利用する際は、まず`Stream`クラスのインスタンスを初期化し、その後で`Stream`インスタンスのメソッドを利用して`Channel`クラスのインスタンスを取得する形になります。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' }); const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
const mainChannel = stream.useChannel('main'); const mainChannel = stream.useChannel('main');
mainChannel.on('notification', notification => { mainChannel.on('notification', notification => {
@ -93,8 +100,6 @@ mainChannel.dispose();
`Channel`クラスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。 `Channel`クラスはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' }); const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
const mainChannel = stream.useChannel('main'); const mainChannel = stream.useChannel('main');
mainChannel.on('notification', notification => { mainChannel.on('notification', notification => {
@ -106,8 +111,6 @@ mainChannel.on('notification', notification => {
`Channel`クラスの`send`メソッドを使用してメッセージをサーバーに送信することができます。 `Channel`クラスの`send`メソッドを使用してメッセージをサーバーに送信することができます。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' }); const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
const messagingChannel = stream.useChannel('messaging', { const messagingChannel = stream.useChannel('messaging', {
otherparty: 'xxxxxxxxxx', otherparty: 'xxxxxxxxxx',
@ -122,8 +125,6 @@ messagingChannel.send('read', {
`Stream`クラスの`_connected_`イベントが利用可能です。 `Stream`クラスの`_connected_`イベントが利用可能です。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' }); const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
stream.on('_connected_', () => { stream.on('_connected_', () => {
console.log('connected'); console.log('connected');
@ -134,8 +135,6 @@ stream.on('_connected_', () => {
`Stream`クラスの`_disconnected_`イベントが利用可能です。 `Stream`クラスの`_disconnected_`イベントが利用可能です。
``` ts ``` ts
import * as Misskey from 'misskey-js';
const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' }); const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
stream.on('_disconnected_', () => { stream.on('_disconnected_', () => {
console.log('disconnected'); console.log('disconnected');