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
Configuration options for the plugin
Returns
SimplePlugin
Properties
name
readonlyname:string
Experimental
The name of the plugin
Implementation of
version?
readonlyoptionalversion?:string
Experimental
The version of the plugin, reported in worker heartbeats
Implementation of
Methods
configureBundler()
configureBundler(
options):BundleOptions
Experimental
Configures bundler options by merging plugin parameters with existing options.
Parameters
options
The existing bundle options
Returns
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
The existing client options
Returns
Modified client options with plugin configuration applied
Implementation of
configureConnection()
configureConnection(
options):ConnectionOptions
Experimental
Configures connection options by merging plugin parameters with existing options. Special handling for function-based API keys.
Parameters
options
The existing connection options
Returns
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
The existing native connection options
Returns
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
The existing replay worker options
Returns
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
The existing worker options
Returns
Modified worker options with plugin configuration applied
Implementation of
connect()
connect(
options,next):Promise<Connection>
Experimental
Connects with Connection.connect. Override to wrap connecting.
Parameters
options
The connection options
next
(options) => Promise<Connection>
Function to continue connecting
Returns
Promise<Connection>
Promise that resolves to the connection
Implementation of
connectNative()
connectNative(
options,next):Promise<NativeConnection>
Experimental
Connects with NativeConnection.connect. Override to wrap connecting.
Parameters
options
The native connection options
next
(options) => Promise<NativeConnection>
Function to continue connecting
Returns
Promise<NativeConnection>
Promise that resolves to the native connection
Implementation of
NativeConnectionPlugin.connectNative
runWorker()
runWorker(
worker,next):Promise<void>
Experimental
Runs the worker, optionally wrapping execution in a custom context.
Parameters
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