|
11 | 11 | [](https://standardjs.com) |
12 | 12 | [](https://github.com/prettier/prettier) |
13 | 13 |
|
14 | | -Perform async work synchronously in Node.js using `worker_threads` with first-class TypeScript support. |
| 14 | +Perform async work synchronously in Node.js using `worker_threads` with first-class TypeScript and Yarn P'n'P support. |
15 | 15 |
|
16 | 16 | ## TOC <!-- omit in toc --> |
17 | 17 |
|
@@ -111,18 +111,18 @@ export interface GlobalShim { |
111 | 111 |
|
112 | 112 | ### Options |
113 | 113 |
|
114 | | -1. `timeout` same as env `SYNCKIT_TIMEOUT` |
115 | | -2. `execArgv` same as env `SYNCKIT_EXEC_ARGV` |
116 | | -3. `tsRunner` same as env `SYNCKIT_TS_RUNNER` |
| 114 | +1. `execArgv` same as env `SYNCKIT_EXEC_ARGV` |
| 115 | +2. `globalShims`: Similar like env `SYNCKIT_GLOBAL_SHIMS` but much more flexible which can be a `GlobalShim` `Array`, see `GlobalShim`'s [definition](#types) for more details |
| 116 | +3. `timeout` same as env `SYNCKIT_TIMEOUT` |
117 | 117 | 4. `transferList`: Please refer Node.js [`worker_threads`](https://nodejs.org/api/worker_threads.html#:~:text=Default%3A%20true.-,transferList,-%3CObject%5B%5D%3E%20If) documentation |
118 | | -5. `globalShims`: Similar like env `SYNCKIT_GLOBAL_SHIMS` but much more flexible which can be a `GlobalShim` `Array`, see `GlobalShim`'s [definition](#types) for more details |
| 118 | +5. `tsRunner` same as env `SYNCKIT_TS_RUNNER` |
119 | 119 |
|
120 | 120 | ### Envs |
121 | 121 |
|
122 | | -1. `SYNCKIT_TIMEOUT`: `timeout` for performing the async job (no default) |
123 | | -2. `SYNCKIT_EXEC_ARGV`: List of node CLI options passed to the worker, split with comma `,`. (default as `[]`), see also [`node` docs](https://nodejs.org/api/worker_threads.html) |
124 | | -3. `SYNCKIT_TS_RUNNER`: Which TypeScript runner to be used, it could be very useful for development, could be `'ts-node' | 'esbuild-register' | 'esbuild-runner' | 'swc' | 'tsx'`, `'ts-node'` is used by default, make sure you have installed them already |
125 | | -4. `SYNCKIT_GLOBAL_SHIMS`: Whether to enable the default `DEFAULT_GLOBAL_SHIMS_PRESET` as `globalShims` |
| 122 | +1. `SYNCKIT_EXEC_ARGV`: List of node CLI options passed to the worker, split with comma `,`. (default as `[]`), see also [`node` docs](https://nodejs.org/api/worker_threads.html) |
| 123 | +2. `SYNCKIT_GLOBAL_SHIMS`: Whether to enable the default `DEFAULT_GLOBAL_SHIMS_PRESET` as `globalShims` |
| 124 | +3. `SYNCKIT_TIMEOUT`: `timeout` for performing the async job (no default) |
| 125 | +4. `SYNCKIT_TS_RUNNER`: Which TypeScript runner to be used, it could be very useful for development, could be `'ts-node' | 'esbuild-register' | 'esbuild-runner' | 'swc' | 'tsx'`, `'ts-node'` is used by default, make sure you have installed them already |
126 | 126 |
|
127 | 127 | ### TypeScript |
128 | 128 |
|
|
0 commit comments