From 510979e2eb00a96310a0983bb14d6cc4d921c9a5 Mon Sep 17 00:00:00 2001 From: Ben Echols Date: Fri, 27 Feb 2026 09:00:30 -0800 Subject: [PATCH 1/3] Fix typos in TypeScript SDK documentation Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/develop/typescript/converters-and-encryption.mdx | 6 +++--- docs/develop/typescript/core-application.mdx | 6 +++--- docs/develop/typescript/debugging.mdx | 4 ++-- docs/develop/typescript/observability.mdx | 2 +- docs/develop/typescript/schedules.mdx | 6 +++--- docs/develop/typescript/set-up.mdx | 2 +- docs/develop/typescript/temporal-client.mdx | 4 ++-- docs/develop/typescript/temporal-nexus.mdx | 2 +- docs/develop/typescript/versioning.mdx | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/develop/typescript/converters-and-encryption.mdx b/docs/develop/typescript/converters-and-encryption.mdx index 73f363d4a6..5374167dd8 100644 --- a/docs/develop/typescript/converters-and-encryption.mdx +++ b/docs/develop/typescript/converters-and-encryption.mdx @@ -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 @@ -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. diff --git a/docs/develop/typescript/core-application.mdx b/docs/develop/typescript/core-application.mdx index 01322d93d6..7f76f7dacd 100644 --- a/docs/develop/typescript/core-application.mdx +++ b/docs/develop/typescript/core-application.mdx @@ -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. ::: @@ -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. @@ -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. diff --git a/docs/develop/typescript/debugging.mdx b/docs/develop/typescript/debugging.mdx index 6f5368ff33..bc4c6a83e1 100644 --- a/docs/develop/typescript/debugging.mdx +++ b/docs/develop/typescript/debugging.mdx @@ -154,7 +154,7 @@ export async function yourWorkflow(): Promise { ::: 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: @@ -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: diff --git a/docs/develop/typescript/observability.mdx b/docs/develop/typescript/observability.mdx index 95ad51d595..db263e65d7 100644 --- a/docs/develop/typescript/observability.mdx +++ b/docs/develop/typescript/observability.mdx @@ -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 diff --git a/docs/develop/typescript/schedules.mdx b/docs/develop/typescript/schedules.mdx index c21ab1f9e1..99e9f31301 100644 --- a/docs/develop/typescript/schedules.mdx +++ b/docs/develop/typescript/schedules.mdx @@ -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) @@ -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} diff --git a/docs/develop/typescript/set-up.mdx b/docs/develop/typescript/set-up.mdx index 5399f81d77..2eaa999dd9 100644 --- a/docs/develop/typescript/set-up.mdx +++ b/docs/develop/typescript/set-up.mdx @@ -318,7 +318,7 @@ If everything is working correctly, you should see: Additional details about Workflow Execution - 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, the `tls` option can be set to `true` or a `TLSConfig` object. - 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 diff --git a/docs/develop/typescript/temporal-client.mdx b/docs/develop/typescript/temporal-client.mdx index 84f3c2d85b..5d408eaede 100644 --- a/docs/develop/typescript/temporal-client.mdx +++ b/docs/develop/typescript/temporal-client.mdx @@ -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. @@ -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 diff --git a/docs/develop/typescript/temporal-nexus.mdx b/docs/develop/typescript/temporal-nexus.mdx index ec264e4a09..3be0683ea2 100644 --- a/docs/develop/typescript/temporal-nexus.mdx +++ b/docs/develop/typescript/temporal-nexus.mdx @@ -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. diff --git a/docs/develop/typescript/versioning.mdx b/docs/develop/typescript/versioning.mdx index 1b99ad5ed6..7ab09ee434 100644 --- a/docs/develop/typescript/versioning.mdx +++ b/docs/develop/typescript/versioning.mdx @@ -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 From e3481965246b74e8e424fe188f862677fa113245 Mon Sep 17 00:00:00 2001 From: Ben Echols Date: Fri, 27 Feb 2026 10:41:44 -0800 Subject: [PATCH 2/3] Improve TLS option wording in TypeScript set-up docs Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/develop/typescript/set-up.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/typescript/set-up.mdx b/docs/develop/typescript/set-up.mdx index 2eaa999dd9..373a0f00bc 100644 --- a/docs/develop/typescript/set-up.mdx +++ b/docs/develop/typescript/set-up.mdx @@ -318,7 +318,7 @@ If everything is working correctly, you should see: Additional details about Workflow Execution - Temporal clients are not explicitly closed. -- To enable TLS, the `tls` option can be set to `true` or a `TLSConfig` object. +- To enable TLS, set the `tls` option to `true` for default settings or pass a [`TLSConfig`](https://typescript.temporal.io/api/interfaces/client.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 From 90e355a2bf82b7643c45b165a75b71187b8ff654 Mon Sep 17 00:00:00 2001 From: Ben Echols Date: Fri, 27 Feb 2026 10:49:44 -0800 Subject: [PATCH 3/3] Fix TLSConfig link to use correct URL Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/develop/typescript/set-up.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/typescript/set-up.mdx b/docs/develop/typescript/set-up.mdx index 373a0f00bc..e4d6c244fb 100644 --- a/docs/develop/typescript/set-up.mdx +++ b/docs/develop/typescript/set-up.mdx @@ -318,7 +318,7 @@ If everything is working correctly, you should see: Additional details about Workflow Execution - Temporal clients are not explicitly closed. -- To enable TLS, set the `tls` option to `true` for default settings or pass a [`TLSConfig`](https://typescript.temporal.io/api/interfaces/client.TLSConfig) for custom configuration. +- 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