graphite/Sharkey
1
0
Fork 0
mirror of https://git.joinsharkey.org/Sharkey/Sharkey.git synced 2024-11-24 21:33:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
syuilo 2021-10-16 23:57:02 +09:00 committed by GitHub
parent 227e603194
commit 8ba56df54e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -23,7 +23,7 @@ npm i misskey-js
``` ```
# Usage # Usage
インポートは以下のようにまとめて行えます。 インポートは以下のようにまとめて行うと便利です。
``` ts ``` ts
import * as Misskey from 'misskey-js'; import * as Misskey from 'misskey-js';
@ -31,8 +31,11 @@ import * as Misskey from 'misskey-js';
便宜上、以後のコード例は上記のように`* as Misskey`としてインポートしている前提のものになります。 便宜上、以後のコード例は上記のように`* as Misskey`としてインポートしている前提のものになります。
まとめてインポートを行うとTree-Shakingできなくなるので、適宜変更をおすすめします。 ただし、このインポート方法だとTree-Shakingできなくなるので、コードサイズが重要なユースケースでは以下のような個別インポートをお勧めします。
``` ts
import { api as misskeyApi } from 'misskey-js';
```
## Authenticate ## Authenticate
todo todo