e2b38edb3a
* deps(misskey-js): Update openapi-typescript to v7 * update openapi-typescript to v7.7.3 * generate misskey-js types * bump openapi-typescript * enhance: 生成物からnever型を除去するように * regenerate api types * refactor: 処理共通化 --------- Co-authored-by: zyoshoka <107108195+zyoshoka@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| README.md | ||
| eslint.config.js | ||
| package.json | ||
| tsconfig.json | ||
README.md
misskey-js向け型生成モジュール
バックエンドが吐き出すOpenAPI準拠のapi.jsonからmisskey-jsで使用される型エイリアスを生成するためのモジュールです。 このモジュールはmisskey-jsそのものにバンドルされることは想定しておらず、生成物をmisskey-jsのsrc配下にコピーして使用することを想定しています。
使い方
まず、Misskeyのバックエンドからapi.jsonを取得する必要があります。任意のMisskeyインスタンスの/api-docからダウンロードしても良いですし、
backendモジュール配下でpnpm generate-api-jsonを実行しても良いでしょう。
api.jsonを入手したら、このファイルがあるディレクトリに置いてください。
その後、以下コマンドを実行します。
pnpm generate
上記を実行することで、./builtディレクトリ配下にtsファイルが生成されます。