egirlskey/packages/misskey-js/generator
tamaina 1d5a0d0777
chore: use @misskey-dev/eslint-plugin (#12860)
Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2023-12-31 15:26:57 +09:00
..
src
.eslintrc.cjs
.gitignore
package.json chore: use @misskey-dev/eslint-plugin (#12860) 2023-12-31 15:26:57 +09:00
README.md
tsconfig.json

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ファイルが生成されます。