Skip to content

Commit 43de4d8

Browse files
becholsclaudebrianmacdonald-temporal
authored
Fix typos in TypeScript SDK documentation (#4254)
* Fix typos in TypeScript SDK documentation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Improve TLS option wording in TypeScript set-up docs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix TLSConfig link to use correct URL Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io>
1 parent 33cf45f commit 43de4d8

9 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/develop/typescript/converters-and-encryption.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ interface PayloadCodec {
6161

6262
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.
6363

64-
The order in which your encoding Payload Converters are applied depending on the order given to the Data Converter.
64+
The order in which your encoding Payload Converters are applied depends on the order given to the Data Converter.
6565
You can set multiple encoding Payload Converters to run your conversions.
66-
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.
66+
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.
6767

6868
## Composite Data Converters
6969

@@ -99,7 +99,7 @@ export const payloadConverter = new CompositePayloadConverter(
9999
);
100100
```
101101

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

104104
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.
105105

docs/develop/typescript/core-application.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,7 @@ A Worker Entity contains a Workflow Worker and/or an Activity Worker, which make
743743

744744
:::note
745745

746-
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.
746+
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.
747747

748748
:::
749749

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

1020-
The Worker need three main things:
1020+
The Worker needs three main things:
10211021

10221022
- `taskQueue`: The Task Queue to poll. This is the only required argument.
10231023
- `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
10861086

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

1089-
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.
1089+
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.
10901090

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

docs/develop/typescript/debugging.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ export async function yourWorkflow(): Promise<string> {
154154
:::
155155

156156
This is invalid because activity implementations should not be directly referenced by Workflow code.
157-
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.
157+
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.
158158
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.
159159

160160
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.
196196

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

201201
You may experience errors like this:
202202

docs/develop/typescript/observability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ A Temporal Worker may emit logs in various ways, including:
197197
- Messages emitted by the underlying Temporal Core SDK (native code).
198198

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

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

docs/develop/typescript/schedules.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tags:
1414
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!
1515
---
1616

17-
The pages shows how to do the following:
17+
This page shows how to do the following:
1818

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

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

33-
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
33+
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.
3434

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

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

docs/develop/typescript/set-up.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ If everything is working correctly, you should see:
318318
<summary><strong>Additional details about Workflow Execution</strong></summary>
319319

320320
- Temporal clients are not explicitly closed.
321-
- To enable TLS, the `tls` option can be set to `true` or a `Temporalio::Client::Connection::TLSOptions` instance.
321+
- 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.
322322
- Calling `client.workflow.start()` and `client.workflow.execute()` send a command to Temporal Server to schedule a new
323323
Workflow Execution on the specified Task Queue.
324324
- If you started a Workflow with `client.workflow.start()`, you can choose to wait for the result anytime with

docs/develop/typescript/temporal-client.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,7 @@ directly required and run by Workers in the Node.js environment.
676676
Workers are flexible. You can host any or all of your Workflows and Activities on a Worker, and you can host multiple
677677
Workers on a single machine.
678678

679-
The Worker need three main things:
679+
The Worker needs three main things:
680680

681681
- `taskQueue`: The Task Queue to poll. This is the only required argument.
682682
- `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
748748
### Set a Workflow Id {#workflow-id}
749749

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

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

docs/develop/typescript/temporal-nexus.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ A Service handler must provide Operation handlers for each Operation declared by
149149
Operation handlers can decide if a given Nexus Operation will be synchronous or asynchronous.
150150
They can execute arbitrary code, and invoke underlying Temporal primitives such as a Workflow, Query, Signal, or Update.
151151

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

154154
- `WorkflowRunOperationHandler` - Create an asynchronous operation handler that starts a Workflow.
155155
- `getClient()` - Get a Temporal Client connected using the same `NativeConnection` as the present Temporal Worker.

docs/develop/typescript/versioning.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Patching is a three-step process:
7070

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

7676
### Patching in new code

0 commit comments

Comments
 (0)