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

docs(nx-dev): update typedoc version (#19435)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2023-10-11 17:00:03 +02:00 committed by GitHub
parent 1899a9ee35
commit 5a30beff77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 88 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -109,10 +109,6 @@ Adds dynamic dependency from source project to target project
Add an explicit dependency from a file in source project to target project
**`Deprecated`**
this method will be removed in v17. Use [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency) or [addDynamicDependency](../../devkit/documents/ProjectGraphBuilder#adddynamicdependency) instead
#### Parameters
| Name | Type |
@ -125,6 +121,10 @@ this method will be removed in v17. Use [addStaticDependency](../../devkit/docum
`void`
**`Deprecated`**
this method will be removed in v17. Use [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency) or [addDynamicDependency](../../devkit/documents/ProjectGraphBuilder#adddynamicdependency) instead
---
### addExternalNode

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

@ -6,10 +6,6 @@
▸ (`file`): `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 18
##### Parameters
| Name | Type |
@ -19,3 +15,7 @@ Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNode
##### 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 18

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

@ -13,10 +13,6 @@
▸ **hashTask**(`task`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
**`Deprecated`**
use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
#### Parameters
| Name | Type |
@ -27,12 +23,12 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
`Promise`<[`Hash`](../../devkit/documents/Hash)\>
▸ **hashTask**(`task`, `taskGraph`): `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)\>
#### Parameters
| Name | Type |
@ -44,6 +40,10 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
`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)\>
#### Parameters
@ -64,10 +64,6 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
▸ **hashTasks**(`tasks`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
**`Deprecated`**
use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
#### Parameters
| Name | Type |
@ -78,12 +74,12 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
`Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
▸ **hashTasks**(`tasks`, `taskGraph`): `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)[]\>
#### Parameters
| Name | Type |
@ -95,6 +91,10 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
`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)[]\>
#### Parameters

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

@ -32,10 +32,10 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
▸ **readWorkspaceConfiguration**(): [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
**`Deprecated`**
Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead.
#### Returns
[`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
**`Deprecated`**
Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead.

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

@ -2,6 +2,21 @@
▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void`
#### Parameters
| Name | Type | Description |
| :------------------------ | :------------------------------------ | :----------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) | the file system tree |
| `pkg` | `string` | the package to check (e.g. @nx/jest) |
| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) |
| `options?` | `Object` | - |
| `options.dev?` | `boolean` | - |
| `options.throwOnMissing?` | `boolean` | - |
#### Returns
`void`
**`Deprecated`**
Use the other function signature without a Tree
@ -18,21 +33,6 @@ 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.
#### Parameters
| Name | Type | Description |
| :------------------------ | :------------------------------------ | :----------------------------------------------------------------- |
| `tree` | [`Tree`](../../devkit/documents/Tree) | the file system tree |
| `pkg` | `string` | the package to check (e.g. @nx/jest) |
| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) |
| `options?` | `Object` | - |
| `options.dev?` | `boolean` | - |
| `options.throwOnMissing?` | `boolean` | - |
#### Returns
`void`
▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T`
Ensure that dependencies and devDependencies from package.json are installed at the required versions.

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

@ -2,10 +2,6 @@
▸ **getWorkspacePath**(`tree`): `"angular.json"` \| `"workspace.json"`
**`Deprecated`**
all projects are configured using project.json
#### Parameters
| Name | Type |
@ -15,3 +11,7 @@ all projects are configured using project.json
#### Returns
`"angular.json"` \| `"workspace.json"`
**`Deprecated`**
all projects are configured using project.json

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

@ -4,10 +4,6 @@
Returns if a project has a standalone configuration (project.json).
**`Deprecated`**
non-standalone projects were deprecated
#### Parameters
| Name | Type | Description |
@ -18,3 +14,7 @@ non-standalone projects were deprecated
#### Returns
`boolean`
**`Deprecated`**
non-standalone projects were deprecated

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

@ -4,10 +4,10 @@
Synchronously reads the latest cached copy of the workspace's ProjectGraph.
**`Throws`**
if there is no cached ProjectGraph to read from
#### Returns
[`ProjectGraph`](../../devkit/documents/ProjectGraph)
**`Throws`**
if there is no cached ProjectGraph to read from

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

@ -2,14 +2,14 @@
▸ **readNxJson**(): [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
**`Deprecated`**
You must pass a [Tree](../../devkit/documents/Tree)
#### Returns
[`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
**`Deprecated`**
You must pass a [Tree](../../devkit/documents/Tree)
▸ **readNxJson**(`tree`): [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
Reads nx.json

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

@ -4,10 +4,6 @@
Reads a project configuration.
**`Throws`**
If supplied projectName cannot be found
#### Parameters
| Name | Type | Description |
@ -18,3 +14,7 @@ If supplied projectName cannot be found
#### Returns
[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)
**`Throws`**
If supplied projectName cannot be found

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

@ -6,10 +6,6 @@ Read general workspace configuration such as the default project or cli settings
This does _not_ provide projects configuration, use [readProjectConfiguration](../../devkit/documents/readProjectConfiguration) instead.
**`Deprecated`**
use readNxJson
#### Parameters
| Name | Type |
@ -19,3 +15,7 @@ use readNxJson
#### Returns
[`WorkspaceConfiguration`](../../devkit/documents/WorkspaceConfiguration)
**`Deprecated`**
use readNxJson

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

@ -6,10 +6,6 @@ Update general workspace configuration such as the default project or cli settin
This does _not_ update projects configuration, use [updateProjectConfiguration](../../devkit/documents/updateProjectConfiguration) or [addProjectConfiguration](../../devkit/documents/addProjectConfiguration) instead.
**`Deprecated`**
use updateNxJson
#### Parameters
| Name | Type |
@ -20,3 +16,7 @@ use updateNxJson
#### Returns
`void`
**`Deprecated`**
use updateNxJson

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

@ -4,10 +4,6 @@
A function to validate dependencies in a [CreateDependencies](../../devkit/documents/CreateDependencies) function
**`Throws`**
If the dependency is invalid.
#### Parameters
| Name | Type |
@ -18,3 +14,7 @@ If the dependency is invalid.
#### Returns
`void`
**`Throws`**
If the dependency is invalid.

4
package.json
View File

@ -281,8 +281,8 @@
"ts-node": "10.9.1",
"tsconfig-paths": "^4.1.2",
"tsconfig-paths-webpack-plugin": "4.0.0",
"typedoc": "0.24.8",
"typedoc-plugin-markdown": "3.15.3",
"typedoc": "0.25.1",
"typedoc-plugin-markdown": "3.16.0",
"typescript": "~5.1.3",
"unist-builder": "^4.0.0",
"unzipper": "^0.10.11",

30
pnpm-lock.yaml generated
View File

@ -918,11 +918,11 @@ devDependencies:
specifier: 4.0.0
version: 4.0.0
typedoc:
specifier: 0.24.8
version: 0.24.8(typescript@5.1.3)
specifier: 0.25.1
version: 0.25.1(typescript@5.1.3)
typedoc-plugin-markdown:
specifier: 3.15.3
version: 3.15.3(typedoc@0.24.8)
specifier: 3.16.0
version: 3.16.0(typedoc@0.25.1)
typescript:
specifier: ~5.1.3
version: 5.1.3
@ -16469,7 +16469,7 @@ packages:
dependencies:
foreground-child: 3.1.1
jackspeak: 2.1.5
minimatch: 9.0.0
minimatch: 9.0.3
minipass: 5.0.0
path-scurry: 1.7.0
dev: true
@ -20137,8 +20137,8 @@ packages:
brace-expansion: 2.0.1
dev: true
/minimatch@9.0.0:
resolution: {integrity: sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==}
/minimatch@9.0.3:
resolution: {integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==}
engines: {node: '>=16 || 14 >=14.17'}
dependencies:
brace-expansion: 2.0.1
@ -26241,25 +26241,25 @@ packages:
resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==}
dev: true
/typedoc-plugin-markdown@3.15.3(typedoc@0.24.8):
resolution: {integrity: sha512-idntFYu3vfaY3eaD+w9DeRd0PmNGqGuNLKihPU9poxFGnATJYGn9dPtEhn2QrTdishFMg7jPXAhos+2T6YCWRQ==}
/typedoc-plugin-markdown@3.16.0(typedoc@0.25.1):
resolution: {integrity: sha512-eeiC78fDNGFwemPIHiwRC+mEC7W5jwt3fceUev2gJ2nFnXpVHo8eRrpC9BLWZDee6ehnz/sPmNjizbXwpfaTBw==}
peerDependencies:
typedoc: '>=0.24.0'
dependencies:
handlebars: 4.7.7
typedoc: 0.24.8(typescript@5.1.3)
typedoc: 0.25.1(typescript@5.1.3)
dev: true
/typedoc@0.24.8(typescript@5.1.3):
resolution: {integrity: sha512-ahJ6Cpcvxwaxfu4KtjA8qZNqS43wYt6JL27wYiIgl1vd38WW/KWX11YuAeZhuz9v+ttrutSsgK+XO1CjL1kA3w==}
engines: {node: '>= 14.14'}
/typedoc@0.25.1(typescript@5.1.3):
resolution: {integrity: sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==}
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
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x
dependencies:
lunr: 2.3.9
marked: 4.3.0
minimatch: 9.0.0
minimatch: 9.0.3
shiki: 0.14.1
typescript: 5.1.3
dev: true