API リファレンス

history の完全な仕様をここにまとめました。バインド、リッスン、プロジェクション、テーマ設定ができるすべてが一か所に集約されています。必要なものを接続し、好きなようにスタイリングしてください — standalone で signal フレンドリーです。

インプット

インプットはまだドキュメント化されていません。

アウトプット

アウトプットはまだドキュメント化されていません。

メソッド

history をコードから操作 — プログラム操作のための 16 個のメソッドを備えています。

名前	シグネチャ	戻り値	説明
`createHistoryStore`	`createHistoryStore<T, K>(config?: HistoryStoreConfig<T, K>): HistoryStore<T, K>`	`HistoryStore<T, K>`	id によって複数のオブジェクトを追跡する、シグナルベースの履歴ストアを作成するファクトリ。省略可能な保持上限（maxEntries はデフォルト 100、maxBytes はデフォルト 512000）、keySelector、およびカスタムの diff/patch 戦略を受け付けます。
`HistoryStore.states`	`states: Signal<Map<K, T>>`	`Signal<Map<K, T>>`	オブジェクト id をキーとした、現在のイミュータブルな状態スナップショットのマップを公開する computed シグナル。
`HistoryStore.registerObject`	`registerObject(id: K, initialState: T): void`	—	追跡対象オブジェクトを初期状態とともに登録し、その id 用に新しい空の履歴タイムラインを開始します。
`HistoryStore.registerFromObject`	`registerFromObject(initialState: T): K`	`K`	設定済みの keySelector から id を導出して追跡対象オブジェクトを登録し、その id を返します。keySelector が設定されていない場合は例外をスローします。
`HistoryStore.commit`	`commit(id: K, newState: T, options?: HistoryCommitOptions): boolean`	`boolean`	登録済みの id に対して新しい状態スナップショットをコミットし、前進／後退パッチを保存して、ポインターより先にある redo エントリを破棄します。新しい状態に変更がない場合は false を返します。トランザクションが開いている間は、エントリを作成せずに現在の状態のみを更新します。
`HistoryStore.commitFromObject`	`commitFromObject(newState: T, options?: HistoryCommitOptions): boolean`	`boolean`	設定済みの keySelector から id を導出して新しい状態をコミットします。keySelector が設定されていない場合は例外をスローします。
`HistoryStore.undo`	`undo(id: K): boolean`	`boolean`	エントリの後退パッチを適用して、履歴を 1 ステップ戻します。undo できるものがない場合は false を返します。
`HistoryStore.redo`	`redo(id: K): boolean`	`boolean`	エントリの前進パッチを適用して、履歴を 1 ステップ再適用します。redo できるものがない場合は false を返します。
`HistoryStore.canUndo`	`canUndo(id: K): boolean`	`boolean`	指定されたオブジェクト id に対して、現在 undo が可能かどうかを返します。
`HistoryStore.canRedo`	`canRedo(id: K): boolean`	`boolean`	指定されたオブジェクト id に対して、現在 redo が可能かどうかを返します。
`HistoryStore.getState`	`getState(id: K): T \| undefined`	`T \| undefined`	指定された id の現在の状態のディープクローンを返します。id が未登録の場合は undefined を返します。
`HistoryStore.history`	`history(id: K): HistoryMetadata`	`HistoryMetadata`	オブジェクトの履歴に関する読み取り専用メタデータを返します：ポインター、エントリ数、保持中のおおよそのバイト数、およびエントリごとのラベル・タイムスタンプ・バイト数。
`HistoryStore.beginTransaction`	`beginTransaction(id: K, label?: string): void`	—	トランザクションを開始し、以降のコミットが 1 つに統合された履歴エントリにまとめられるようにします。その id に対してトランザクションがすでに開いている場合は例外をスローします。
`HistoryStore.endTransaction`	`endTransaction(id: K): boolean`	`boolean`	開いているトランザクションを終了し、トランザクション開始時の状態から現在の状態までを 1 つに統合したエントリとしてコミットします。トランザクションが開いていなかった場合や変更がなかった場合は false を返します。
`HistoryStore.watchForm`	`watchForm(id: K, form: FormGroup, options?: WatchFormOptions): () => void`	`() => void`	FormGroup の valueChanges を購読して各発行を自動的にコミットします。最初の発行はオプションでスキップできます。購読解除用のコールバックを返します。
`HistoryStore.clearHistory`	`clearHistory(id: K): void`	—	指定された id のすべての履歴エントリをクリアし、現在の状態を新しいベーススナップショットとして保持して、開いているトランザクションを破棄します。

テンプレート

テンプレートはまだドキュメント化されていません。