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

docs(misc): update typedoc (#20603)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2023-12-13 16:49:46 +01:00 committed by GitHub
parent 593ea3d90d
commit 5befe533fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
61 changed files with 260 additions and 248 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,6 +1,6 @@
# Type alias: CreateDependencies<T\>
# Type alias: CreateDependencies\<T\>
Ƭ **CreateDependencies**<`T`\>: (`options`: `T` \| `undefined`, `context`: [`CreateDependenciesContext`](../../devkit/documents/CreateDependenciesContext)) => [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
Ƭ **CreateDependencies**\<`T`\>: (`options`: `T` \| `undefined`, `context`: [`CreateDependenciesContext`](../../devkit/documents/CreateDependenciesContext)) => [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
#### Type parameters
@ -10,7 +10,7 @@
#### Type declaration
▸ (`options`, `context`): [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
▸ (`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
@ -24,4 +24,4 @@ Use [validateDependency](../../devkit/documents/validateDependency) to validate
##### Returns
[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>

12
docs/generated/devkit/CreateDependenciesContext.md
View File

@ -6,18 +6,18 @@ Context for [CreateDependencies](../../devkit/documents/CreateDependencies)
### Properties
- [externalNodes](../../devkit/documents/CreateDependenciesContext#externalnodes): Record&lt;string, ProjectGraphExternalNode&gt;
- [externalNodes](../../devkit/documents/CreateDependenciesContext#externalnodes): Record<string, ProjectGraphExternalNode>
- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap): FileMap
- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess): FileMap
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [projects](../../devkit/documents/CreateDependenciesContext#projects): Record&lt;string, ProjectConfiguration&gt;
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projects](../../devkit/documents/CreateDependenciesContext#projects): Record<string, ProjectConfiguration>
- [workspaceRoot](../../devkit/documents/CreateDependenciesContext#workspaceroot): string
## Properties
### externalNodes
• `Readonly` **externalNodes**: `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Readonly` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
The external nodes that have been added to the graph.
@ -41,7 +41,7 @@ Files changes since last invocation
### nxJsonConfiguration
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
The `nx.json` configuration from the workspace
@ -49,7 +49,7 @@ The `nx.json` configuration from the workspace
### projects
• `Readonly` **projects**: `Record`<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
• `Readonly` **projects**: `Record`\<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
The configuration of each project in the workspace.

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

@ -1,6 +1,6 @@
# Type alias: CreateNodes<T\>
# Type alias: CreateNodes\<T\>
Ƭ **CreateNodes**<`T`\>: readonly [projectFilePattern: string, createNodesFunction: CreateNodesFunction<T\>]
Ƭ **CreateNodes**\<`T`\>: readonly [projectFilePattern: string, createNodesFunction: CreateNodesFunction\<T\>]
A pair of file patterns and [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)

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

@ -6,14 +6,14 @@ Context for [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
### Properties
- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot): string
## Properties
### nxJsonConfiguration
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
---

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

@ -1,6 +1,6 @@
# Type alias: CreateNodesFunction<T\>
# Type alias: CreateNodesFunction\<T\>
Ƭ **CreateNodesFunction**<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
Ƭ **CreateNodesFunction**\<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
#### Type parameters
@ -10,7 +10,7 @@
#### Type declaration
▸ (`projectConfigurationFile`, `options`, `context`): [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
▸ (`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)
@ -25,4 +25,4 @@ Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGra
##### Returns
[`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
[`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>

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

@ -4,14 +4,14 @@
### Properties
- [externalNodes](../../devkit/documents/CreateNodesResult#externalnodes): Record&lt;string, ProjectGraphExternalNode&gt;
- [projects](../../devkit/documents/CreateNodesResult#projects): Record&lt;string, Optional&lt;ProjectConfiguration, &quot;root&quot;&gt;&gt;
- [externalNodes](../../devkit/documents/CreateNodesResult#externalnodes): Record<string, ProjectGraphExternalNode>
- [projects](../../devkit/documents/CreateNodesResult#projects): Record<string, Optional<ProjectConfiguration, "root">>
## Properties
### externalNodes
• `Optional` **externalNodes**: `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
A map of external node name -> external node. External nodes do not have a root, so the key is their name.
@ -19,6 +19,6 @@ A map of external node name -> external node. External nodes do not have a root,
### projects
• `Optional` **projects**: `Record`<`string`, `Optional`<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\>
• `Optional` **projects**: `Record`\<`string`, `Optional`\<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\>
A map of project root -> project configuration

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

@ -1,10 +1,10 @@
# Type alias: CustomHasher
Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/Task), `context`: [`HasherContext`](../../devkit/documents/HasherContext)) => `Promise`<[`Hash`](../../devkit/documents/Hash)\>
Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/Task), `context`: [`HasherContext`](../../devkit/documents/HasherContext)) => `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
#### Type declaration
▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
▸ (`task`, `context`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
##### Parameters
@ -15,4 +15,4 @@
##### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)\>

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

@ -1,6 +1,6 @@
# Type alias: Executor<T\>
# Type alias: Executor\<T\>
Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
Ƭ **Executor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`\<\{ `success`: `boolean` }\> \| `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
#### Type parameters
@ -10,7 +10,7 @@
#### Type declaration
▸ (`options`, `context`): `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
▸ (`options`, `context`): `Promise`\<\{ `success`: `boolean` }\> \| `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
Implementation of a target of a project
@ -23,4 +23,4 @@ Implementation of a target of a project
##### Returns
`Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
`Promise`\<\{ `success`: `boolean` }\> \| `AsyncIterableIterator`\<\{ `success`: `boolean` }\>

12
docs/generated/devkit/ExecutorContext.md
View File

@ -9,15 +9,15 @@ Context that is passed into an executor
- [configurationName](../../devkit/documents/ExecutorContext#configurationname): string
- [cwd](../../devkit/documents/ExecutorContext#cwd): string
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose): boolean
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph): ProjectGraph
- [projectName](../../devkit/documents/ExecutorContext#projectname): string
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations): ProjectsConfigurations
- [root](../../devkit/documents/ExecutorContext#root): string
- [target](../../devkit/documents/ExecutorContext#target): TargetConfiguration&lt;any&gt;
- [target](../../devkit/documents/ExecutorContext#target): TargetConfiguration<any>
- [targetName](../../devkit/documents/ExecutorContext#targetname): string
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph): TaskGraph
- [workspace](../../devkit/documents/ExecutorContext#workspace): ProjectsConfigurations &amp; NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [workspace](../../devkit/documents/ExecutorContext#workspace): ProjectsConfigurations & NxJsonConfiguration<string[] | "\*">
## Properties
@ -47,7 +47,7 @@ Enable verbose logging
### nxJsonConfiguration
• `Optional` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• `Optional` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
The contents of nx.json.
@ -94,7 +94,7 @@ The root of the workspace
### target
• `Optional` **target**: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)<`any`\>
• `Optional` **target**: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\<`any`\>
The configuration of the target being executed
@ -119,7 +119,7 @@ it existed when the Nx command was kicked off
### workspace
• `Optional` **workspace**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• `Optional` **workspace**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
Deprecated. Use projectsConfigurations or nxJsonConfiguration
The full workspace configuration

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

@ -4,17 +4,17 @@
### Properties
- [builders](../../devkit/documents/ExecutorsJson#builders): Record&lt;string, ExecutorsJsonEntry&gt;
- [executors](../../devkit/documents/ExecutorsJson#executors): Record&lt;string, ExecutorsJsonEntry&gt;
- [builders](../../devkit/documents/ExecutorsJson#builders): Record<string, ExecutorsJsonEntry>
- [executors](../../devkit/documents/ExecutorsJson#executors): Record<string, ExecutorsJsonEntry>
## Properties
### builders
• `Optional` **builders**: `Record`<`string`, `ExecutorsJsonEntry`\>
• `Optional` **builders**: `Record`\<`string`, `ExecutorsJsonEntry`\>
---
### executors
• `Optional` **executors**: `Record`<`string`, `ExecutorsJsonEntry`\>
• `Optional` **executors**: `Record`\<`string`, `ExecutorsJsonEntry`\>

2
docs/generated/devkit/FileChange.md
View File

@ -9,7 +9,7 @@ Description of a file change in the Nx virtual file system/
- [content](../../devkit/documents/FileChange#content): Buffer
- [options](../../devkit/documents/FileChange#options): TreeWriteOptions
- [path](../../devkit/documents/FileChange#path): string
- [type](../../devkit/documents/FileChange#type): &quot;DELETE&quot; | &quot;CREATE&quot; | &quot;UPDATE&quot;
- [type](../../devkit/documents/FileChange#type): "DELETE" | "CREATE" | "UPDATE"
## Properties

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

@ -1,6 +1,6 @@
# Type alias: Generator<T\>
# Type alias: Generator\<T\>
Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
Ƭ **Generator**\<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
#### Type parameters
@ -10,7 +10,7 @@
#### Type declaration
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
▸ (`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
@ -23,4 +23,4 @@ A function that schedules updates to the filesystem to be done atomically
##### Returns
`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>

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

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

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

@ -5,8 +5,8 @@
### Properties
- [extends](../../devkit/documents/GeneratorsJson#extends): string
- [generators](../../devkit/documents/GeneratorsJson#generators): Record&lt;string, GeneratorsJsonEntry&gt;
- [schematics](../../devkit/documents/GeneratorsJson#schematics): Record&lt;string, GeneratorsJsonEntry&gt;
- [generators](../../devkit/documents/GeneratorsJson#generators): Record<string, GeneratorsJsonEntry>
- [schematics](../../devkit/documents/GeneratorsJson#schematics): Record<string, GeneratorsJsonEntry>
## Properties
@ -18,10 +18,10 @@
### generators
• `Optional` **generators**: `Record`<`string`, `GeneratorsJsonEntry`\>
• `Optional` **generators**: `Record`\<`string`, `GeneratorsJsonEntry`\>
---
### schematics
• `Optional` **schematics**: `Record`<`string`, `GeneratorsJsonEntry`\>
• `Optional` **schematics**: `Record`\<`string`, `GeneratorsJsonEntry`\>

12
docs/generated/devkit/Hash.md
View File

@ -17,12 +17,12 @@ A data structure returned by the default hasher.
#### Type declaration
| Name | Type |
| :-------------- | :---------------------------------- |
| `command` | `string` |
| `implicitDeps?` | { `[fileName: string]`: `string`; } |
| `nodes` | { `[name: string]`: `string`; } |
| `runtime?` | { `[input: string]`: `string`; } |
| Name | Type |
| :-------------- | :----------------------------------- |
| `command` | `string` |
| `implicitDeps?` | \{ `[fileName: string]`: `string`; } |
| `nodes` | \{ `[name: string]`: `string`; } |
| `runtime?` | \{ `[input: string]`: `string`; } |
---

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

@ -5,7 +5,7 @@
### Properties
- [hasher](../../devkit/documents/HasherContext#hasher): TaskHasher
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/HasherContext#projectgraph): ProjectGraph
- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations): ProjectsConfigurations
- [taskGraph](../../devkit/documents/HasherContext#taskgraph): TaskGraph
@ -20,7 +20,7 @@
### nxJsonConfiguration
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
---

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

@ -1,6 +1,6 @@
# Type alias: ImplicitDependencyEntry<T\>
# Type alias: ImplicitDependencyEntry\<T\>
Ƭ **ImplicitDependencyEntry**<`T`\>: `Object`
Ƭ **ImplicitDependencyEntry**\<`T`\>: `Object`
#### Type parameters
@ -10,4 +10,4 @@
#### Index signature
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)<`T`\>
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>

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

@ -1,4 +1,4 @@
# Interface: ImplicitJsonSubsetDependency<T\>
# Interface: ImplicitJsonSubsetDependency\<T\>
## Type parameters
@ -8,4 +8,4 @@
## Indexable
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)<`T`\>
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>

18
docs/generated/devkit/NxJsonConfiguration.md
View File

@ -1,4 +1,4 @@
# Interface: NxJsonConfiguration<T\>
# Interface: NxJsonConfiguration\<T\>
Nx.json configuration
@ -24,7 +24,7 @@ Nx.json configuration
- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
- [extends](../../devkit/documents/NxJsonConfiguration#extends): string
- [generators](../../devkit/documents/NxJsonConfiguration#generators): Object
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry&lt;T&gt;
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry<T>
- [installation](../../devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
- [nxCloudAccessToken](../../devkit/documents/NxJsonConfiguration#nxcloudaccesstoken): string
@ -32,7 +32,7 @@ Nx.json configuration
- [nxCloudUrl](../../devkit/documents/NxJsonConfiguration#nxcloudurl): string
- [parallel](../../devkit/documents/NxJsonConfiguration#parallel): number
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins): PluginConfiguration[]
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record&lt;string, Record&lt;string, unknown&gt;&gt;
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record<string, Record<string, unknown>>
- [release](../../devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
@ -111,19 +111,19 @@ Example:
#### Index signature
▪ [collectionName: `string`]: { `[generatorName: string]`: `any`; }
▪ [collectionName: `string`]: \{ `[generatorName: string]`: `any`; }
---
### implicitDependencies
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](../../devkit/documents/ImplicitDependencyEntry)<`T`\>
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](../../devkit/documents/ImplicitDependencyEntry)\<`T`\>
Map of files to projects that implicitly depend on them
**`Deprecated`**
use [namedInputs](../../devkit/documents/Workspace#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
use [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
---
@ -154,7 +154,7 @@ Named inputs targets can refer to reduce duplication
• `Optional` **nxCloudAccessToken**: `string`
If specified Nx will use nx-cloud by default with the given token.
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions)
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
---
@ -193,7 +193,7 @@ Plugins for extending the project graph
### pluginsConfig
• `Optional` **pluginsConfig**: `Record`<`string`, `Record`<`string`, `unknown`\>\>
• `Optional` **pluginsConfig**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>
Configuration for Nx Plugins
@ -223,7 +223,7 @@ Available Task Runners
#### Index signature
▪ [tasksRunnerName: `string`]: { `options?`: `any` ; `runner?`: `string` }
▪ [tasksRunnerName: `string`]: \{ `options?`: `any` ; `runner?`: `string` }
---

14
docs/generated/devkit/NxPluginV2.md
View File

@ -1,6 +1,6 @@
# Type alias: NxPluginV2<TOptions\>
# Type alias: NxPluginV2\<TOptions\>
Ƭ **NxPluginV2**<`TOptions`\>: `Object`
Ƭ **NxPluginV2**\<`TOptions`\>: `Object`
A plugin for Nx which creates nodes and dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph)
@ -12,8 +12,8 @@ A plugin for Nx which creates nodes and dependencies for the [ProjectGraph](../.
#### Type declaration
| Name | Type | Description |
| :-------------------- | :----------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| `createDependencies?` | [`CreateDependencies`](../../devkit/documents/CreateDependencies)<`TOptions`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph) |
| `createNodes?` | [`CreateNodes`](../../devkit/documents/CreateNodes) | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFile } |
| `name` | `string` | - |
| Name | Type | Description |
| :-------------------- | :------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| `createDependencies?` | [`CreateDependencies`](../../devkit/documents/CreateDependencies)\<`TOptions`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph) |
| `createNodes?` | [`CreateNodes`](../../devkit/documents/CreateNodes) | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFile } |
| `name` | `string` | - |

2
docs/generated/devkit/PluginConfiguration.md
View File

@ -1,3 +1,3 @@
# Type alias: PluginConfiguration
Ƭ **PluginConfiguration**: `string` \| { `options?`: `unknown` ; `plugin`: `string` }
Ƭ **PluginConfiguration**: `string` \| \{ `options?`: `unknown` ; `plugin`: `string` }

2
docs/generated/devkit/ProjectConfiguration.md
View File

@ -40,7 +40,7 @@ Example:
#### Index signature
▪ [collectionName: `string`]: { `[generatorName: string]`: `any`; }
▪ [collectionName: `string`]: \{ `[generatorName: string]`: `any`; }
---

12
docs/generated/devkit/ProjectGraph.md
View File

@ -6,28 +6,28 @@ A Graph of projects in the workspace and dependencies between them
### Properties
- [dependencies](../../devkit/documents/ProjectGraph#dependencies): Record&lt;string, ProjectGraphDependency[]&gt;
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes): Record&lt;string, ProjectGraphExternalNode&gt;
- [nodes](../../devkit/documents/ProjectGraph#nodes): Record&lt;string, ProjectGraphProjectNode&gt;
- [dependencies](../../devkit/documents/ProjectGraph#dependencies): Record<string, ProjectGraphDependency[]>
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes): Record<string, ProjectGraphExternalNode>
- [nodes](../../devkit/documents/ProjectGraph#nodes): Record<string, ProjectGraphProjectNode>
- [version](../../devkit/documents/ProjectGraph#version): string
## Properties
### dependencies
• **dependencies**: `Record`<`string`, [`ProjectGraphDependency`](../../devkit/documents/ProjectGraphDependency)[]\>
• **dependencies**: `Record`\<`string`, [`ProjectGraphDependency`](../../devkit/documents/ProjectGraphDependency)[]\>
---
### externalNodes
• `Optional` **externalNodes**: `Record`<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
---
### nodes
• **nodes**: `Record`<`string`, [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode)\>
• **nodes**: `Record`\<`string`, [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode)\>
---

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

@ -36,7 +36,7 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
### constructor
• **new ProjectGraphBuilder**(`graph?`, `projectFileMap?`, `nonProjectFiles?`)
• **new ProjectGraphBuilder**(`graph?`, `projectFileMap?`, `nonProjectFiles?`): [`ProjectGraphBuilder`](../../devkit/documents/ProjectGraphBuilder)
#### Parameters
@ -46,6 +46,10 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
| `projectFileMap?` | [`ProjectFileMap`](../../devkit/documents/ProjectFileMap) |
| `nonProjectFiles?` | [`FileData`](../../devkit/documents/FileData)[] |
#### Returns
[`ProjectGraphBuilder`](../../devkit/documents/ProjectGraphBuilder)
## Properties
### graph
@ -60,7 +64,7 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
#### Index signature
▪ [source: `string`]: `Set`<`string`\>
▪ [source: `string`]: `Set`\<`string`\>
## Methods

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

@ -14,8 +14,8 @@ while allowing tracking of the full tree of different nested versions
### Properties
- [data](../../devkit/documents/ProjectGraphExternalNode#data): Object
- [name](../../devkit/documents/ProjectGraphExternalNode#name): &#x60;npm:${string}&#x60;
- [type](../../devkit/documents/ProjectGraphExternalNode#type): &quot;npm&quot;
- [name](../../devkit/documents/ProjectGraphExternalNode#name): `npm:${string}`
- [type](../../devkit/documents/ProjectGraphExternalNode#type): "npm"
## Properties
@ -35,7 +35,7 @@ while allowing tracking of the full tree of different nested versions
### name
• **name**: \`npm:${string}\`
• **name**: \`npm:$\{string}\`
---

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

@ -12,7 +12,7 @@ The ProjectGraphProcessor is deprecated. This will be removed in Nx 18.
- [fileMap](../../devkit/documents/ProjectGraphProcessorContext#filemap): ProjectFileMap
- [filesToProcess](../../devkit/documents/ProjectGraphProcessorContext#filestoprocess): ProjectFileMap
- [nxJsonConfiguration](../../devkit/documents/ProjectGraphProcessorContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
- [nxJsonConfiguration](../../devkit/documents/ProjectGraphProcessorContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectsConfigurations](../../devkit/documents/ProjectGraphProcessorContext#projectsconfigurations): ProjectsConfigurations
- [workspace](../../devkit/documents/ProjectGraphProcessorContext#workspace): Workspace
@ -36,7 +36,7 @@ Files changes since last invocation
### nxJsonConfiguration
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
---

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

@ -6,15 +6,15 @@ A node describing a project in a workspace
### Properties
- [data](../../devkit/documents/ProjectGraphProjectNode#data): ProjectConfiguration &amp; Object
- [data](../../devkit/documents/ProjectGraphProjectNode#data): ProjectConfiguration & Object
- [name](../../devkit/documents/ProjectGraphProjectNode#name): string
- [type](../../devkit/documents/ProjectGraphProjectNode#type): &quot;app&quot; | &quot;e2e&quot; | &quot;lib&quot;
- [type](../../devkit/documents/ProjectGraphProjectNode#type): "app" | "e2e" | "lib"
## Properties
### data
• **data**: [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration) & { `description?`: `string` }
• **data**: [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration) & \{ `description?`: `string` }
Additional metadata about a project

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

@ -1,10 +1,10 @@
# Type alias: ProjectTargetConfigurator
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
#### Type declaration
▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
▸ (`file`): `Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
##### Parameters
@ -14,7 +14,7 @@
##### Returns
`Record`<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
`Record`\<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
**`Deprecated`**

12
docs/generated/devkit/RemoteCache.md
View File

@ -11,11 +11,11 @@
### retrieve
• **retrieve**: (`hash`: `string`, `cacheDirectory`: `string`) => `Promise`<`boolean`\>
• **retrieve**: (`hash`: `string`, `cacheDirectory`: `string`) => `Promise`\<`boolean`\>
#### Type declaration
▸ (`hash`, `cacheDirectory`): `Promise`<`boolean`\>
▸ (`hash`, `cacheDirectory`): `Promise`\<`boolean`\>
##### Parameters
@ -26,17 +26,17 @@
##### Returns
`Promise`<`boolean`\>
`Promise`\<`boolean`\>
---
### store
• **store**: (`hash`: `string`, `cacheDirectory`: `string`) => `Promise`<`boolean`\>
• **store**: (`hash`: `string`, `cacheDirectory`: `string`) => `Promise`\<`boolean`\>
#### Type declaration
▸ (`hash`, `cacheDirectory`): `Promise`<`boolean`\>
▸ (`hash`, `cacheDirectory`): `Promise`\<`boolean`\>
##### Parameters
@ -47,4 +47,4 @@
##### Returns
`Promise`<`boolean`\>
`Promise`\<`boolean`\>

2
docs/generated/devkit/TargetConfiguration.md
View File

@ -1,4 +1,4 @@
# Interface: TargetConfiguration<T\>
# Interface: TargetConfiguration\<T\>
Target's configuration

2
docs/generated/devkit/TargetDefaults.md
View File

@ -1,3 +1,3 @@
# Type alias: TargetDefaults
Ƭ **TargetDefaults**: `Record`<`string`, `Partial`<[`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>\>
Ƭ **TargetDefaults**: `Record`\<`string`, `Partial`\<[`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>\>

2
docs/generated/devkit/TargetDependencyConfig.md
View File

@ -5,7 +5,7 @@
### Properties
- [dependencies](../../devkit/documents/TargetDependencyConfig#dependencies): boolean
- [params](../../devkit/documents/TargetDependencyConfig#params): &quot;ignore&quot; | &quot;forward&quot;
- [params](../../devkit/documents/TargetDependencyConfig#params): "ignore" | "forward"
- [projects](../../devkit/documents/TargetDependencyConfig#projects): string | string[]
- [target](../../devkit/documents/TargetDependencyConfig#target): string

12
docs/generated/devkit/Task.md
View File

@ -51,12 +51,12 @@ Details about the composition of the hash
#### Type declaration
| Name | Type | Description |
| :-------------- | :---------------------------------- | :------------------------------------------------------------- |
| `command` | `string` | Command of the task |
| `implicitDeps?` | { `[fileName: string]`: `string`; } | Hashes of implicit dependencies which are included in the hash |
| `nodes` | { `[name: string]`: `string`; } | Hashes of inputs used in the hash |
| `runtime?` | { `[input: string]`: `string`; } | Hash of the runtime environment which the task was executed |
| Name | Type | Description |
| :-------------- | :----------------------------------- | :------------------------------------------------------------- |
| `command` | `string` | Command of the task |
| `implicitDeps?` | \{ `[fileName: string]`: `string`; } | Hashes of implicit dependencies which are included in the hash |
| `nodes` | \{ `[name: string]`: `string`; } | Hashes of inputs used in the hash |
| `runtime?` | \{ `[input: string]`: `string`; } | Hash of the runtime environment which the task was executed |
---

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

@ -6,15 +6,15 @@ Graph of Tasks to be executed
### Properties
- [dependencies](../../devkit/documents/TaskGraph#dependencies): Record&lt;string, string[]&gt;
- [dependencies](../../devkit/documents/TaskGraph#dependencies): Record<string, string[]>
- [roots](../../devkit/documents/TaskGraph#roots): string[]
- [tasks](../../devkit/documents/TaskGraph#tasks): Record&lt;string, Task&gt;
- [tasks](../../devkit/documents/TaskGraph#tasks): Record<string, Task>
## Properties
### dependencies
• **dependencies**: `Record`<`string`, `string`[]\>
• **dependencies**: `Record`\<`string`, `string`[]\>
Map of Task IDs to IDs of tasks which the task depends on
@ -30,6 +30,6 @@ IDs of Tasks which do not have any dependencies and are thus ready to execute im
### tasks
• **tasks**: `Record`<`string`, [`Task`](../../devkit/documents/Task)\>
• **tasks**: `Record`\<`string`, [`Task`](../../devkit/documents/Task)\>
Map of Task IDs to Tasks

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

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

24
docs/generated/devkit/TaskHasher.md
View File

@ -11,7 +11,7 @@
### hashTask
▸ **hashTask**(`task`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
▸ **hashTask**(`task`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
#### Parameters
@ -21,13 +21,13 @@
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)\>
**`Deprecated`**
use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
▸ **hashTask**(`task`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
▸ **hashTask**(`task`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
#### Parameters
@ -38,13 +38,13 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)\>
**`Deprecated`**
use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
▸ **hashTask**(`task`, `taskGraph`, `env`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
▸ **hashTask**(`task`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
#### Parameters
@ -56,13 +56,13 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)\>
---
### hashTasks
▸ **hashTasks**(`tasks`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
▸ **hashTasks**(`tasks`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
#### Parameters
@ -72,13 +72,13 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
**`Deprecated`**
use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
#### Parameters
@ -89,13 +89,13 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
**`Deprecated`**
use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
▸ **hashTasks**(`tasks`, `taskGraph`, `env`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
▸ **hashTasks**(`tasks`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
#### Parameters
@ -107,4 +107,4 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
#### Returns
`Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
`Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>

20
docs/generated/devkit/Workspace.md
View File

@ -22,7 +22,7 @@ use ProjectsConfigurations or NxJsonConfiguration
- [defaultProject](../../devkit/documents/Workspace#defaultproject): string
- [extends](../../devkit/documents/Workspace#extends): string
- [generators](../../devkit/documents/Workspace#generators): Object
- [implicitDependencies](../../devkit/documents/Workspace#implicitdependencies): ImplicitDependencyEntry&lt;string[] | &quot;\*&quot;&gt;
- [implicitDependencies](../../devkit/documents/Workspace#implicitdependencies): ImplicitDependencyEntry<string[] | "\*">
- [installation](../../devkit/documents/Workspace#installation): NxInstallationConfiguration
- [namedInputs](../../devkit/documents/Workspace#namedinputs): Object
- [nxCloudAccessToken](../../devkit/documents/Workspace#nxcloudaccesstoken): string
@ -30,8 +30,8 @@ use ProjectsConfigurations or NxJsonConfiguration
- [nxCloudUrl](../../devkit/documents/Workspace#nxcloudurl): string
- [parallel](../../devkit/documents/Workspace#parallel): number
- [plugins](../../devkit/documents/Workspace#plugins): PluginConfiguration[]
- [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record&lt;string, Record&lt;string, unknown&gt;&gt;
- [projects](../../devkit/documents/Workspace#projects): Record&lt;string, ProjectConfiguration&gt;
- [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record<string, Record<string, unknown>>
- [projects](../../devkit/documents/Workspace#projects): Record<string, ProjectConfiguration>
- [release](../../devkit/documents/Workspace#release): NxReleaseConfiguration
- [targetDefaults](../../devkit/documents/Workspace#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
@ -131,7 +131,7 @@ Example:
#### Index signature
▪ [collectionName: `string`]: { `[generatorName: string]`: `any`; }
▪ [collectionName: `string`]: \{ `[generatorName: string]`: `any`; }
#### Inherited from
@ -141,13 +141,13 @@ Example:
### implicitDependencies
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](../../devkit/documents/ImplicitDependencyEntry)<`string`[] \| `"*"`\>
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](../../devkit/documents/ImplicitDependencyEntry)\<`string`[] \| `"*"`\>
Map of files to projects that implicitly depend on them
**`Deprecated`**
use [namedInputs](../../devkit/documents/Workspace#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
use [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
#### Inherited from
@ -190,7 +190,7 @@ Named inputs targets can refer to reduce duplication
• `Optional` **nxCloudAccessToken**: `string`
If specified Nx will use nx-cloud by default with the given token.
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions)
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
#### Inherited from
@ -249,7 +249,7 @@ Plugins for extending the project graph
### pluginsConfig
• `Optional` **pluginsConfig**: `Record`<`string`, `Record`<`string`, `unknown`\>\>
• `Optional` **pluginsConfig**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>
Configuration for Nx Plugins
@ -261,7 +261,7 @@ Configuration for Nx Plugins
### projects
• **projects**: `Record`<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
• **projects**: `Record`\<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
Projects' projects
@ -303,7 +303,7 @@ Available Task Runners
#### Index signature
▪ [tasksRunnerName: `string`]: { `options?`: `any` ; `runner?`: `string` }
▪ [tasksRunnerName: `string`]: \{ `options?`: `any` ; `runner?`: `string` }
#### Inherited from

10
docs/generated/devkit/Workspaces.md
View File

@ -18,7 +18,7 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
### constructor
• **new Workspaces**(`root`)
• **new Workspaces**(`root`): [`Workspaces`](../../devkit/documents/Workspaces)
#### Parameters
@ -26,15 +26,19 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
| :----- | :------- |
| `root` | `string` |
#### Returns
[`Workspaces`](../../devkit/documents/Workspaces)
## Methods
### readWorkspaceConfiguration
▸ **readWorkspaceConfiguration**(): [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
▸ **readWorkspaceConfiguration**(): [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
#### Returns
[`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
[`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
**`Deprecated`**

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

@ -17,8 +17,8 @@ This will **add** `react` and `jest` to the dependencies and devDependencies sec
| Name | Type | Description |
| :----------------- | :------------------------------------ | :---------------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) | Tree representing file system to modify |
| `dependencies` | `Record`<`string`, `string`\> | Dependencies to be added to the dependencies section of package.json |
| `devDependencies` | `Record`<`string`, `string`\> | Dependencies to be added to the devDependencies section of package.json |
| `dependencies` | `Record`\<`string`, `string`\> | Dependencies to be added to the dependencies section of package.json |
| `devDependencies` | `Record`\<`string`, `string`\> | Dependencies to be added to the devDependencies section of package.json |
| `packageJsonPath?` | `string` | Path to package.json |
#### Returns

16
docs/generated/devkit/convertNxGenerator.md
View File

@ -1,6 +1,6 @@
# Function: convertNxGenerator
▸ **convertNxGenerator**<`T`\>(`generator`, `skipWritingConfigInOldFormat?`): (`generatorOptions`: `T`) => (`tree`: `any`, `context`: `any`) => `Promise`<`any`\>
▸ **convertNxGenerator**\<`T`\>(`generator`, `skipWritingConfigInOldFormat?`): (`generatorOptions`: `T`) => (`tree`: `any`, `context`: `any`) => `Promise`\<`any`\>
Convert an Nx Generator into an Angular Devkit Schematic.
@ -12,16 +12,16 @@ Convert an Nx Generator into an Angular Devkit Schematic.
#### Parameters
| Name | Type | Description |
| :------------------------------ | :---------------------------------------------------- | :---------------------------------------------------------- |
| `generator` | [`Generator`](../../devkit/documents/Generator)<`T`\> | The Nx generator to convert to an Angular Devkit Schematic. |
| `skipWritingConfigInOldFormat?` | `boolean` | - |
| Name | Type | Description |
| :------------------------------ | :----------------------------------------------------- | :---------------------------------------------------------- |
| `generator` | [`Generator`](../../devkit/documents/Generator)\<`T`\> | The Nx generator to convert to an Angular Devkit Schematic. |
| `skipWritingConfigInOldFormat?` | `boolean` | - |
#### Returns
`fn`
▸ (`generatorOptions`): (`tree`: `any`, `context`: `any`) => `Promise`<`any`\>
▸ (`generatorOptions`): (`tree`: `any`, `context`: `any`) => `Promise`\<`any`\>
##### Parameters
@ -33,7 +33,7 @@ Convert an Nx Generator into an Angular Devkit Schematic.
`fn`
▸ (`tree`, `context`): `Promise`<`any`\>
▸ (`tree`, `context`): `Promise`\<`any`\>
##### Parameters
@ -44,4 +44,4 @@ Convert an Nx Generator into an Angular Devkit Schematic.
##### Returns
`Promise`<`any`\>
`Promise`\<`any`\>

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

@ -1,6 +1,6 @@
# Function: createProjectFileMapUsingProjectGraph
▸ **createProjectFileMapUsingProjectGraph**(`graph`): `Promise`<[`ProjectFileMap`](../../devkit/documents/ProjectFileMap)\>
▸ **createProjectFileMapUsingProjectGraph**(`graph`): `Promise`\<[`ProjectFileMap`](../../devkit/documents/ProjectFileMap)\>
#### Parameters
@ -10,4 +10,4 @@
#### Returns
`Promise`<[`ProjectFileMap`](../../devkit/documents/ProjectFileMap)\>
`Promise`\<[`ProjectFileMap`](../../devkit/documents/ProjectFileMap)\>

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

@ -1,6 +1,6 @@
# Function: createProjectGraphAsync
▸ **createProjectGraphAsync**(`opts?`): `Promise`<[`ProjectGraph`](../../devkit/documents/ProjectGraph)\>
▸ **createProjectGraphAsync**(`opts?`): `Promise`\<[`ProjectGraph`](../../devkit/documents/ProjectGraph)\>
Computes and returns a ProjectGraph.
@ -34,4 +34,4 @@ stored in the daemon process. To reset both run: `nx reset`.
#### Returns
`Promise`<[`ProjectGraph`](../../devkit/documents/ProjectGraph)\>
`Promise`\<[`ProjectGraph`](../../devkit/documents/ProjectGraph)\>

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

@ -7,19 +7,19 @@ will change to Promise<{ [id: string]: TaskStatus }> after Nx 15 is released.
#### Parameters
| Name | Type |
| :--------------------------- | :---------------------------------------------------------------------------------------- |
| `tasks` | [`Task`](../../devkit/documents/Task)[] |
| `options` | [`DefaultTasksRunnerOptions`](../../devkit/documents/DefaultTasksRunnerOptions) |
| `context?` | `Object` |
| `context.daemon?` | `DaemonClient` |
| `context.hasher?` | [`TaskHasher`](../../devkit/documents/TaskHasher) |
| `context.initiatingProject?` | `string` |
| `context.nxArgs` | `NxArgs` |
| `context.nxJson` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\> |
| `context.projectGraph` | [`ProjectGraph`](../../devkit/documents/ProjectGraph) |
| `context.target?` | `string` |
| `context.taskGraph?` | [`TaskGraph`](../../devkit/documents/TaskGraph) |
| Name | Type |
| :--------------------------- | :----------------------------------------------------------------------------------------- |
| `tasks` | [`Task`](../../devkit/documents/Task)[] |
| `options` | [`DefaultTasksRunnerOptions`](../../devkit/documents/DefaultTasksRunnerOptions) |
| `context?` | `Object` |
| `context.daemon?` | `DaemonClient` |
| `context.hasher?` | [`TaskHasher`](../../devkit/documents/TaskHasher) |
| `context.initiatingProject?` | `string` |
| `context.nxArgs` | `NxArgs` |
| `context.nxJson` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\> |
| `context.projectGraph` | [`ProjectGraph`](../../devkit/documents/ProjectGraph) |
| `context.target?` | `string` |
| `context.taskGraph?` | [`TaskGraph`](../../devkit/documents/TaskGraph) |
#### Returns

2
docs/generated/devkit/ensurePackage.md
View File

@ -33,7 +33,7 @@ This install the @nx/jest@<nxVersion> and return the module
When running with --dryRun, the function will throw when dependencies are missing.
Returns null for ESM dependencies. Import them with a dynamic import instead.
▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T`
▸ **ensurePackage**\<`T`\>(`pkg`, `version`): `T`
Ensure that dependencies and devDependencies from package.json are installed at the required versions.
Returns null for ESM dependencies. Import them with a dynamic import instead.

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

@ -1,6 +1,6 @@
# Function: formatFiles
▸ **formatFiles**(`tree`): `Promise`<`void`\>
▸ **formatFiles**(`tree`): `Promise`\<`void`\>
Formats all the created or updated files using Prettier
@ -12,4 +12,4 @@ Formats all the created or updated files using Prettier
#### Returns
`Promise`<`void`\>
`Promise`\<`void`\>

10
docs/generated/devkit/getOutputsForTargetAndConfiguration.md
View File

@ -23,11 +23,11 @@ Returns the list of outputs that will be cached.
#### Parameters
| Name | Type |
| :---------- | :----------------------------------------------------------------------------------------------------------------- |
| `target` | [`Task`](../../devkit/documents/Task) \| { `configuration?`: `string` ; `project`: `string` ; `target`: `string` } |
| `overrides` | `any` |
| `node` | [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode) |
| Name | Type |
| :---------- | :------------------------------------------------------------------------------------------------------------------ |
| `target` | [`Task`](../../devkit/documents/Task) \| \{ `configuration?`: `string` ; `project`: `string` ; `target`: `string` } |
| `overrides` | `any` |
| `node` | [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode) |
#### Returns

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

@ -1,6 +1,6 @@
# Function: getProjects
▸ **getProjects**(`tree`): `Map`<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
▸ **getProjects**(`tree`): `Map`\<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
Get a map of all projects in a workspace.
@ -14,4 +14,4 @@ Use [readProjectConfiguration](../../devkit/documents/readProjectConfiguration)
#### Returns
`Map`<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
`Map`\<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>

68
docs/generated/devkit/ngcli_adapter/NxScopedHost.md
View File

@ -2,7 +2,7 @@
## Hierarchy
- `ScopedHost`<`any`\>
- `ScopedHost`\<`any`\>
↳ **`NxScopedHost`**
@ -14,7 +14,7 @@
### Properties
- [\_delegate](../../devkit/documents/ngcli_adapter/NxScopedHost#_delegate): Host&lt;any&gt;
- [\_delegate](../../devkit/documents/ngcli_adapter/NxScopedHost#_delegate): Host<any>
- [\_root](../../devkit/documents/ngcli_adapter/NxScopedHost#_root): Path
- [root](../../devkit/documents/ngcli_adapter/NxScopedHost#root): string
@ -44,7 +44,7 @@
### constructor
• **new NxScopedHost**(`root`)
• **new NxScopedHost**(`root`): [`NxScopedHost`](../../devkit/documents/ngcli_adapter/NxScopedHost)
#### Parameters
@ -52,15 +52,19 @@
| :----- | :------- |
| `root` | `string` |
#### Returns
[`NxScopedHost`](../../devkit/documents/ngcli_adapter/NxScopedHost)
#### Overrides
virtualFs.ScopedHost&lt;any\&gt;.constructor
virtualFs.ScopedHost\&lt;any\&gt;.constructor
## Properties
### \_delegate
• `Protected` **\_delegate**: `Host`<`any`\>
• `Protected` **\_delegate**: `Host`\<`any`\>
#### Inherited from
@ -100,7 +104,7 @@ virtualFs.ScopedHost.capabilities
### \_resolve
▸ `Protected` **\_resolve**(`path`): `Path`
▸ **\_resolve**(`path`): `Path`
#### Parameters
@ -120,7 +124,7 @@ virtualFs.ScopedHost.\_resolve
### delete
▸ **delete**(`path`): `Observable`<`void`\>
▸ **delete**(`path`): `Observable`\<`void`\>
#### Parameters
@ -130,7 +134,7 @@ virtualFs.ScopedHost.\_resolve
#### Returns
`Observable`<`void`\>
`Observable`\<`void`\>
#### Inherited from
@ -140,7 +144,7 @@ virtualFs.ScopedHost.delete
### exists
▸ **exists**(`path`): `Observable`<`boolean`\>
▸ **exists**(`path`): `Observable`\<`boolean`\>
#### Parameters
@ -150,7 +154,7 @@ virtualFs.ScopedHost.delete
#### Returns
`Observable`<`boolean`\>
`Observable`\<`boolean`\>
#### Overrides
@ -160,7 +164,7 @@ virtualFs.ScopedHost.exists
### isDirectory
▸ **isDirectory**(`path`): `Observable`<`boolean`\>
▸ **isDirectory**(`path`): `Observable`\<`boolean`\>
#### Parameters
@ -170,7 +174,7 @@ virtualFs.ScopedHost.exists
#### Returns
`Observable`<`boolean`\>
`Observable`\<`boolean`\>
#### Inherited from
@ -180,7 +184,7 @@ virtualFs.ScopedHost.isDirectory
### isFile
▸ **isFile**(`path`): `Observable`<`boolean`\>
▸ **isFile**(`path`): `Observable`\<`boolean`\>
#### Parameters
@ -190,7 +194,7 @@ virtualFs.ScopedHost.isDirectory
#### Returns
`Observable`<`boolean`\>
`Observable`\<`boolean`\>
#### Overrides
@ -200,7 +204,7 @@ virtualFs.ScopedHost.isFile
### list
▸ **list**(`path`): `Observable`<`PathFragment`[]\>
▸ **list**(`path`): `Observable`\<`PathFragment`[]\>
#### Parameters
@ -210,7 +214,7 @@ virtualFs.ScopedHost.isFile
#### Returns
`Observable`<`PathFragment`[]\>
`Observable`\<`PathFragment`[]\>
#### Inherited from
@ -238,7 +242,7 @@ virtualFs.ScopedHost.list
### read
▸ **read**(`path`): `Observable`<`ArrayBuffer`\>
▸ **read**(`path`): `Observable`\<`ArrayBuffer`\>
#### Parameters
@ -248,7 +252,7 @@ virtualFs.ScopedHost.list
#### Returns
`Observable`<`ArrayBuffer`\>
`Observable`\<`ArrayBuffer`\>
#### Overrides
@ -258,17 +262,17 @@ virtualFs.ScopedHost.read
### readExistingAngularJson
▸ **readExistingAngularJson**(): `Observable`<`any`\>
▸ **readExistingAngularJson**(): `Observable`\<`any`\>
#### Returns
`Observable`<`any`\>
`Observable`\<`any`\>
---
### readJson
▸ `Private` **readJson**<`T`\>(`path`): `Observable`<`T`\>
▸ **readJson**\<`T`\>(`path`): `Observable`\<`T`\>
#### Type parameters
@ -284,23 +288,23 @@ virtualFs.ScopedHost.read
#### Returns
`Observable`<`T`\>
`Observable`\<`T`\>
---
### readMergedWorkspaceConfiguration
▸ `Private` **readMergedWorkspaceConfiguration**(): `Observable`<`any`\>
▸ **readMergedWorkspaceConfiguration**(): `Observable`\<`any`\>
#### Returns
`Observable`<`any`\>
`Observable`\<`any`\>
---
### rename
▸ **rename**(`from`, `to`): `Observable`<`void`\>
▸ **rename**(`from`, `to`): `Observable`\<`void`\>
#### Parameters
@ -311,7 +315,7 @@ virtualFs.ScopedHost.read
#### Returns
`Observable`<`void`\>
`Observable`\<`void`\>
#### Inherited from
@ -321,7 +325,7 @@ virtualFs.ScopedHost.rename
### stat
▸ **stat**(`path`): `Observable`<`any`\>
▸ **stat**(`path`): `Observable`\<`any`\>
#### Parameters
@ -331,7 +335,7 @@ virtualFs.ScopedHost.rename
#### Returns
`Observable`<`any`\>
`Observable`\<`any`\>
#### Inherited from
@ -341,7 +345,7 @@ virtualFs.ScopedHost.stat
### watch
▸ **watch**(`path`, `options?`): `Observable`<`HostWatchEvent`\>
▸ **watch**(`path`, `options?`): `Observable`\<`HostWatchEvent`\>
#### Parameters
@ -352,7 +356,7 @@ virtualFs.ScopedHost.stat
#### Returns
`Observable`<`HostWatchEvent`\>
`Observable`\<`HostWatchEvent`\>
#### Inherited from
@ -362,7 +366,7 @@ virtualFs.ScopedHost.watch
### write
▸ **write**(`path`, `content`): `Observable`<`void`\>
▸ **write**(`path`, `content`): `Observable`\<`void`\>
#### Parameters
@ -373,7 +377,7 @@ virtualFs.ScopedHost.watch
#### Returns
`Observable`<`void`\>
`Observable`\<`void`\>
#### Overrides

6
docs/generated/devkit/ngcli_adapter/wrapAngularDevkitSchematic.md
View File

@ -1,6 +1,6 @@
# Function: wrapAngularDevkitSchematic
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: `Tree`, `generatorOptions`: { `[k: string]`: `any`; }) => `Promise`<`any`\>
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: `Tree`, `generatorOptions`: \{ `[k: string]`: `any`; }) => `Promise`\<`any`\>
#### Parameters
@ -13,7 +13,7 @@
`fn`
▸ (`host`, `generatorOptions`): `Promise`<`any`\>
▸ (`host`, `generatorOptions`): `Promise`\<`any`\>
##### Parameters
@ -24,4 +24,4 @@
##### Returns
`Promise`<`any`\>
`Promise`\<`any`\>

2
docs/generated/devkit/parseJson.md
View File

@ -1,6 +1,6 @@
# Function: parseJson
▸ **parseJson**<`T`\>(`input`, `options?`): `T`
▸ **parseJson**\<`T`\>(`input`, `options?`): `T`
Parses the given JSON string and returns the object the JSON content represents.
By default javascript-style comments and trailing commas are allowed.

2
docs/generated/devkit/readJson.md
View File

@ -1,6 +1,6 @@
# Function: readJson
▸ **readJson**<`T`\>(`tree`, `path`, `options?`): `T`
▸ **readJson**\<`T`\>(`tree`, `path`, `options?`): `T`
Reads a json file, removes all comments and parses JSON.

2
docs/generated/devkit/readJsonFile.md
View File

@ -1,6 +1,6 @@
# Function: readJsonFile
▸ **readJsonFile**<`T`\>(`path`, `options?`): `T`
▸ **readJsonFile**\<`T`\>(`path`, `options?`): `T`
Reads a JSON file and returns the object the JSON content represents.

2
docs/generated/devkit/readTargetOptions.md
View File

@ -1,6 +1,6 @@
# Function: readTargetOptions
▸ **readTargetOptions**<`T`\>(`«destructured»`, `context`): `T`
▸ **readTargetOptions**\<`T`\>(`«destructured»`, `context`): `T`
Reads and combines options for a given target.

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

@ -1,6 +1,6 @@
# Function: runExecutor
▸ **runExecutor**<`T`\>(`targetDescription`, `overrides`, `context`): `Promise`<`AsyncIterableIterator`<`T`\>\>
▸ **runExecutor**\<`T`\>(`targetDescription`, `overrides`, `context`): `Promise`\<`AsyncIterableIterator`\<`T`\>\>
Loads and invokes executor.
@ -46,4 +46,4 @@ Note that the return value is a promise of an iterator, so you need to await bef
#### Returns
`Promise`<`AsyncIterableIterator`<`T`\>\>
`Promise`\<`AsyncIterableIterator`\<`T`\>\>

2
docs/generated/devkit/serializeJson.md
View File

@ -1,6 +1,6 @@
# Function: serializeJson
▸ **serializeJson**<`T`\>(`input`, `options?`): `string`
▸ **serializeJson**\<`T`\>(`input`, `options?`): `string`
Serializes the given data to a JSON string.
By default the JSON string is formatted with a 2 space indentation to be easy readable.

2
docs/generated/devkit/updateJson.md
View File

@ -1,6 +1,6 @@
# Function: updateJson
▸ **updateJson**<`T`, `U`\>(`tree`, `path`, `updater`, `options?`): `void`
▸ **updateJson**\<`T`, `U`\>(`tree`, `path`, `updater`, `options?`): `void`
Updates a JSON value to the file system tree

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

@ -6,10 +6,10 @@ Update nx.json
#### Parameters
| Name | Type |
| :------- | :---------------------------------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) |
| `nxJson` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\> |
| Name | Type |
| :------- | :----------------------------------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) |
| `nxJson` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\> |
#### Returns

2
docs/generated/devkit/writeJson.md
View File

@ -1,6 +1,6 @@
# Function: writeJson
▸ **writeJson**<`T`\>(`tree`, `path`, `value`, `options?`): `void`
▸ **writeJson**\<`T`\>(`tree`, `path`, `value`, `options?`): `void`
Writes a JSON value to the file system tree

2
docs/generated/devkit/writeJsonFile.md
View File

@ -1,6 +1,6 @@
# Function: writeJsonFile
▸ **writeJsonFile**<`T`\>(`path`, `data`, `options?`): `void`
▸ **writeJsonFile**\<`T`\>(`path`, `data`, `options?`): `void`
Serializes the given data to JSON and writes it to a file.

4
package.json
View File

@ -277,8 +277,8 @@
"ts-node": "10.9.1",
"tsconfig-paths": "^4.1.2",
"tsconfig-paths-webpack-plugin": "4.0.0",
"typedoc": "0.25.1",
"typedoc-plugin-markdown": "3.16.0",
"typedoc": "0.25.4",
"typedoc-plugin-markdown": "3.17.1",
"typescript": "~5.2.2",
"unist-builder": "^4.0.0",
"unzipper": "^0.10.11",

20
pnpm-lock.yaml generated
View File

@ -906,11 +906,11 @@ devDependencies:
specifier: 4.0.0
version: 4.0.0
typedoc:
specifier: 0.25.1
version: 0.25.1(typescript@5.2.2)
specifier: 0.25.4
version: 0.25.4(typescript@5.2.2)
typedoc-plugin-markdown:
specifier: 3.16.0
version: 3.16.0(typedoc@0.25.1)
specifier: 3.17.1
version: 3.17.1(typedoc@0.25.4)
typescript:
specifier: ~5.2.2
version: 5.2.2
@ -26838,21 +26838,21 @@ packages:
resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==}
dev: true
/typedoc-plugin-markdown@3.16.0(typedoc@0.25.1):
resolution: {integrity: sha512-eeiC78fDNGFwemPIHiwRC+mEC7W5jwt3fceUev2gJ2nFnXpVHo8eRrpC9BLWZDee6ehnz/sPmNjizbXwpfaTBw==}
/typedoc-plugin-markdown@3.17.1(typedoc@0.25.4):
resolution: {integrity: sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==}
peerDependencies:
typedoc: '>=0.24.0'
dependencies:
handlebars: 4.7.7
typedoc: 0.25.1(typescript@5.2.2)
typedoc: 0.25.4(typescript@5.2.2)
dev: true
/typedoc@0.25.1(typescript@5.2.2):
resolution: {integrity: sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==}
/typedoc@0.25.4(typescript@5.2.2):
resolution: {integrity: sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==}
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
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
dependencies:
lunr: 2.3.9
marked: 4.3.0