198ca3ba2c
# Conflicts: # packages/backend/src/core/CoreModule.ts # packages/backend/src/core/GlobalEventService.ts # packages/backend/src/core/SearchService.ts # packages/backend/src/models/_.ts # packages/backend/src/postgres.ts # packages/backend/src/server/api/endpoints/antennas/notes.ts # packages/backend/src/server/api/endpoints/channels/timeline.ts # packages/backend/src/server/api/endpoints/clips/notes.ts # packages/backend/src/server/api/endpoints/notes/children.ts # packages/backend/src/server/api/endpoints/notes/local-timeline.ts # packages/backend/src/server/api/endpoints/notes/mentions.ts # packages/backend/src/server/api/endpoints/notes/renotes.ts # packages/backend/src/server/api/endpoints/notes/replies.ts # packages/backend/src/server/api/endpoints/notes/search-by-tag.ts # packages/backend/src/server/api/endpoints/roles/notes.ts # packages/backend/src/server/api/endpoints/users/notes.ts # packages/frontend/src/utility/autogen/settings-search-index.ts # pnpm-lock.yaml |
||
|---|---|---|
| .. | ||
| 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ファイルが生成されます。