Skip to documentation
Docs navigation
Docs/forget()
MemoGrafter

forget()

Use forget with an application-managed session scope.

What it does

Use forget with an application-managed session scope.

Forgetting is a soft lifecycle change. The record remains available for history and auditing but is excluded from active recall.

Signature

TypeScript
forget(memoryId: string): Promise<boolean>

Parameters

memoryId (string) — The memory record to inspect or change.

Result

true when the requested state changed; false when the target was already in that state or was not found.

Example

example.ts
const result = await memo.forget(/* identifiers and options */);