cross-reference state and getPersistedState

statelyai · Oct 31, 2023 · 010d442 · 010d442
1 parent ded2b28
commit 010d442
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/core/src/interpreter.ts b/packages/core/src/interpreter.ts
@@ -551,6 +551,8 @@ export class Actor<TLogic extends AnyActorLogic>
    *
    * Note that the persisted state is not the same as the snapshot from `actor.getSnapshot()`. Persisted state represents the internal state of the actor, while snapshots represent the actor's last emitted value.
    *
+   * Can be restored with {@link ActorOptions.state}
+   *
    * @see https://stately.ai/docs/persistence
    */
   public getPersistedState(): Snapshot<unknown> {

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1726,6 +1726,8 @@ export interface ActorOptions<TLogic extends AnyActorLogic> {
    * Actions from machine actors will not be re-executed, because they are assumed to have been already executed.
    * However, invocations will be restarted, and spawned actors will be restored recursively.
    *
+   * Can be generated with {@link Actor.getPersistedState}.
+   *
    * @see https://stately.ai/docs/persistence
    */
   // state?: