Skip to main content

Interface: ReplayWorkerOptions

worker.ReplayWorkerOptions

WorkerOptions with inapplicable-to-replay fields removed.

Hierarchy

  • Omit<WorkerOptions, "connection" | "namespace" | "taskQueue" | "activities" | "maxConcurrentActivityTaskExecutions" | "maxConcurrentLocalActivityExecutions" | "maxConcurrentWorkflowTaskExecutions" | "maxHeartbeatThrottleInterval" | "defaultHeartbeatThrottleInterval" | "debugMode">

    ReplayWorkerOptions

Properties

buildId

Optional buildId: string

A string that should be unique to the exact worker code/binary being executed.

This is used to populate the binaryChecksum attribute in history events originated from this Worker.

Default

@temporalio/worker package name and version + checksum of workflow bundle's code

Inherited from

Omit.buildId


bundlerOptions

Optional bundlerOptions: Object

Type declaration

NameTypeDescription
ignoreModules?string[]List of modules to be excluded from the Workflows bundle. Use this option when your Workflow code references an import that cannot be used in isolation, e.g. a Node.js built-in module. Modules listed here MUST not be used at runtime. > NOTE: This is an advanced option that should be used with care.

Inherited from

Omit.bundlerOptions


dataConverter

Optional dataConverter: DataConverter

Provide a custom DataConverter.

Inherited from

Omit.dataConverter


enableNonLocalActivities

Optional enableNonLocalActivities: boolean

Whether or not to poll on the Activity task queue.

If disabled and activities are registered on the Worker, it will run only local Activities.

Default

true

Inherited from

Omit.enableNonLocalActivities


enableSDKTracing

Optional enableSDKTracing: boolean

Enable opentelemetry tracing of SDK internals like polling, processing and completing tasks.

Useful for debugging issues with the SDK itself.

For completeness the Rust Core also generates opentelemetry spans which connect to the Worker's spans. Configure CoreOptions.telemetryOptions to enable tracing in Core.

Default

false

Inherited from

Omit.enableSDKTracing


identity

Optional identity: string

A human-readable string that can identify your worker

Default

${process.pid}@${os.hostname()}

Inherited from

Omit.identity


interceptors

Optional interceptors: WorkerInterceptors

A mapping of interceptor type to a list of factories or module paths.

By default ActivityInboundLogInterceptor and WorkflowInboundLogInterceptor are installed.

If you wish to customize the interceptors while keeping the defaults, use appendDefaultInterceptors.

Inherited from

Omit.interceptors


maxActivitiesPerSecond

Optional maxActivitiesPerSecond: number

Limits the number of activities per second that this worker will process. The worker will not poll for new activities if by doing so it might receive and execute an activity which would cause it to exceed this limit. Must be a positive floating point number.

If unset, no rate limiting will be applied to Worker's activities.

Inherited from

Omit.maxActivitiesPerSecond


maxCachedWorkflows

Optional maxCachedWorkflows: number

The number of Workflow isolates to keep in cached in memory

Cached Workflows continue execution from their last stopping point. If the Worker is asked to run an uncached Workflow, it will need to replay the entire Workflow history. Use as a dial for trading memory for CPU time.

You should be able to fit about 500 Workflows per GB of memory dependening on your Workflow bundle size. For the SDK test Workflows, we managed to fit 750 Workflows per GB.

Default

max(os.totalmem() / 1GiB - 1, 1) * 200

Inherited from

Omit.maxCachedWorkflows


maxTaskQueueActivitiesPerSecond

Optional maxTaskQueueActivitiesPerSecond: number

Sets the maximum number of activities per second the task queue will dispatch, controlled server-side. Note that this only takes effect upon an activity poll request. If multiple workers on the same queue have different values set, they will thrash with the last poller winning.

If unset, no rate limiting will be applied to the task queue.

Inherited from

Omit.maxTaskQueueActivitiesPerSecond


replayName

Optional replayName: string

A name for this replay worker. It will be combined with a short random ID to form a unique task queue for the replay worker.

Default

workflow name from given history


shutdownGraceTime

Optional shutdownGraceTime: string | number

Time to wait for pending tasks to drain after shutdown was requested.

Format

ms formatted string or number of milliseconds

Default

10s

Inherited from

Omit.shutdownGraceTime


sinks

Optional sinks: InjectedSinks<any>

Implementation of the Sinks interface, a mapping of name to InjectedSink.

Sinks are a mechanism for exporting data from the Workflow sandbox to the Node.js environment, they are necessary because the Workflow has no way to communicate with the outside World.

Sinks are typically used for exporting logs, metrics and traces out from the Workflow.

Sink functions may not return values to the Workflow in order to prevent breaking determinism.

By default the defaultWorkerLogger sink is installed and is required by WorkflowInboundLogInterceptor.

If you wish to customize the sinks while keeping the defaults, merge yours with defaultSinks.

Inherited from

Omit.sinks


stickyQueueScheduleToStartTimeout

Optional stickyQueueScheduleToStartTimeout: string

How long a workflow task is allowed to sit on the sticky queue before it is timed out and moved to the non-sticky queue where it may be picked up by any worker.

Format

ms formatted string

Default

10s

Inherited from

Omit.stickyQueueScheduleToStartTimeout


workflowBundle

Optional workflowBundle: WorkflowBundleOption

Use a pre-built bundle for Workflow code. Use bundleWorkflowCode to genrate a bundle.

This is the recommended way to deploy Workers to production.

See https://docs.temporal.io/typescript/production-deploy#pre-build-code for more information.

Inherited from

Omit.workflowBundle


workflowsPath

Optional workflowsPath: string

Path to look up workflows in, any function exported in this path will be registered as a Workflows in this Worker.

If this option is provided to create, Webpack compliation will be triggered.

This option is typically used for local development, for production it's preferred to pre-build the Workflow bundle and pass that to create via the workflowBundle option.

See https://docs.temporal.io/typescript/production-deploy#pre-build-code for more information.

Inherited from

Omit.workflowsPath