Class TurnStateEntry

Represents an entry in the turn state that can be tracked for changes and stored.

Index

Constructors

Accessors

hasChanged isDeleted storageKey value

Methods

Constructors

constructor

new TurnStateEntry(
value?: Record<string, unknown>,
storageKey?: string,
): TurnStateEntry
Creates a new instance of TurnStateEntry.
Parameters
- Optionalvalue: Record<string, unknown>
  The initial value for the entry.
- OptionalstorageKey: string
  Optional storage key used to persist the entry.
Returns TurnStateEntry
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:20

Accessors

hasChanged

get hasChanged(): boolean
Gets whether the entry value has changed since its creation or last update.

Returns boolean
True if the value has changed, otherwise false.
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:30

isDeleted

get isDeleted(): boolean
Gets whether the entry has been marked for deletion.

Returns boolean
True if the entry is marked for deletion, otherwise false.
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:38

storageKey

get storageKey(): string | undefined
Gets the storage key associated with this entry.

Returns string | undefined
The storage key, or undefined if no storage key was specified.
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:60

value

get value(): Record<string, unknown>
Gets the current value of the entry. If the entry was marked for deletion, it will be reset to an empty object and marked as not deleted.

Returns Record<string, unknown>
The current value of the entry.
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:47

Methods

delete

delete(): void
Marks the entry for deletion.

Returns void
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:67

replace

replace(value?: Record<string, unknown>): void
Replaces the current value with a new value.
Parameters
- Optionalvalue: Record<string, unknown>
  The new value to set. If undefined, an empty object will be used.
Returns void
- Defined in packages/agents-hosting/src/app/turnStateEntry.ts:75