Class: TimeoutFailure

common.TimeoutFailure

Used to represent timeouts of Activities and Workflows

Hierarchy

• TemporalFailure

  ↳ TimeoutFailure

Constructors

constructor

• new TimeoutFailure(message, lastHeartbeatDetails, timeoutType): TimeoutFailure

Parameters

Name	Type
message	undefined | string
lastHeartbeatDetails	unknown
timeoutType	TimeoutType

Returns

TimeoutFailure

Overrides

TemporalFailure.constructor

Properties

cause

• Optional Readonly cause: Error

Inherited from

TemporalFailure.cause

---

failure

• Optional failure: IFailure

The original failure that constructed this error.

Only present if this error was generated from an external operation.

Inherited from

TemporalFailure.failure

---

lastHeartbeatDetails

• Readonly lastHeartbeatDetails: unknown

---

message

• message: string

Inherited from

TemporalFailure.message

---

name

• name: string

Inherited from

TemporalFailure.name

---

stack

• Optional stack: string

Inherited from

TemporalFailure.stack

---

timeoutType

• Readonly timeoutType: TimeoutType

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

TemporalFailure.prepareStackTrace

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

TemporalFailure.stackTraceLimit

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

TemporalFailure.captureStackTrace