Skip to content
Snippets Groups Projects
Commit 6c938905 authored by syuilo's avatar syuilo
Browse files

やった

parent 767df596
No related merge requests found
......@@ -5,7 +5,24 @@ coming soon
# Usage
## API request
todo
都度インスタンスやトークンを指定する場合
``` ts
import * as Misskey from 'misskey-js';
const meta = await Misskey.api.request('https://misskey.test', 'meta', { detail: true }, 'TOKEN');
```
最初にインスタンスやトークンを指定し、以後のリクエストでその情報を使いまわす場合
``` ts
import * as Misskey from 'misskey-js';
const cli = new Misskey.api.APIClient({
origin: 'https://misskey.test'
});
cli.i = { token: 'TOKEN' };
const meta = await cli.request('meta', { detail: true });
```
## Streaming
todo
......
/**
* Unit testing TypeScript types.
* with https://github.com/SamVerschueren/tsd
*/
import { expectType } from 'tsd';
import * as Misskey from '../src';
describe('API', () => {
test('returns node that has sprcified type', async () => {
const res = await Misskey.api.request('https://misskey.test', 'meta', { detail: true }, 'TOKEN');
expectType<Misskey.entities.InstanceMetadata>(res);
describe('request', () => {
test('success', async () => {
const res = await Misskey.api.request('https://misskey.test', 'meta', { detail: true }, 'TOKEN');
expectType<Misskey.entities.InstanceMetadata>(res);
});
});
describe('APIClient', () => {
test('success', async () => {
const cli = new Misskey.api.APIClient({
origin: 'https://misskey.test'
});
cli.i = { token: 'TOKEN' };
const res = await cli.request('meta', { detail: true });
expectType<Misskey.entities.InstanceMetadata>(res);
});
});
});
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment