Namespace: common

Common library for code that's used across the Client, Worker, and/or Workflow

Enumerations

• ActivityCancellationType
• RetryState
• TimeoutType
• WorkflowIdReusePolicy

Classes

• ActivityFailure
• ApplicationFailure
• BinaryPayloadConverter
• CancelledFailure
• ChildWorkflowFailure
• CompositePayloadConverter
• DefaultPayloadConverter
• IllegalStateError
• JsonPayloadConverter
• PayloadConverterError
• ServerFailure
• TemporalFailure
• TerminatedFailure
• TimeoutFailure
• UndefinedPayloadConverter
• ValueError
• WorkflowExecutionAlreadyStartedError
• WorkflowNotFoundError

Interfaces

• ActivityFunction
• ActivityOptions
• BaseWorkflowOptions
• DataConverter
• LoadedDataConverter
• LocalActivityOptions
• PayloadCodec
• PayloadConverter
• PayloadConverterWithEncoding
• QueryDefinition
• SignalDefinition
• WorkflowDurationOptions

References

Headers

Re-exports Headers

---

Next

Re-exports Next

---

RetryPolicy

Re-exports RetryPolicy

Type Aliases

ActivityInterface

Ƭ ActivityInterface: Record<string, ActivityFunction>

Mapping of Activity name to function

Deprecated

not required anymore, for untyped activities use UntypedActivities

---

CommonWorkflowOptions

Ƭ CommonWorkflowOptions: BaseWorkflowOptions & WorkflowDurationOptions

---

EncodingType

Ƭ EncodingType: typeof encodingTypes[keyof typeof encodingTypes]

---

Payload

Ƭ Payload: IPayload

---

ProtoFailure

Ƭ ProtoFailure: IFailure

---

SearchAttributeValue

Ƭ SearchAttributeValue: string[] | number[] | boolean[] | Date[]

---

SearchAttributes

Ƭ SearchAttributes: Record<string, SearchAttributeValue | undefined>

If another SDK creates a Search Attribute that's not an array, we wrap it in an array.

Dates are serialized as ISO strings.

---

Timestamp

Ƭ Timestamp: ITimestamp

---

UntypedActivities

Ƭ UntypedActivities: Record<string, ActivityFunction>

Mapping of Activity name to function

---

WithCompiledWorkflowOptions

Ƭ WithCompiledWorkflowOptions<T>: Replace<T, { workflowExecutionTimeout?: IDuration ; workflowRunTimeout?: IDuration ; workflowTaskTimeout?: IDuration }>

Type parameters

Name	Type
T	extends CommonWorkflowOptions

---

WithWorkflowArgs

Ƭ WithWorkflowArgs<W, T>: T & Parameters<W> extends [any, ...any[]] ? { args: Parameters<W> } : { args?: Parameters<W> }

Type parameters

Name	Type
W	extends Workflow
T	T

---

Workflow

Ƭ Workflow: (...args: any[]) => WorkflowReturnType

Type declaration

▸ (...args): WorkflowReturnType

Broad Workflow function definition, specific Workflows will typically use a narrower type definition, e.g:

export async function myWorkflow(arg1: number, arg2: string): Promise<string>;

Parameters

Name	Type
...args	any[]

Returns

WorkflowReturnType

---

WorkflowExecution

Ƭ WorkflowExecution: IWorkflowExecution

---

WorkflowQueryType

Ƭ WorkflowQueryType: (...args: any[]) => any

Type declaration

▸ (...args): any

Parameters

Name	Type
...args	any[]

Returns

any

---

WorkflowResultType

Ƭ WorkflowResultType<W>: ReturnType<W> extends Promise<infer R> ? R : never

Get the "unwrapped" return type (without Promise) of the execute handler from Workflow type W

Type parameters

Name	Type
W	extends Workflow

---

WorkflowReturnType

Ƭ WorkflowReturnType: Promise<any>

Type that can be returned from a Workflow execute function

---

WorkflowSignalType

Ƭ WorkflowSignalType: (...args: any[]) => Promise<void> | void

Type declaration

▸ (...args): Promise<void> | void

Parameters

Name	Type
...args	any[]

Returns

Promise<void> | void

Variables

FAILURE_SOURCE

