Compare commits
6 Commits
47ead2151c
..
1.0.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 004bfde9af | |||
| 895b693f81 | |||
| 336db2a5ca | |||
| f57ca58935 | |||
| f2c2007e07 | |||
| 714a3b852c |
@@ -1,48 +1,62 @@
|
||||
# Better uwuzu SDK
|
||||
[uwuzu.js](https://github.com/PutonFPS/uwuzu.js)みたいなやつです。uwuzuのAPIがいじれます。
|
||||
|
||||
# 使い方
|
||||
## インストール
|
||||
初期リリース出たら書きます
|
||||
|
||||
## 初期化
|
||||
```ts
|
||||
import uwuzu from "better-uwuzu-sdk";
|
||||
import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
|
||||
|
||||
const client = new uwuzu<ApiMap>({
|
||||
origin: "https://uwuzu.net",
|
||||
});
|
||||
|
||||
try {
|
||||
client.token = "APITOKEN";
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
}
|
||||
```
|
||||
型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。
|
||||
|
||||
## APIリクエスト
|
||||
```ts
|
||||
import uwuzu from "better-uwuzu-sdk";
|
||||
import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
|
||||
|
||||
const client = new uwuzu<ApiMap>({
|
||||
origin: "https://uwuzu.net",
|
||||
});
|
||||
|
||||
try {
|
||||
client.token = "APITOKEN";
|
||||
|
||||
const me = await client.request("me/");
|
||||
|
||||
if (me.error_code) {
|
||||
throw new Error(me.error_code);
|
||||
}
|
||||
|
||||
console.log(`あなたは${me.username}です。`);
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
}
|
||||
```
|
||||
# Better uwuzu SDK
|
||||
[uwuzu.js](https://github.com/PutonFPS/uwuzu.js)みたいなやつです。uwuzuのAPIがいじれます。
|
||||
|
||||
# 使い方
|
||||
## インストール
|
||||
```bash
|
||||
# npm
|
||||
npm install git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.1
|
||||
|
||||
# yarn
|
||||
yarn add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.1
|
||||
|
||||
# pnpm
|
||||
pnpm add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.1
|
||||
```
|
||||
> **NOTE**
|
||||
> このSDKはnpmリポジトリがありません。Gitリポジトリを使用しています。
|
||||
|
||||
> **WARNING**
|
||||
> `#main`でのインストールもできますが破壊的変更の際に面倒だと思います。サポートしません。
|
||||
|
||||
## 初期化
|
||||
```ts
|
||||
import uwuzu from "better-uwuzu-sdk";
|
||||
import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
|
||||
|
||||
const client = new uwuzu<ApiMap>({
|
||||
origin: "https://uwuzu.net",
|
||||
});
|
||||
|
||||
try {
|
||||
client.token = "APITOKEN";
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
}
|
||||
```
|
||||
型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。
|
||||
|
||||
## APIリクエスト
|
||||
```ts
|
||||
import uwuzu from "better-uwuzu-sdk";
|
||||
import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
|
||||
|
||||
const client = new uwuzu<ApiMap>({
|
||||
origin: "https://uwuzu.net",
|
||||
});
|
||||
|
||||
try {
|
||||
client.token = "APITOKEN";
|
||||
|
||||
const me = await client.request("me/");
|
||||
|
||||
if (me.error_code) {
|
||||
throw new Error(me.error_code);
|
||||
}
|
||||
|
||||
console.log(`あなたは${me.username}です。`);
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
}
|
||||
```
|
||||
普通のSDKです。`uwuzu().request()`の第一引数はエンドポイント、第二引数はbodyです。bodyにトークンは自動入力されるので上記の例のように省略できます。
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "better-uwuzu-sdk",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.1",
|
||||
"description": "A better uwuzu SDK.",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/types/index.d.ts",
|
||||
|
||||
Reference in New Issue
Block a user