Skip to main content

Class: SimplePlugin

Experimental

A unified plugin that implements multiple Temporal plugin interfaces. Provides a simple way to configure clients, workers, bundlers, and connections with consistent parameter resolution and merging strategies.

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

Extended by​

Implements​

Constructors​

Constructor​

new SimplePlugin(options): SimplePlugin

Experimental

Creates a new SimplePlugin instance.

Parameters​

options​

SimplePluginOptions

Configuration options for the plugin

Returns​

SimplePlugin

Properties​

name​

readonly name: string

Experimental

The name of the plugin

Implementation of​

NativeConnectionPlugin.name

Methods​

configureBundler()​

configureBundler(options): BundleOptions

Experimental

Configures bundler options by merging plugin parameters with existing options.

Parameters​

options​

BundleOptions

The existing bundle options

Returns​

BundleOptions

Modified bundle options with plugin configuration applied

Implementation of​

BundlerPlugin.configureBundler

configureClient()​

configureClient(options): ClientOptions

Experimental

Configures client options by merging plugin parameters with existing options.

Parameters​

options​

ClientOptions

The existing client options

Returns​

ClientOptions

Modified client options with plugin configuration applied

Implementation of​

ClientPlugin.configureClient

configureConnection()​

configureConnection(options): ConnectionOptions

Experimental

Configures connection options by merging plugin parameters with existing options. Special handling for function-based API keys.

Parameters​

options​

ConnectionOptions

The existing connection options

Returns​

ConnectionOptions

Modified connection options with plugin configuration applied

Implementation of​

ConnectionPlugin.configureConnection

configureNativeConnection()​

configureNativeConnection(options): NativeConnectionOptions

Experimental

Configures native connection options by merging plugin parameters with existing options.

Parameters​

options​

NativeConnectionOptions

The existing native connection options

Returns​

NativeConnectionOptions

Modified native connection options with plugin configuration applied

Implementation of​

NativeConnectionPlugin.configureNativeConnection

configureReplayWorker()​

configureReplayWorker(options): ReplayWorkerOptions

Experimental

Configures replay worker options by merging plugin parameters with existing options.

Parameters​

options​

ReplayWorkerOptions

The existing replay worker options

Returns​

ReplayWorkerOptions

Modified replay worker options with plugin configuration applied

Implementation of​

WorkerPlugin.configureReplayWorker

configureWorker()​

configureWorker(options): WorkerOptions

Experimental

Configures worker options by merging plugin parameters with existing options. Activities and nexus services are appended, while other options are replaced.

Parameters​

options​

WorkerOptions

The existing worker options

Returns​

WorkerOptions

Modified worker options with plugin configuration applied

Implementation of​

WorkerPlugin.configureWorker

runWorker()​

runWorker(worker, next): Promise<void>

Experimental

Runs the worker, optionally wrapping execution in a custom context.

Parameters​

worker​

Worker

The worker instance to run

next​

(w) => Promise<void>

Function to continue worker execution

Returns​

Promise<void>

Promise that resolves when worker execution completes

Implementation of​

WorkerPlugin.runWorker