Class: CompleteAsyncError

activity.CompleteAsyncError

Throw this error from an Activity in order to make the Worker forget about this Activity.

The Activity can then be completed asynchronously (from anywhere—usually outside the Worker) using Client.activity.

Example

import { CompleteAsyncError } from '@temporalio/activity';

export async function myActivity(): Promise<never> {
 // ...
 throw new CompleteAsyncError();
}

Hierarchy

• Error

  ↳ CompleteAsyncError

Constructors

constructor

• new CompleteAsyncError(message?): CompleteAsyncError

Parameters

Name	Type
message?	string

Returns

CompleteAsyncError

Inherited from

Error.constructor

• new CompleteAsyncError(message?, options?): CompleteAsyncError

Parameters

Name	Type
message?	string
options?	ErrorOptions

Returns

CompleteAsyncError

Inherited from

Error.constructor

Properties

cause

• Optional cause: unknown

Inherited from

Error.cause

---

message

• message: string

Inherited from

Error.message

---

name

• name: string

Inherited from

Error.name

---

stack

• Optional stack: string

Inherited from

Error.stack

---

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

Error.prepareStackTrace

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.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

Error.captureStackTrace