Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/develop/typescript/converters-and-encryption.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ interface PayloadCodec {

Temporal SDKs provide a [Payload Converter](/payload-converter) that can be customized to convert a custom data type to a [Payload](/dataconversion#payload) and back.

The order in which your encoding Payload Converters are applied depending on the order given to the Data Converter.
The order in which your encoding Payload Converters are applied depends on the order given to the Data Converter.
You can set multiple encoding Payload Converters to run your conversions.
When the Data Converter receives a value for conversion, the value gets passes through each Payload Converter in sequence until the converter that handles the data type does the conversion.
When the Data Converter receives a value for conversion, the value gets passed through each Payload Converter in sequence until the converter that handles the data type does the conversion.

## Composite Data Converters

Expand Down Expand Up @@ -99,7 +99,7 @@ export const payloadConverter = new CompositePayloadConverter(
);
```

You can do this in its own `payload-conterter.ts` file for example.
You can do this in its own `payload-converter.ts` file for example.

In the code snippet above, a converter is created that first attempts to handle `null` and `undefined` values. If the value isn't `null` or `undefined`, the EJSON serialization logic written in the `EjsonPayloadConverter` is then used. The Payload Converter is then provided to the Worker and Client.

Expand Down
6 changes: 3 additions & 3 deletions docs/develop/typescript/core-application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@ A Worker Entity contains a Workflow Worker and/or an Activity Worker, which make

:::note

To improve worker startup time, we recommend preparing workflow bundles ahead-of-time. See our [productionsample](https://github.com/temporalio/samples-typescript/tree/main/production) for details.
To improve worker startup time, we recommend preparing workflow bundles ahead-of-time. See our [production sample](https://github.com/temporalio/samples-typescript/tree/main/production) for details.

:::

Expand Down Expand Up @@ -1017,7 +1017,7 @@ Activities are directly required and run by Workers in the Node.js environment.
Workers are flexible.
You can host any or all of your Workflows and Activities on a Worker, and you can host multiple Workers on a single machine.

The Worker need three main things:
The Worker needs three main things:

- `taskQueue`: The Task Queue to poll. This is the only required argument.
- `activities`: Optional. Imported and supplied directly to the Worker.
Expand Down Expand Up @@ -1086,7 +1086,7 @@ If you do not specify `taskQueue`, the TypeScript SDK places Activity and Child

### How to set a Workflow Id {#workflow-id}

Although it is not required, we recommend providing your own [Workflow Id](/workflow-execution/workflowid-runid#workflow-id)that maps to a business process or business entity identifier, such as an order identifier or customer identifier.
Although it is not required, we recommend providing your own [Workflow Id](/workflow-execution/workflowid-runid#workflow-id) that maps to a business process or business entity identifier, such as an order identifier or customer identifier.

Connect to a Client with `client.workflow.start()` and any arguments. Then specify your `taskQueue` and set your `workflowId` to a meaningful business identifier.

Expand Down
4 changes: 2 additions & 2 deletions docs/develop/typescript/debugging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ export async function yourWorkflow(): Promise<string> {
:::

This is invalid because activity implementations should not be directly referenced by Workflow code.
Activities are used by Workflows in order make network calls and reading from the filesystem, operations which are non-deterministic by nature because they rely on external state.
Activities are used by Workflows in order to make network calls and read from the filesystem, operations which are non-deterministic by nature because they rely on external state.
Temporal records Activity results in the Workflow history and in case your Workflow is replayed, completed Activities will not be rerun, instead their recorded result will be delivered to the Workflow.

You'll typically see an error in this form in the Webpack output:
Expand Down Expand Up @@ -196,7 +196,7 @@ The two main sources of dev-prod discrepancies are in bundling and connecting.

You may experience your Client sending stripped names as the Workflow "Type" when scheduling a Workflow.
Webpack can change the Workflow's function name to something shorter.
Temporal won't know how to handle the mismatch between the shorter name and the expect Workflow type.
Temporal won't know how to handle the mismatch between the shorter name and the expected Workflow type.

You may experience errors like this:

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/typescript/observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ A Temporal Worker may emit logs in various ways, including:
- Messages emitted by the underlying Temporal Core SDK (native code).

All of these messages are internally routed to a single logger object, called the Runtime's Logger.
By default, the Runtime's Logger simply write messages to the console (i.e. the process's `STDOUT`).
By default, the Runtime's Logger simply writes messages to the console (i.e. the process's `STDOUT`).

#### How to customize the Runtime's Logger

Expand Down
6 changes: 3 additions & 3 deletions docs/develop/typescript/schedules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:
description: Schedule automated tasks effortlessly with Temporal. Create, backfill, delete, describe, list, pause, trigger, and update Scheduled Workflows. Control your Workflow execution with Temporal Cron Jobs and ensure timely, automated business processes. Automate repetitive tasks and reduce manual intervention now!
---

The pages shows how to do the following:
This page shows how to do the following:

- [Schedule a Workflow](#schedule-a-workflow)
- [Create a Scheduled Workflow](#create)
Expand All @@ -30,9 +30,9 @@ The pages shows how to do the following:

## How to Schedule a Workflow {#schedule-a-workflow}

Scheduling Workflows is a crucial aspect of any automation process, especially when dealing with time-sensitive tasks. By scheduling a Workflow, you can automate repetitive tasks, reduce the need for manual intervention, and ensure timely execution of your business processes
Scheduling Workflows is a crucial aspect of any automation process, especially when dealing with time-sensitive tasks. By scheduling a Workflow, you can automate repetitive tasks, reduce the need for manual intervention, and ensure timely execution of your business processes.

Use any of the following action to help Schedule a Workflow Execution and take control over your automation process.
Use any of the following actions to help Schedule a Workflow Execution and take control over your automation process.

### How to Create a Scheduled Workflow {#create}

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/typescript/set-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ If everything is working correctly, you should see:
<summary><strong>Additional details about Workflow Execution</strong></summary>

- Temporal clients are not explicitly closed.
- To enable TLS, the `tls` option can be set to `true` or a `Temporalio::Client::Connection::TLSOptions` instance.
- To enable TLS, set the `tls` option to `true` for default settings or pass a [`TLSConfig`](https://typescript.temporal.io/api/interfaces/worker.TLSConfig) for custom configuration.
- Calling `client.workflow.start()` and `client.workflow.execute()` send a command to Temporal Server to schedule a new
Workflow Execution on the specified Task Queue.
- If you started a Workflow with `client.workflow.start()`, you can choose to wait for the result anytime with
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/typescript/temporal-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ directly required and run by Workers in the Node.js environment.
Workers are flexible. You can host any or all of your Workflows and Activities on a Worker, and you can host multiple
Workers on a single machine.

The Worker need three main things:
The Worker needs three main things:

- `taskQueue`: The Task Queue to poll. This is the only required argument.
- `activities`: Optional. Imported and supplied directly to the Worker.
Expand Down Expand Up @@ -748,7 +748,7 @@ places Activity and Child Workflow Tasks in the same Task Queue as the Workflow
### Set a Workflow Id {#workflow-id}

Although it is not required, we recommend providing your own
[Workflow Id](/workflow-execution/workflowid-runid#workflow-id)that maps to a business process or business entity
[Workflow Id](/workflow-execution/workflowid-runid#workflow-id) that maps to a business process or business entity
identifier, such as an order identifier or customer identifier.

Connect to a Client with `client.workflow.start()` and any arguments. Then specify your `taskQueue` and set your
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/typescript/temporal-nexus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ A Service handler must provide Operation handlers for each Operation declared by
Operation handlers can decide if a given Nexus Operation will be synchronous or asynchronous.
They can execute arbitrary code, and invoke underlying Temporal primitives such as a Workflow, Query, Signal, or Update.

The `@temporalio/nexus` package provides utilities to help create Nexus Operations that interracts with a Temporal namespace: {/* Extended */}
The `@temporalio/nexus` package provides utilities to help create Nexus Operations that interact with a Temporal namespace: {/* Extended */}

- `WorkflowRunOperationHandler` - Create an asynchronous operation handler that starts a Workflow.
- `getClient()` - Get a Temporal Client connected using the same `NativeConnection` as the present Temporal Worker.
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/typescript/versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Patching is a three-step process:

1. Patch in any new, updated code using the `patched()` function. Run the new patched code alongside old code.
2. Remove old code and use `deprecatePatch()` to mark a particular patch as deprecated.
3. Once there are no longer any open Worklow Executions of the previous version of the code, remove `deprecatePatch()`.
3. Once there are no longer any open Workflow Executions of the previous version of the code, remove `deprecatePatch()`.
Let's walk through this process in sequence.

### Patching in new code
Expand Down