Skip to content

Commit 7b1f643

Browse files
committed
docs(typescript): clarify getProgram getter semantics; fix typos in README (its/TypeScript factory, below)
1 parent 3e774c7 commit 7b1f643

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

packages/typescript/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ Supported transformer factories:
142142

143143
- all **built-in** TypeScript custom transformer factories:
144144

145-
- `import('typescript').TransformerFactory` annotated **TransformerFactory** bellow
146-
- `import('typescript').CustomTransformerFactory` annotated **CustomTransformerFactory** bellow
145+
- `import('typescript').TransformerFactory` annotated **TransformerFactory** below
146+
- `import('typescript').CustomTransformerFactory` annotated **CustomTransformerFactory** below
147147

148148
- **ProgramTransformerFactory** represents a transformer factory allowing the resulting transformer to grab a reference to the **Program** instance
149149

150150
```js
151151
{
152152
type: 'program',
153-
// An optional `getProgram` getter may be provided. In non‑watch it returns
153+
// An optional `getProgram` getter is provided in all modes. In non‑watch it returns
154154
// the same Program as the first argument. In watch mode, when the
155155
// `recreateTransformersOnRebuild` option is enabled, the getter reflects the latest
156156
// Program across rebuilds; otherwise it refers to the initial Program.
@@ -189,7 +189,7 @@ typescript({
189189
{
190190
type: 'typeChecker',
191191
factory: (typeChecker) => {
192-
// Allow the transformer to get a TypeChecker reference in it's factory
192+
// Allow the transformer to get a TypeChecker reference in its factory
193193
return TypeCheckerRequiringTransformerFactory(typeChecker);
194194
}
195195
}
@@ -222,8 +222,8 @@ Supported transformer factories:
222222
223223
- all **built-in** TypeScript custom transformer factories:
224224
225-
- `import('typescript').TransformerFactory` annotated **TransformerFactory** bellow
226-
- `import('typescript').CustomTransformerFactory` annotated **CustomTransformerFactory** bellow
225+
- `import('typescript').TransformerFactory` annotated **TransformerFactory** below
226+
- `import('typescript').CustomTransformerFactory` annotated **CustomTransformerFactory** below
227227
228228
The example above could be written like this:
229229

0 commit comments

Comments
 (0)