nestjs-temporal-core
    Preparing search index...

    Class Client

    High level SDK client.

    Hierarchy

    • BaseClient
      • Client
    Index

    Constructors

    constructor

    Properties

    activity connection options schedule taskQueue workflow

    Accessors

    workflowService

    Methods

    withAbortSignal withDeadline withMetadata

    Constructors

    • Parameters

      • Optionaloptions: ClientOptions

      Returns Client

    Properties

    activity: AsyncCompletionClient

    (Async) Activity completion sub-client - use to manually manage Activities

    connection: ConnectionLike

    The underlying Connection | connection or NativeConnection | native connection used by this client.

    Clients are cheap to create, but connections are expensive. Where it makes sense, a single connection may and should be reused by multiple Clients.

    options: LoadedClientOptions
    schedule: ScheduleClient

    Schedule sub-client - use to start and interact with Schedules

    taskQueue: TaskQueueClient

    Task Queue sub-client - use to perform operations on Task Queues

    The Worker Versioning API is still being designed. Major changes are expected.

    workflow: WorkflowClient

    Workflow sub-client - use to start and interact with Workflows

    Accessors

    • get workflowService(): WorkflowService

      Raw gRPC access to the Temporal service.

      NOTE: The namespace provided in options is not automatically set on requests made via this service object.

      Returns WorkflowService

    Methods

    • Set an AbortSignal that, when aborted, cancels any ongoing service requests executed in fn's scope. This will locally result in the request call throwing a _grpc.ServiceError|ServiceError with code _grpc.status.CANCELLED|CANCELLED; see isGrpcCancelledError.

      This method is only a convenience wrapper around Connection.withAbortSignal.

      Type Parameters

      • R

      Parameters

      • abortSignal: AbortSignal
      • fn: () => Promise<R>

      Returns Promise<R>

      value returned from fn

      https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

    • Set a deadline for any service requests executed in fn's scope.

      The deadline is a point in time after which any pending gRPC request will be considered as failed; this will locally result in the request call throwing a _grpc.ServiceError|ServiceError with code _grpc.status.DEADLINE_EXCEEDED|DEADLINE_EXCEEDED; see isGrpcDeadlineError.

      It is stronly recommended to explicitly set deadlines. If no deadline is set, then it is possible for the client to end up waiting forever for a response.

      This method is only a convenience wrapper around Connection.withDeadline.

      Type Parameters

      • R

      Parameters

      • deadline: number | Date

        a point in time after which the request will be considered as failed; either a Date object, or a number of milliseconds since the Unix epoch (UTC).

      • fn: () => Promise<R>

      Returns Promise<R>

      the value returned from fn

      https://grpc.io/docs/guides/deadlines/

    • Set metadata for any service requests executed in fn's scope.

      This method is only a convenience wrapper around Connection.withMetadata.

      Type Parameters

      • R

      Parameters

      • metadata: Metadata
      • fn: () => Promise<R>

      Returns Promise<R>

      returned value of fn

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods