Skip to content

Commit da2ca3a

Browse files
isaacplmannisaacplmann
authored
feat(nx-dev): split devkit reference page (#18536)
1 parent 0527925 commit da2ca3a

File tree

152 files changed

+5271
-5154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+5271
-5154
lines changed

‎docs/generated/devkit/AdditionalSharedConfig.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Type alias: AdditionalSharedConfig
2+
3+
Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/SharedLibraryConfig) })[]

‎docs/generated/devkit/ChangeType.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Enumeration: ChangeType
2+
3+
## Table of contents
4+
5+
### Enumeration Members
6+
7+
- [Delete](../../devkit/documents/ChangeType#delete)
8+
- [Insert](../../devkit/documents/ChangeType#insert)
9+
10+
## Enumeration Members
11+
12+
### Delete
13+
14+
• **Delete** = `"Delete"`
15+
16+
---
17+
18+
### Insert
19+
20+
• **Insert** = `"Insert"`

‎docs/generated/devkit/CustomHasher.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Type alias: CustomHasher
2+
3+
Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/Task), `context`: [`HasherContext`](../../devkit/documents/HasherContext)) => `Promise`<[`Hash`](../../devkit/documents/Hash)\>
4+
5+
#### Type declaration
6+
7+
▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
8+
9+
##### Parameters
10+
11+
| Name | Type |
12+
| :-------- | :------------------------------------------------------ |
13+
| `task` | [`Task`](../../devkit/documents/Task) |
14+
| `context` | [`HasherContext`](../../devkit/documents/HasherContext) |
15+
16+
##### Returns
17+
18+
`Promise`<[`Hash`](../../devkit/documents/Hash)\>

‎docs/generated/devkit/DefaultTasksRunnerOptions.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Interface: DefaultTasksRunnerOptions
2+
3+
## Table of contents
4+
5+
### Properties
6+
7+
- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory)
8+
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations)
9+
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets)
10+
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr)
11+
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle)
12+
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel)
13+
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache)
14+
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs)
15+
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache)
16+
17+
## Properties
18+
19+
### cacheDirectory
20+
21+
• `Optional` **cacheDirectory**: `string`
22+
23+
---
24+
25+
### cacheableOperations
26+
27+
• `Optional` **cacheableOperations**: `string`[]
28+
29+
---
30+
31+
### cacheableTargets
32+
33+
• `Optional` **cacheableTargets**: `string`[]
34+
35+
---
36+
37+
### captureStderr
38+
39+
• `Optional` **captureStderr**: `boolean`
40+
41+
---
42+
43+
### lifeCycle
44+
45+
• **lifeCycle**: `LifeCycle`
46+
47+
---
48+
49+
### parallel
50+
51+
• `Optional` **parallel**: `number`
52+
53+
---
54+
55+
### remoteCache
56+
57+
• `Optional` **remoteCache**: [`RemoteCache`](../../devkit/documents/RemoteCache)
58+
59+
---
60+
61+
### runtimeCacheInputs
62+
63+
• `Optional` **runtimeCacheInputs**: `string`[]
64+
65+
---
66+
67+
### skipNxCache
68+
69+
• `Optional` **skipNxCache**: `boolean`