• Const FAILURE_SOURCE: "TypeScriptSDK"

---

METADATA_ENCODING_KEY

• Const METADATA_ENCODING_KEY: "encoding"

---

METADATA_MESSAGE_TYPE_KEY

• Const METADATA_MESSAGE_TYPE_KEY: "messageType"

---

defaultDataConverter

• Const defaultDataConverter: LoadedDataConverter

---

defaultPayloadConverter

• Const defaultPayloadConverter: DefaultPayloadConverter

The default PayloadConverter used by the SDK. Supports Uint8Array and JSON serializables (so if JSON.stringify(yourArgOrRetval) works, the default payload converter will work).

To also support Protobufs, create a custom payload converter with DefaultPayloadConverter:

const myConverter = new DefaultPayloadConverter({ protobufRoot })

---

encodingKeys

• Const encodingKeys: Object

Type declaration

Name	Type
METADATA_ENCODING_JSON	Uint8Array
METADATA_ENCODING_NULL	Uint8Array
METADATA_ENCODING_PROTOBUF	Uint8Array
METADATA_ENCODING_PROTOBUF_JSON	Uint8Array
METADATA_ENCODING_RAW	Uint8Array

---

encodingTypes

• Const encodingTypes: Object

Type declaration

Name	Type
METADATA_ENCODING_JSON	"json/plain"
METADATA_ENCODING_NULL	"binary/null"
METADATA_ENCODING_PROTOBUF	"binary/protobuf"
METADATA_ENCODING_PROTOBUF_JSON	"json/protobuf"
METADATA_ENCODING_RAW	"binary/plain"

---

searchAttributePayloadConverter

• Const searchAttributePayloadConverter: SearchAttributePayloadConverter

Functions

arrayFromPayloads

▸ arrayFromPayloads(converter, payloads?): unknown[]

Run fromPayload on each value in the array.

Parameters

Name	Type
converter	PayloadConverter
payloads?	null | IPayload[]

Returns

unknown[]

---

compileWorkflowOptions

▸ compileWorkflowOptions<T>(options): WithCompiledWorkflowOptions<T>

Type parameters

Name	Type
T	extends CommonWorkflowOptions

Parameters

Name	Type
options	T

Returns

WithCompiledWorkflowOptions<T>

---

cutoffStackTrace

▸ cutoffStackTrace(stack?): string

Cuts out the framework part of a stack trace, leaving only user code entries

Parameters

Name	Type
stack?	string

Returns

string

---

ensureApplicationFailure

▸ ensureApplicationFailure(error): ApplicationFailure

If error is already an ApplicationFailure, returns error.

Otherwise, converts error into an ApplicationFailure with:

• message: error.message or String(error)
• type: error.constructor.name or error.name
• stack: error.stack or ''

Parameters

Name	Type
error	unknown

Returns

ApplicationFailure

---

ensureTemporalFailure

▸ ensureTemporalFailure(err): TemporalFailure

If err is an Error it is turned into an ApplicationFailure.

If err was already a TemporalFailure, returns the original error.

Otherwise returns an ApplicationFailure with String(err) as the message.

Parameters

Name	Type
err	unknown

Returns

TemporalFailure

---

errorCode

▸ errorCode(error): string | undefined

Get error.code (or undefined if not present)

Parameters

Name	Type
error	unknown

Returns

string | undefined

---

errorMessage

▸ errorMessage(error): string | undefined

Get error.message (or undefined if not present)

Parameters

Name	Type
error	unknown

Returns

string | undefined

---

errorToFailure

▸ errorToFailure(err, payloadConverter): ProtoFailure

Converts a caught error to a Failure proto message

Parameters

Name	Type
err	unknown
payloadConverter	PayloadConverter

Returns

ProtoFailure

---

failureToError

▸ failureToError(failure, payloadConverter): TemporalFailure

Converts a Failure proto message to a JS Error object.

Parameters

Name	Type
failure	IFailure
payloadConverter	PayloadConverter

Returns

TemporalFailure

---

failureToErrorInner

▸ failureToErrorInner(failure, payloadConverter): TemporalFailure

Converts a Failure proto message to a JS Error object.

Does not set common properties, that is done in failureToError.

Parameters

Name	Type
failure	IFailure
payloadConverter	PayloadConverter

