Class TurnStartHook

A conversation's turn, before it is recorded: its inputs (as given), its conversation's id, the turn it continues.

Hierarchy

HookEvent
- TurnStartHook

Index

Constructors

Properties

conversation inputs parent program

Methods

entries remember

Constructors

constructor

new TurnStartHook(
    inputs: Rec,
    conversation: string,
    parent: string | null,
    program: unknown,
): TurnStartHook
Parameters
- inputs: Rec
- conversation: string
- parent: string | null
- program: unknown
Returns TurnStartHook
Overrides HookEvent.constructor
- Defined in src/plugins.ts:323

Properties

`Readonly`conversation

conversation: string

inputs

inputs: Rec

`Readonly`parent

parent: string | null

`Readonly`program

program: unknown

Methods

entries

entries(kind: string): Rec[]
This plugin's entries of a kind on the branch of the turn the call runs in ([] outside a conversation).
Parameters
- kind: string
Returns Rec[]
Inherited from HookEvent.entries
- Defined in src/plugins.ts:243

remember

remember(kind: string, data: unknown): Promise<void>
Keep an entry of this plugin at the turn the call runs in (outside a conversation, a TypeError).
Parameters
- kind: string
- data: unknown
Returns Promise<void>
Inherited from HookEvent.remember
- Defined in src/plugins.ts:249