Skip to main content

Interface: SimplePluginOptions

plugin.SimplePluginOptions

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

Optional Readonly activities: PluginParameter<object>

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


apiKey

Optional Readonly apiKey: PluginParameter<string>

API key for authentication


clientInterceptors

Optional Readonly clientInterceptors: PluginParameter<ClientInterceptors>

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


dataConverter

Optional Readonly dataConverter: PluginParameter<DataConverter>

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


name

Readonly name: string

The name of the plugin


nexusServices

Optional Readonly nexusServices: PluginParameter<ServiceHandler<any>[]>

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


runContext

Optional Readonly runContext: (next: () => Promise<void>) => Promise<void>

Context function to wrap worker execution

Type declaration

▸ (next): Promise<void>

Parameters
NameType
next() => Promise<void>
Returns

Promise<void>


tls

Optional Readonly tls: PluginParameter<null | boolean | TLSConfig>

TLS configuration for connections


workerInterceptors

Optional Readonly workerInterceptors: PluginParameter<WorkerInterceptors>

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


workflowBundle

Optional Readonly workflowBundle: PluginParameter<WorkflowBundleOption>

Workflow bundle configuration


workflowsPath

Optional Readonly workflowsPath: PluginParameter<string>

Path to workflow files