Returns

TemporalFailure

---

fromPayloadsAtIndex

▸ fromPayloadsAtIndex<T>(converter, index, payloads?): T

Implements conversion of an array of values of different types. Useful for deserializing arguments of function invocations.

Throws

PayloadConverterError if conversion of the data passed as parameter failed for any reason.

Type parameters

Name
T

Parameters

Name	Type	Description
converter	PayloadConverter
index	number	index of the value in the payloads
payloads?	null | IPayload[]	serialized value to convert to JS values.

Returns

T

converted JS value

---

mapFromPayloads

▸ mapFromPayloads<K>(converter, map?): Record<K, unknown> | undefined | null

Type parameters

Name	Type
K	extends string

Parameters

Name	Type
converter	PayloadConverter
map?	null | Record<K, IPayload>

Returns

Record<K, unknown> | undefined | null

---

mapToPayloads

▸ mapToPayloads<K>(converter, map): Record<K, Payload>

Run toPayload on each value in the map.

Throws

ValueError if conversion of any value in the map fails

Type parameters

Name	Type
K	extends string

Parameters

Name	Type
converter	PayloadConverter
map	Record<K, any>

Returns

Record<K, Payload>

---

msNumberToTs

▸ msNumberToTs(millis): Timestamp

Parameters

Name	Type
millis	number

Returns

Timestamp

---

msOptionalToNumber

▸ msOptionalToNumber(val): number | undefined

Parameters

Name	Type
val	undefined | string | number

Returns

number | undefined

---

msOptionalToTs

▸ msOptionalToTs(str): Timestamp | undefined

Parameters

Name	Type
str	undefined | string | number

Returns

Timestamp | undefined

---

msToNumber

▸ msToNumber(val): number

Parameters

Name	Type
val	string | number

Returns

number

---

msToTs

▸ msToTs(str): Timestamp

Parameters

Name	Type
str	string | number

Returns

Timestamp

---

optionalErrorToOptionalFailure

▸ optionalErrorToOptionalFailure(err, payloadConverter): ProtoFailure | undefined

Converts an error to a Failure proto message if defined or returns undefined

Parameters

Name	Type
err	unknown
payloadConverter	PayloadConverter

Returns

ProtoFailure | undefined

---

optionalFailureToOptionalError

▸ optionalFailureToOptionalError(failure, payloadConverter): TemporalFailure | undefined

Converts a Failure proto message to a JS Error object if defined or returns undefined.

Parameters

Name	Type
failure	undefined | null | IFailure
payloadConverter	PayloadConverter

Returns

TemporalFailure | undefined

---

optionalTsToDate

▸ optionalTsToDate(ts): Date | undefined

Parameters

Name	Type
ts	undefined | null | ITimestamp

Returns

Date | undefined

---

optionalTsToMs

▸ optionalTsToMs(ts): number | undefined

Lossy conversion function from Timestamp to number due to possible overflow. If ts is null or undefined returns undefined.

Parameters

Name	Type
ts	undefined | null | ITimestamp

Returns

number | undefined

---

rootCause

▸ rootCause(error): string | undefined

Get the root cause message of given error.

In case error is a TemporalFailure, recurse the cause chain and return the root cause.message. Otherwise, return error.message.

Parameters

Name	Type
error	unknown

Returns

string | undefined

---

str

▸ str(a): string

Parameters

Name	Type
a	Uint8Array

Returns

string

---

toPayloads

▸ toPayloads(converter, ...values): Payload[] | undefined

Implements conversion of a list of values.

Throws

ValueError if conversion of the value passed as parameter failed for any reason.

Parameters

Name	Type	Description
converter	PayloadConverter
...values	unknown[]	JS values to convert to Payloads

Returns

Payload[] | undefined

list of Payloads

---

tsToDate

▸ tsToDate(ts): Date

Parameters

Name	Type
ts	ITimestamp

Returns

Date

---

tsToMs

▸ tsToMs(ts): number

Lossy conversion function from Timestamp to number due to possible overflow

Parameters

Name	Type
ts	undefined | null | ITimestamp

Returns

number

---

u8

▸ u8(s): Uint8Array

Transform an ascii string into a Uint8Array

Parameters

Name	Type
s	string

Returns

Uint8Array