Skip to main content
@usenarrator/plugin-temporal The Temporal plugin reads the TypeScript SDK in terms of what Temporal guarantees. Proxied activities list their timeouts and retry policy, a call to an activity reads as “run the activity”, sleep is a durable timer, and signals, queries and updates read as messages the workflow receives. On the client side it says whether starting a workflow waits for the result.
The plugin declares library: { name: "@temporalio/workflow", versions: ">=1 <2" }. It narrates files that import from any @temporalio/* package (workflow, activity, worker or client) or belong to a package that depends on one (see Dependency detection). Other libraries’ sleep, condition and signal functions are left alone.

Examples

A workflow with activities, a signal and a timer
English
A worker
English
Starting and signalling a workflow
English

What it covers

  • Workflows: proxyActivities and proxyLocalActivities with timeouts and retry policies, activity calls, sleep, condition with a timeout, continueAsNew, patched, cancellation scopes and ApplicationFailure.
  • Messages: defineSignal, defineQuery and defineUpdate, and setHandler for each.
  • Child workflows: executeChild and startChild with their options.
  • Activities: heartbeat, sleep and the activity context.
  • Workers: NativeConnection, Worker.create with its task queue, workflows and activities, and worker.run.
  • The client: client.workflow.start, execute, signal, query, result, getHandle, terminate and cancel, cron workflows and client.schedule.

Translating

The English phrasebook is exported as en and typed as TemporalPhrases. Its time section has the same shape as the other job plugins’ (TimePhrases).