website·Indexed 41 days ago
https://typescript.temporal.io/API documentation for the Temporal TypeScript SDK, including the workflowservice.v1 namespace, workflow-streams, and related interfaces, classes, and type aliases for managing workflow executions and worker deployments.
Memo class represents a user-defined set of unindexed fields that are exposed when listing or searching for workflows in Temporal.google.protobuf.FeatureSetDefaults is a compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and are used to seed feature resolution. Resolution using this object involves searching for the closest matching edition followed by proto merges.WorkflowType class represents the identifier used by a workflow author to define the workflow. This is typically the name of the function and is often referred to as the workflow's "name".google.protobuf.GeneratedCodeInfo class describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with exactly one generated source file, though it may contain references to multiple different source .proto files.TemporalNexusClient is a Nexus-aware Temporal Client designed for use within TemporalOperationHandler implementations. It allows developers to interact with Temporal Workflows and Activities while maintaining Nexus Operation context. Note that Temporal Operation handlers are currently experimental.TestService API is an experimental interface supported exclusively by the Temporal Test Server. It provides specialized functionality required for testing purposes, such as controlling server time and time skipping.google.api.HttpRule class defines the schema for this mapping, specifying how gRPC request message fields are mapped to the URL path, URL query parameters, and the HTTP request body, as well as how the gRPC response is mapped to the HTTP response body. HttpRule is typically applied as a google.api.http annotation on a gRPC method.CancelActivityResult class represents the result of a CancelActivityCommand. When processing this result, both a successful cancellation and a no-op (where the activity is no longer running) should be treated as a success.@temporalio/langsmith package provides LangSmith observability for Temporal workflows and activities. The primary entry point for this functionality is the LangSmithPlugin class, which is configured using LangSmithPluginOptions.proto.temporal.api.cloud.cloudservice.v1.CloudService is an experimental RPC service used for managing cloud service resources and connectivity rules. Because it is experimental, the API may change in incompatible ways. It inherits from the base Service class.The Temporal TypeScript SDK is divided into several specialized packages depending on the component being implemented:
@temporalio/worker: Used to run Workflows and Activities.@temporalio/workflow: The runtime library for defining Workflow logic.@temporalio/activity: Provides access to the current Activity's context.@temporalio/client: Used to send commands and interact with the Temporal Server.@temporalio/nexus: Used to implement and invoke Nexus Operations.@temporalio/testing: The dedicated test framework for Temporal applications.@temporalio/common: Shared library used across Client, Worker, and Workflow components.@temporalio/proto: Contains the compiled protobuf definitions.@temporalio/interceptors-opentelemetry: Provides interceptors for adding OpenTelemetry tracing.BatchJob class represents a link to a built-in batch job. Batch jobs are used to perform bulk operations on a set of workflows, such as terminating, signaling, or canceling them. This link is typically found on workflow history events generated by actions taken by a batch job.