miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(misc): update typedoc (#22264)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2024-03-12 09:33:44 +01:00 committed by GitHub
parent 9520aa22d4
commit 5978e30d20
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/generated/devkit/CreateDependencies.md
View File

@ -2,6 +2,9 @@
Ƭ **CreateDependencies**\<`T`\>: (`options`: `T` \| `undefined`, `context`: [`CreateDependenciesContext`](../../devkit/documents/CreateDependenciesContext)) => [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
A function which parses files in the workspace to create dependencies in the [ProjectGraph](../../devkit/documents/ProjectGraph)
Use [validateDependency](../../devkit/documents/validateDependency) to validate dependencies
#### Type parameters
| Name | Type |
@ -12,9 +15,6 @@
▸ (`options`, `context`): [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
A function which parses files in the workspace to create dependencies in the [ProjectGraph](../../devkit/documents/ProjectGraph)
Use [validateDependency](../../devkit/documents/validateDependency) to validate dependencies
##### Parameters
| Name | Type |

6
docs/generated/devkit/CreateNodesFunction.md
View File

@ -2,6 +2,9 @@
Ƭ **CreateNodesFunction**\<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
A function which parses a configuration file into a set of nodes.
Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGraph)
#### Type parameters
| Name | Type |
@ -12,9 +15,6 @@
▸ (`projectConfigurationFile`, `options`, `context`): [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
A function which parses a configuration file into a set of nodes.
Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGraph)
##### Parameters
| Name | Type |

4
docs/generated/devkit/Executor.md
View File

@ -2,6 +2,8 @@
Ƭ **Executor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`\<\{ `success`: `boolean` }\> \| `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
Implementation of a target of a project
#### Type parameters
| Name | Type |
@ -12,8 +14,6 @@
▸ (`options`, `context`): `Promise`\<\{ `success`: `boolean` }\> \| `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
Implementation of a target of a project
##### Parameters
| Name | Type |

4
docs/generated/devkit/Generator.md
View File

@ -2,6 +2,8 @@
Ƭ **Generator**\<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
A function that schedules updates to the filesystem to be done atomically
#### Type parameters
| Name | Type |
@ -12,8 +14,6 @@
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
A function that schedules updates to the filesystem to be done atomically
##### Parameters
| Name | Type |

4
docs/generated/devkit/GeneratorCallback.md
View File

@ -2,12 +2,12 @@
Ƭ **GeneratorCallback**: () => `void` \| `Promise`\<`void`\>
A callback function that is executed after changes are made to the file system
#### Type declaration
▸ (): `void` \| `Promise`\<`void`\>
A callback function that is executed after changes are made to the file system
##### Returns
`void` \| `Promise`\<`void`\>

8
docs/generated/devkit/ProjectTargetConfigurator.md
View File

@ -2,6 +2,10 @@
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
**`Deprecated`**
Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 19
#### Type declaration
▸ (`file`): `Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
@ -15,7 +19,3 @@
##### Returns
`Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
**`Deprecated`**
Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 19

4
docs/generated/devkit/TaskGraphExecutor.md
View File

@ -2,6 +2,8 @@
Ƭ **TaskGraphExecutor**\<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/documents/TaskGraph), `options`: `Record`\<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`\<`BatchExecutorResult` \| `AsyncIterableIterator`\<`BatchExecutorTaskResult`\>\>
Implementation of a target of a project that handles multiple projects to be batched
#### Type parameters
| Name | Type |
@ -12,8 +14,6 @@
▸ (`taskGraph`, `options`, `overrides`, `context`): `Promise`\<`BatchExecutorResult` \| `AsyncIterableIterator`\<`BatchExecutorTaskResult`\>\>
Implementation of a target of a project that handles multiple projects to be batched
##### Parameters
| Name | Type |

3
docs/generated/devkit/defaultTasksRunner.md
View File

@ -2,9 +2,6 @@
▸ **defaultTasksRunner**(`tasks`, `options`, `context?`): `any`
`any | Promise<{ [id: string]: TaskStatus }>`
will change to Promise<{ [id: string]: TaskStatus }> after Nx 15 is released.
#### Parameters
| Name | Type |

2
package.json
View File

@ -281,7 +281,7 @@
"ts-node": "10.9.1",
"tsconfig-paths": "^4.1.2",
"tsconfig-paths-webpack-plugin": "4.0.0",
"typedoc": "0.25.4",
"typedoc": "0.25.12",
"typedoc-plugin-markdown": "3.17.1",
"typescript": "~5.3.2",
"unist-builder": "^4.0.0",

26
pnpm-lock.yaml generated
View File

@ -918,11 +918,11 @@ devDependencies:
specifier: 4.0.0
version: 4.0.0
typedoc:
specifier: 0.25.4
version: 0.25.4(typescript@5.3.3)
specifier: 0.25.12
version: 0.25.12(typescript@5.3.3)
typedoc-plugin-markdown:
specifier: 3.17.1
version: 3.17.1(typedoc@0.25.4)
version: 3.17.1(typedoc@0.25.12)
typescript:
specifier: ~5.3.2
version: 5.3.3
@ -22920,6 +22920,8 @@ packages:
peerDependenciesMeta:
webpack:
optional: true
webpack-sources:
optional: true
dependencies:
webpack: 5.88.0(@swc/core@1.3.86)(esbuild@0.19.5)
webpack-sources: 3.2.3
@ -22932,6 +22934,8 @@ packages:
peerDependenciesMeta:
webpack:
optional: true
webpack-sources:
optional: true
dependencies:
webpack: 5.90.1(@swc/core@1.3.86)(esbuild@0.20.0)
webpack-sources: 3.2.3
@ -29690,8 +29694,8 @@ packages:
rechoir: 0.6.2
dev: true
/shiki@0.14.1:
resolution: {integrity: sha512-+Jz4nBkCBe0mEDqo1eKRcCdjRtrCjozmcbTUjbPTX7OOJfEbTZzlUWlZtGe3Gb5oV1/jnojhG//YZc3rs9zSEw==}
/shiki@0.14.7:
resolution: {integrity: sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==}
dependencies:
ansi-sequence-parser: 1.1.0
jsonc-parser: 3.2.0
@ -31532,26 +31536,26 @@ packages:
resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==}
dev: true
/typedoc-plugin-markdown@3.17.1(typedoc@0.25.4):
/typedoc-plugin-markdown@3.17.1(typedoc@0.25.12):
resolution: {integrity: sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==}
peerDependencies:
typedoc: '>=0.24.0'
dependencies:
handlebars: 4.7.7
typedoc: 0.25.4(typescript@5.3.3)
typedoc: 0.25.12(typescript@5.3.3)
dev: true
/typedoc@0.25.4(typescript@5.3.3):
resolution: {integrity: sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==}
/typedoc@0.25.12(typescript@5.3.3):
resolution: {integrity: sha512-F+qhkK2VoTweDXd1c42GS/By2DvI2uDF4/EpG424dTexSHdtCH52C6IcAvMA6jR3DzAWZjHpUOW+E02kyPNUNw==}
engines: {node: '>= 16'}
hasBin: true
peerDependencies:
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x
dependencies:
lunr: 2.3.9
marked: 4.3.0
minimatch: 9.0.3
shiki: 0.14.1
shiki: 0.14.7
typescript: 5.3.3
dev: true