Skip to main content

Interface: BundleOptions

worker.BundleOptions

Options for bundling Workflow code using Webpack

Properties

failureConverterPath

Optional failureConverterPath: string

Path to a module with a failureConverter named export. failureConverter should be an instance of a class that implements FailureConverter.


ignoreModules

Optional ignoreModules: string[]

List of modules to be excluded from the Workflows bundle.

Use this option when your Workflow code references an import that cannot be used in isolation, e.g. a Node.js built-in module. Modules listed here MUST not be used at runtime.

NOTE: This is an advanced option that should be used with care.


logger

Optional logger: Logger

Optional logger for logging Webpack output


payloadConverterPath

Optional payloadConverterPath: string

Path to a module with a payloadConverter named export. payloadConverter should be an instance of a class that implements PayloadConverter.


webpackConfigHook

Optional webpackConfigHook: (config: Configuration) => Configuration

Type declaration

▸ (config): Configuration

Before Workflow code is bundled with Webpack, webpackConfigHook is called with the Webpack configuration object so you can modify it.

Parameters
NameType
configConfiguration
Returns

Configuration


workflowInterceptorModules

Optional workflowInterceptorModules: string[]

List of modules to import Workflow interceptors from.

Modules should export an interceptors variable of type WorkflowInterceptorsFactory.

By default, WorkflowInboundLogInterceptor is installed. If you wish to customize the interceptors while keeping the defaults, add defaultWorflowInterceptorModules to the provided array.


workflowsPath

workflowsPath: string

Path to look up workflows in, any function exported in this path will be registered as a Workflows when the bundle is loaded by a Worker.