Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nx-dev): split devkit reference page #18536

Merged
merged 6 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/generated/devkit/AdditionalSharedConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Type alias: AdditionalSharedConfig

Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/SharedLibraryConfig) })[]
20 changes: 20 additions & 0 deletions docs/generated/devkit/ChangeType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Enumeration: ChangeType

## Table of contents

### Enumeration Members

- [Delete](../../devkit/documents/ChangeType#delete)
- [Insert](../../devkit/documents/ChangeType#insert)

## Enumeration Members

### Delete

• **Delete** = `"Delete"`

---

### Insert

• **Insert** = `"Insert"`
18 changes: 18 additions & 0 deletions docs/generated/devkit/CustomHasher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Type alias: CustomHasher

Ƭ **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)\>

##### Parameters

| Name | Type |
| :-------- | :------------------------------------------------------ |
| `task` | [`Task`](../../devkit/documents/Task) |
| `context` | [`HasherContext`](../../devkit/documents/HasherContext) |

##### Returns

`Promise`<[`Hash`](../../devkit/documents/Hash)\>
69 changes: 69 additions & 0 deletions docs/generated/devkit/DefaultTasksRunnerOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Interface: DefaultTasksRunnerOptions

## Table of contents

### Properties

- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory)
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations)
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets)
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr)
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle)
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel)
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache)
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs)
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache)

## Properties

### cacheDirectory

• `Optional` **cacheDirectory**: `string`

---

### cacheableOperations

• `Optional` **cacheableOperations**: `string`[]

---

### cacheableTargets

• `Optional` **cacheableTargets**: `string`[]

---

### captureStderr

• `Optional` **captureStderr**: `boolean`

---

### lifeCycle

• **lifeCycle**: `LifeCycle`

---

### parallel

• `Optional` **parallel**: `number`

---

### remoteCache

• `Optional` **remoteCache**: [`RemoteCache`](../../devkit/documents/RemoteCache)

---

### runtimeCacheInputs

• `Optional` **runtimeCacheInputs**: `string`[]

---

### skipNxCache

• `Optional` **skipNxCache**: `boolean`
35 changes: 35 additions & 0 deletions docs/generated/devkit/DependencyType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Enumeration: DependencyType

Type of dependency between projects

## Table of contents

### Enumeration Members

- [dynamic](../../devkit/documents/DependencyType#dynamic)
- [implicit](../../devkit/documents/DependencyType#implicit)
- [static](../../devkit/documents/DependencyType#static)

## Enumeration Members

### dynamic

• **dynamic** = `"dynamic"`

Dynamic dependencies are brought in by the module at run time

---

### implicit

• **implicit** = `"implicit"`

Implicit dependencies are inferred

---

### static

• **static** = `"static"`

Static dependencies are tied to the loading of the module
26 changes: 26 additions & 0 deletions docs/generated/devkit/Executor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Type alias: Executor<T\>

Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>

#### Type parameters

| Name | Type |
| :--- | :---- |
| `T` | `any` |

#### Type declaration

▸ (`options`, `context`): `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>

Implementation of a target of a project

##### Parameters

| Name | Type |
| :-------- | :---------------------------------------------------------- |
| `options` | `T` |
| `context` | [`ExecutorContext`](../../devkit/documents/ExecutorContext) |

##### Returns

`Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\>
126 changes: 126 additions & 0 deletions docs/generated/devkit/ExecutorContext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Interface: ExecutorContext

Context that is passed into an executor

## Table of contents

### Properties

- [configurationName](../../devkit/documents/ExecutorContext#configurationname)
- [cwd](../../devkit/documents/ExecutorContext#cwd)
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose)
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration)
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph)
- [projectName](../../devkit/documents/ExecutorContext#projectname)
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations)
- [root](../../devkit/documents/ExecutorContext#root)
- [target](../../devkit/documents/ExecutorContext#target)
- [targetName](../../devkit/documents/ExecutorContext#targetname)
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph)
- [workspace](../../devkit/documents/ExecutorContext#workspace)

## Properties

### configurationName

• `Optional` **configurationName**: `string`

The name of the configuration being executed

---

### cwd

• **cwd**: `string`

The current working directory

---

### isVerbose

• **isVerbose**: `boolean`

Enable verbose logging

---

### nxJsonConfiguration

• `Optional` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>

The contents of nx.json.

@todo(vsavkin): mark this as required for v17

---

### projectGraph

• `Optional` **projectGraph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)

A snapshot of the project graph as
it existed when the Nx command was kicked off

@todo(vsavkin) mark this required for v17

---

### projectName

• `Optional` **projectName**: `string`

The name of the project being executed on

---

### projectsConfigurations

• `Optional` **projectsConfigurations**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations)

Projects config

@todo(vsavkin): mark this as required for v17

---

### root

• **root**: `string`

The root of the workspace

---

### target

• `Optional` **target**: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)<`any`\>

The configuration of the target being executed

---

### targetName

• `Optional` **targetName**: `string`

The name of the target being executed

---

### taskGraph

• `Optional` **taskGraph**: [`TaskGraph`](../../devkit/documents/TaskGraph)

A snapshot of the task graph as
it existed when the Nx command was kicked off

---

### workspace

• `Optional` **workspace**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>

Deprecated. Use projectsConfigurations or nxJsonConfiguration
The full workspace configuration
@todo(vsavkin): remove after v17
20 changes: 20 additions & 0 deletions docs/generated/devkit/ExecutorsJson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Interface: ExecutorsJson

## Table of contents

### Properties

- [builders](../../devkit/documents/ExecutorsJson#builders)
- [executors](../../devkit/documents/ExecutorsJson#executors)

## Properties

### builders

• `Optional` **builders**: `Record`<`string`, `ExecutorsJsonEntry`\>

---

### executors

• `Optional` **executors**: `Record`<`string`, `ExecutorsJsonEntry`\>
44 changes: 44 additions & 0 deletions docs/generated/devkit/FileChange.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Interface: FileChange

Description of a file change in the Nx virtual file system/

## Table of contents

### Properties

- [content](../../devkit/documents/FileChange#content)
- [options](../../devkit/documents/FileChange#options)
- [path](../../devkit/documents/FileChange#path)
- [type](../../devkit/documents/FileChange#type)

## Properties

### content

• **content**: `Buffer`

The content of the file or null in case of delete.

---

### options

• `Optional` **options**: `TreeWriteOptions`

Options to set on the file being created or updated.

---

### path

• **path**: `string`

Path relative to the workspace root

---

### type

• **type**: `"CREATE"` \| `"DELETE"` \| `"UPDATE"`

Type of change: 'CREATE' | 'DELETE' | 'UPDATE'
29 changes: 29 additions & 0 deletions docs/generated/devkit/FileData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Interface: FileData

Some metadata about a file

## Table of contents

### Properties

- [deps](../../devkit/documents/FileData#deps)
- [file](../../devkit/documents/FileData#file)
- [hash](../../devkit/documents/FileData#hash)

## Properties

### deps

• `Optional` **deps**: (`string` \| [`string`, `string`])[]

---

### file

• **file**: `string`

---

### hash

• **hash**: `string`