Type Alias CallOptions

CallOptions: {
    $guid?: string;
    $type?: string;
    await?: boolean;
    fields?: string[];
    id?: string;
    marker?: StringStringType;
    namespace?: string;
    pending?: number;
    prefix?: string;
    search?: WorkflowSearchOptions;
    taskQueue?: string;
    ttl?: string;
}

Type declaration

  • Optional$guid?: string

    full GUID (including prefix)

  • Optional$type?: string

    exec, hook, proxy

  • Optionalawait?: boolean

    if set to false explicitly it will not await the result

  • Optionalfields?: string[]

    list of state field names to return (this is NOT the final response)

  • Optionalid?: string

    if provided along with a ttl, the function will be cached

  • Optionalmarker?: StringStringType

    Custom marker data field used for adding a searchable marker to the job. markers always begin with a dash (-). Any field that does not begin with a dash will be removed and will not be inserted with the initial data set.

  • Optionalnamespace?: string

    namespace for the the execution client

    Default

    'meshflow'
  • Optionalpending?: number

    If provided, the job will initialize in an pending state, reserving only the job ID (HSETNX) and persisting search and marker (if provided). If a resume signal is sent before the specified number of seconds, the job will resume as normal. If the job is not resumed within the number of seconds provided, the job will be scrubbed. No dependencies are set for a job in a pending state; however, dependencies will be added after the job is resumed if necessary.

  • Optionalprefix?: string

    defaults to entity input parameter; allows override of the workflowId prefix

  • Optionalsearch?: WorkflowSearchOptions
  • OptionaltaskQueue?: string

    taskQueue for the workflowId (defaults to entity)

  • Optionalttl?: string

    in format '1 minute', '5 minutes', '1 hour', 'infinity', etc

Settings

Member Visibility