Skip to content

Commit bd65c3d

Browse files
docs: automatically regenerate schema docs
1 parent ad17820 commit bd65c3d

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

plugins/node/readme.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@ plugins:
2727
Run a Node.js application for local development.
2828
#### Task options
2929

30-
| Property | Description | Type | Default |
31-
| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------- | :------------------ |
32-
| `entry` | path to the node application | `string` | `'./server/app.js'` |
33-
| `args` | additional arguments to pass to your application | `Array<string>` | |
34-
| `useDoppler` | whether to run the application with environment variables from Doppler | `boolean` | `true` |
35-
| `ports` | ports to try to bind to for this application. set to `false` for an entry point that wouldn't bind to a port, such as a worker process or one-off script. | `Array<number> \| false` | `[3001,3002,3003]` |
36-
| `watch` | run Node in watch mode, which restarts your application when the entrypoint or any imported files are changed. **nb** this option is experimental in versions of Node before v20.13. | `boolean` | |
30+
| Property | Description | Type | Default |
31+
| :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------- | :------------------ |
32+
| `entry` | path to the node application | `string` | `'./server/app.js'` |
33+
| `args` | additional arguments to pass to your application | `Array<string>` | |
34+
| `useDoppler` | whether to run the application with environment variables from Doppler | `boolean` | `true` |
35+
| `ports` | ports to try to bind to for this application. set to `false` for an entry point that wouldn't bind to a port, such as a worker process or one-off script. | `Array<number> \| false` | `[3001,3002,3003]` |
36+
| `watch` | run Node in watch mode, which restarts your application when the entrypoint or any imported files are changed. **nb** this option is experimental in versions of Node before v20.13. | `boolean` | |
37+
| `background` | run the Node process in the background, i.e. don't wait for it to exit before continuing to other Tool Kit tasks. set to `false` to wait for the process to exit, useful for running scripts or [multiple Tool Kit tasks in parallel](../parallel). | `boolean` | `true` |
3738

3839
_All properties are optional._
3940
<!-- end autogenerated docs -->

plugins/serverless/readme.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ plugins:
2727
Run serverless functions locally
2828
#### Task options
2929

30-
| Property | Description | Type | Default |
31-
| :----------- | :---------------------------------------------------------- | :-------------- | :----------------- |
32-
| `ports` | ports to try to bind to for this application | `Array<number>` | `[3001,3002,3003]` |
33-
| `useDoppler` | run the application with environment variables from Doppler | `boolean` | `true` |
30+
| Property | Description | Type | Default |
31+
| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | :----------------- |
32+
| `ports` | ports to try to bind to for this application | `Array<number>` | `[3001,3002,3003]` |
33+
| `useDoppler` | run the application with environment variables from Doppler | `boolean` | `true` |
34+
| `background` | run the `serverless oflfine` process in the background, i.e. don't wait for it to exit before continuing to other Tool Kit tasks. set to `false` to wait for the process to exit, useful for running [multiple Tool Kit tasks in parallel](../parallel). | `boolean` | `true` |
3435

3536
_All properties are optional._
3637

0 commit comments

Comments
 (0)