本文へ移動

継承された Cordis API

フレームワークの ctx メンバーとイベントは、すべてのプラグインが Harness 層を超えて利用できます。これらは固定されたベンダーソース(ベンダリングポリシー)であり、Harness のページがリポジトリ固有の用語に集中できるよう簡潔にまとめています。詳細な Context、Fiber、Registry、Service API は context.mdfiber.mdレジストリ.mdservice.md に生成され、イベントディスパッチメソッドは events.md に生成されます。

このファイルはソース(scripts/gen-cordis-catalog.ts)から生成され、pnpm run verify-cordis-catalogdoc-sync の一部)によって最新であることが検証されます。手動で編集しないでください。シグネチャブロックでは ts cordis-catalog フェンスを使用し、各イベントまたはサービスメソッドの直前に元のソース JSDoc を含めます。doc-typecheck はこれらの単体の宣言フラグメントをスキップします。シグネチャ内の型名は、それらを説明するページにリンクします。

継承された ctx メンバー(cordis コア + loader/hmr/timer)

  • ctx.on / ctx.once — イベントリスナーを登録します(破棄可能)。(vendor/cordis/src/events.ts:34)
  • ctx.emit / ctx.parallel / ctx.serial / ctx.bail / ctx.waterfall — イベントをディスパッチします(同期 / await / 最初の bail / 短絡チェーン)。(vendor/cordis/src/events.ts:34)
  • ctx.plugin / ctx.inject — プラグインを読み込むか、必要なサービスを宣言します。(vendor/cordis/src/registry.ts:164)
  • ctx.effect — Fiber に関連付けられた破棄可能な副作用を登録します。(vendor/cordis/src/fiber.ts:9)
  • ctx.get / ctx.set / ctx.provide / ctx.accessor / ctx.mixin — 低レベルのサービスストアへのアクセスとバインディングを行います。(vendor/cordis/src/reflect.ts:7)
  • ctx.extend / ctx.isolate / ctx.intercept — 子コンテキストを派生させます(スコープ付きサービス / 分離 / インターセプト)。(vendor/cordis/src/context.ts:42)
  • ctx.root / ctx.scope / ctx.fiber / ctx.registry / ctx.reflect / ctx.events / ctx.logger — 実行中のコンテキストグラフへのアンビエントハンドルです。(vendor/cordis/src/context.ts:16)
  • ctx.timer (+ interval / timeout / throttle / debounce) — 破棄可能なタイマーヘルパーです。timer キーは実行時に提供されます。サポートされる 4 つのヘルパーは ctx に直接ミックスインされます(Pick を介して宣言されます)。(vendor/timer/src/index.ts:4)
  • ctx.loader — アプリを起動した設定 Loader です(loader 配下に存在します)。(vendor/loader/src/index.ts:30)
  • ctx.hmr — ホットモジュールリロードのウォッチャーです(hmr プラグイン配下に存在します)。(vendor/hmr/src/index.ts:15)

継承されたイベント(cordis コア + loader/hmr/timer)