‎docs/generated/devkit/DependencyType.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Enumeration: DependencyType
2+
3+
Type of dependency between projects
4+
5+
## Table of contents
6+
7+
### Enumeration Members
8+
9+
- [dynamic](../../devkit/documents/DependencyType#dynamic)
10+
- [implicit](../../devkit/documents/DependencyType#implicit)
11+
- [static](../../devkit/documents/DependencyType#static)
12+
13+
## Enumeration Members
14+
15+
### dynamic
16+
17+
• **dynamic** = `"dynamic"`
18+
19+
Dynamic dependencies are brought in by the module at run time
20+
21+
---
22+
23+
### implicit
24+
25+
• **implicit** = `"implicit"`
26+
27+
Implicit dependencies are inferred
28+
29+
---
30+
31+
### static
32+
33+
• **static** = `"static"`
34+
35+
Static dependencies are tied to the loading of the module

‎docs/generated/devkit/Executor.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Type alias: Executor<T\>
2+
3+
Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
4+
5+
#### Type parameters
6+
7+
| Name | Type |
8+
| :--- | :---- |
9+
| `T` | `any` |
10+
11+
#### Type declaration
12+
13+
▸ (`options`, `context`): `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
14+
15+
Implementation of a target of a project
16+
17+
##### Parameters
18+
19+
| Name | Type |
20+
| :-------- | :---------------------------------------------------------- |
21+
| `options` | `T` |
22+
| `context` | [`ExecutorContext`](../../devkit/documents/ExecutorContext) |
23+
24+
##### Returns
25+
26+
`Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>

‎docs/generated/devkit/ExecutorContext.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Interface: ExecutorContext
2+
3+
Context that is passed into an executor
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [configurationName](../../devkit/documents/ExecutorContext#configurationname)
10+
- [cwd](../../devkit/documents/ExecutorContext#cwd)
11+
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose)
12+
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration)
13+
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph)
14+
- [projectName](../../devkit/documents/ExecutorContext#projectname)
15+
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations)
16+
- [root](../../devkit/documents/ExecutorContext#root)
17+
- [target](../../devkit/documents/ExecutorContext#target)
18+
- [targetName](../../devkit/documents/ExecutorContext#targetname)
19+
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph)
20+
- [workspace](../../devkit/documents/ExecutorContext#workspace)
21+
22+
## Properties
23+
24+
### configurationName
25+
26+
• `Optional` **configurationName**: `string`
27+
28+
The name of the configuration being executed
29+
30+
---
31+
32+
### cwd
33+
34+
• **cwd**: `string`
35+
36+
The current working directory
37+
38+
---
39+
40+
### isVerbose
41+
42+
• **isVerbose**: `boolean`
43+
44+
Enable verbose logging
45+
46+
---
47+
48+
### nxJsonConfiguration
49+
50+
• `Optional` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
51+
52+
The contents of nx.json.
53+
54+
@todo(vsavkin): mark this as required for v17
55+
56+
---
57+
58+
### projectGraph
59+
60+
• `Optional` **projectGraph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
61+
62+
A snapshot of the project graph as
63+
it existed when the Nx command was kicked off
64+
65+
@todo(vsavkin) mark this required for v17
66+
67+
---
68+
69+
### projectName
70+
71+
• `Optional` **projectName**: `string`
72+
73+
The name of the project being executed on
74+
75+
---
76+
77+
### projectsConfigurations
78+
79+
• `Optional` **projectsConfigurations**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations)
80+
81+
Projects config
82+
83+
@todo(vsavkin): mark this as required for v17
84+
85+
---
86+
87+
### root
88+
89+
• **root**: `string`
90+
91+
The root of the workspace
92+
93+
---
94+
95+
### target
96+
97+
• `Optional` **target**: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)<`any`\>
98+
99+
The configuration of the target being executed
100+
101+
---
102+
103+
### targetName
104+
105+
• `Optional` **targetName**: `string`
106+
107+
The name of the target being executed
108+
109+
---
110+
111+
### taskGraph
112+
113+
• `Optional` **taskGraph**: [`TaskGraph`](../../devkit/documents/TaskGraph)
114+
115+
A snapshot of the task graph as
116+
it existed when the Nx command was kicked off
117+
118+
---
119+
120+
### workspace
121+
122+
• `Optional` **workspace**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
123+
124+
Deprecated. Use projectsConfigurations or nxJsonConfiguration
125+
The full workspace configuration
126+
@todo(vsavkin): remove after v17

‎docs/generated/devkit/ExecutorsJson.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Interface: ExecutorsJson
2+
3+
## Table of contents
4+
5+
### Properties
6+
7+
- [builders](../../devkit/documents/ExecutorsJson#builders)
8+
- [executors](../../devkit/documents/ExecutorsJson#executors)
9+
10+
## Properties
11+
12+
### builders
13+
14+
• `Optional` **builders**: `Record`<`string`, `ExecutorsJsonEntry`\>
15+
16+
---
17+
18+
### executors
19+
20+
• `Optional` **executors**: `Record`<`string`, `ExecutorsJsonEntry`\>

‎docs/generated/devkit/FileChange.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Interface: FileChange
2+
3+
Description of a file change in the Nx virtual file system/
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [content](../../devkit/documents/FileChange#content)
10+
- [options](../../devkit/documents/FileChange#options)
11+
- [path](../../devkit/documents/FileChange#path)
12+
- [type](../../devkit/documents/FileChange#type)
13+
14+
## Properties
15+
16+
### content
17+
18+
• **content**: `Buffer`
19+
20+
The content of the file or null in case of delete.
21+
22+
---
23+
24+
### options
25+
26+
• `Optional` **options**: `TreeWriteOptions`
27+
28+
Options to set on the file being created or updated.
29+
30+
---
31+
32+
### path
33+
34+
• **path**: `string`
35+
36+
Path relative to the workspace root
37+
38+
---
39+
40+
### type
41+
42+
• **type**: `"CREATE"` \| `"DELETE"` \| `"UPDATE"`
43+
44+
Type of change: 'CREATE' | 'DELETE' | 'UPDATE'

‎docs/generated/devkit/FileData.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Interface: FileData
2+
3+
Some metadata about a file
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [deps](../../devkit/documents/FileData#deps)
10+
- [file](../../devkit/documents/FileData#file)
11+
- [hash](../../devkit/documents/FileData#hash)
12+
13+
## Properties
14+
15+
### deps
16+
17+
• `Optional` **deps**: (`string` \| [`string`, `string`])[]
18+
19+
---
20+
21+
### file
22+
23+
• **file**: `string`
24+
25+
---
26+
27+
### hash
28+
29+
• **hash**: `string`

0 commit comments

Comments
 (0)