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

docs(misc): update typedoc #22264

Merged
merged 1 commit into from Mar 12, 2024
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
6 changes: 3 additions & 3 deletions docs/generated/devkit/CreateDependencies.md
Expand Up @@ -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 |
Expand All @@ -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 |
Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/CreateNodesFunction.md
Expand Up @@ -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 |
Expand All @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/Executor.md
Expand Up @@ -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 |
Expand All @@ -12,8 +14,6 @@

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

Implementation of a target of a project

##### Parameters

| Name | Type |
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/Generator.md
Expand Up @@ -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 |
Expand All @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/GeneratorCallback.md
Expand Up @@ -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 changes: 4 additions & 4 deletions docs/generated/devkit/ProjectTargetConfigurator.md
Expand Up @@ -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)\>
Expand All @@ -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 changes: 2 additions & 2 deletions docs/generated/devkit/TaskGraphExecutor.md
Expand Up @@ -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 |
Expand All @@ -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 |
Expand Down
3 changes: 0 additions & 3 deletions docs/generated/devkit/defaultTasksRunner.md
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -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",
Expand Down
26 changes: 15 additions & 11 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.