Interface ExecHookOptions

Extended hook options that include signal configuration

interface ExecHookOptions {
    args: any[];
    config?: WorkflowConfig;
    entity?: string;
    namespace?: string;
    search?: WorkflowSearchOptions;
    signalId?: string;
    taskQueue?: string;
    workflowId?: string;
    workflowName?: string;
}

Hierarchy (view full)

Properties

args config? entity? namespace? search? signalId? taskQueue? workflowId? workflowName?

Properties

args

args: any[]

Input arguments to pass into the hook

Optionalconfig

config?: WorkflowConfig

Hook function constraints (backoffCoefficient, maximumAttempts, maximumInterval)

Optionalentity

entity?: string

Optional entity name. If provided, applies as the workflowName, taskQueue, and prefix. This scopes the FT.SEARCH index appropriately. This is a convenience method but limits options.

Optionalnamespace

namespace?: string

Optional namespace under which the hook function will be grouped

Optionalsearch

search?: WorkflowSearchOptions

Bind additional search terms immediately before hook reentry

OptionalsignalId

signalId?: string

Signal ID to send after hook execution; if not provided, a random one will be generated

OptionaltaskQueue

taskQueue?: string

Optional task queue, needed unless 'entity' is provided

OptionalworkflowId

workflowId?: string

Execution ID, also known as the job ID to hook into

OptionalworkflowName

workflowName?: string

The name of the user's hook function

Settings

Member Visibility

On This Page

Properties