ExternalOp

^{ref / conversations / ExternalOp}

Specifies an external operation and how to serialize and deserialize its return and error values.

^Source

Methods

task

task(ctx: OC): R | Promise<R>;

The external operation to perform.

Receives the current context object from the surrounding middleware. This gives the task access to sessions (if used) and other values that are not present inside the conversation.

^Source

beforeStore

beforeStore(value: R): I | Promise<I>;

Converts a value returned from the task to an object that can safely be passed to JSON.stringify.

^Source

afterLoad

afterLoad(value: I): R | Promise<R>;

Restores the original value from the intermediate representation that beforeStore generated.

^Source

beforeStoreError

beforeStoreError(value: unknown): unknown | Promise<unknown>;

Converts an error thrown by the task to an object that can safely be passed to JSON.stringify.

^Source

afterLoadError

afterLoadError(value: unknown): unknown | Promise<unknown>;

Restores the original error from the intermediate representation that beforeStoreError generated.

^Source