Skip to main content

Interface: SimplePluginOptions

Experimental

Configuration options for SimplePlugin. Each option can be either a direct value or a function that transforms existing configuration.

Plugins is an experimental feature; APIs may change without notice.

Properties​

activities?​

readonly optional activities?: PluginParameter<object>

Experimental

Activities to register with the worker. When a value is provided, activities will be appended

apiKey?​

readonly optional apiKey?: PluginParameter<string>

Experimental

API key for authentication

clientInterceptors?​

readonly optional clientInterceptors?: PluginParameter<ClientInterceptors>

Experimental

Client-side interceptors. When a value is provided, interceptors will be appended

dataConverter?​

readonly optional dataConverter?: PluginParameter<DataConverter>

Experimental

Data converter for serialization/deserialization. When a value is provided, existing fields will override those in the existing data converter.

name​

readonly name: string

Experimental

The name of the plugin

nexusServices?​

readonly optional nexusServices?: PluginParameter<ServiceHandler<any>[]>

Experimental

Nexus service handlers. When a value is provided, services will be appended

runContext?​

readonly optional runContext?: (next) => Promise<void>

Experimental

Context function to wrap worker execution

Parameters​

next​

() => Promise<void>

Returns​

Promise<void>

tls?​

readonly optional tls?: PluginParameter<boolean | TLSConfig | null>

Experimental

TLS configuration for connections

workerInterceptors?​

readonly optional workerInterceptors?: PluginParameter<WorkerInterceptors>

Experimental

Worker-side interceptors. When a value is provided, interceptors will be appended. Note that workflowModules are only appended to worker options when a workflowsPath is used; with a workflow bundle, they are instead applied at bundling time (see configureBundler).

workflowBundle?​

readonly optional workflowBundle?: PluginParameter<WorkflowBundleOption>

Experimental

Workflow bundle configuration

workflowsPath?​

readonly optional workflowsPath?: PluginParameter<string>

Experimental

Path to workflow files