Skip to main content

Interface: ServerOptions

worker.ServerOptions

Properties#

address#

Optional address: string

The host and optional port of the Temporal server to connect to. Port defaults to 7233 if address contains only host.

default localhost:7233


identity#

Optional identity: string

A human-readable string that can identify your worker

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


longPollTimeout#

Optional longPollTimeout: string

Timeout for long polls (polling of task queues)

format ms formatted string


namespace#

Optional namespace: string

What namespace will we operate under

default default


tls#

Optional tls: null | boolean | TLSConfig

TLS configuration options.

Pass a falsy value to use a non-encrypted connection or true or {} to connect with TLS without any customization.


workerBinaryId#

Optional workerBinaryId: string

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

default @temporal/worker package name and version