Namespace: testing

npm i @temporalio/testing

Testing library for the SDK.

Documentation

Classes

• MockActivityEnvironment
• TestWorkflowEnvironment
• TimeSkippingWorkflowClient

Interfaces

• DevServerConfig
• MockActivityEnvironmentOptions
• TimeSkippingServerConfig

Type Aliases

ClientOptionsForTestEnv

Ƭ ClientOptionsForTestEnv: Omit<ClientOptions, "namespace" | "connection">

Subset of the "normal" client options that are used to create a client for the test environment.

---

EphemeralServerExecutable

Ƭ EphemeralServerExecutable: { downloadDir?: string ; ttl?: Duration ; type: "cached-download" ; version?: string } | { path: string ; type: "existing-path" }

Which version of the executable to run.

---

ExistingServerTestWorkflowEnvironmentOptions

Ƭ ExistingServerTestWorkflowEnvironmentOptions: Object

Options for TestWorkflowEnvironment.createExistingServer

Type declaration

Name	Type	Description
address?	string	If not set, defaults to localhost:7233
client?	ClientOptionsForTestEnv	-
namespace?	string	If not set, defaults to default

---

LocalTestWorkflowEnvironmentOptions

Ƭ LocalTestWorkflowEnvironmentOptions: Object

Options for TestWorkflowEnvironment.createLocal

Type declaration

Name	Type
client?	ClientOptionsForTestEnv
server?	Omit<DevServerConfig, "type">

---

TimeSkippingTestWorkflowEnvironmentOptions

Ƭ TimeSkippingTestWorkflowEnvironmentOptions: Object

Options for TestWorkflowEnvironment.createTimeSkipping

Type declaration

Name	Type
client?	ClientOptionsForTestEnv
server?	Omit<TimeSkippingServerConfig, "type">

Variables

workflowInterceptorModules

• Const workflowInterceptorModules: string[]

Convenience workflow interceptors

Contains a single interceptor for transforming AssertionErrors into non retryable ApplicationFailures.