Class: AggregateCreateNodesError
This error should be thrown when a createNodesV2 function hits a recoverable error. It allows Nx to recieve partial results and continue processing for better UX.
Hierarchy
Error↳
AggregateCreateNodesError
Table of contents
Constructors
Properties
- cause: unknown
- errors: [file: string, error: Error][]
- message: string
- name: string
- partialResults: CreateNodesResultV2
- stack: string
- prepareStackTrace: Function
- stackTraceLimit: number
Methods
Constructors
constructor
• new AggregateCreateNodesError(errors, partialResults): AggregateCreateNodesError
Throwing this error from a createNodesV2 function will allow Nx to continue processing and recieve partial results from your plugin.
Parameters
| Name | Type | Description |
|---|---|---|
errors | [file: string, error: Error][] | An array of tuples that represent errors encountered when processing a given file. An example entry might look like ['path/to/project.json', [Error: 'Invalid JSON. Unexpected token 'a' in JSON at position 0]] |
partialResults | CreateNodesResultV2 | The partial results of the createNodesV2 function. This should be the results for each file that didn't encounter an issue. |
Returns
Example
1export async function createNodesV2(files: string[]) {
2 const partialResults = [];
3 const errors = [];
4 await Promise.all(
5 files.map(async (file) => {
6 try {
7 const result = await createNodes(file);
8 partialResults.push(result);
9 } catch (e) {
10 errors.push([file, e]);
11 }
12 })
13 );
14 if (errors.length > 0) {
15 throw new AggregateCreateNodesError(errors, partialResults);
16 }
17 return partialResults;
18}
19Overrides
Error.constructor
Properties
cause
• Optional cause: unknown
Inherited from
Error.cause
errors
• Readonly errors: [file: string, error: Error][]
An array of tuples that represent errors encountered when processing a given file. An example entry might look like ['path/to/project.json', [Error: 'Invalid JSON. Unexpected token 'a' in JSON at position 0]]
message
• message: string
Inherited from
Error.message
name
• name: string
Inherited from
Error.name
partialResults
• Readonly partialResults: CreateNodesResultV2
The partial results of the createNodesV2 function. This should be the results for each file that didn't encounter an issue.
stack
• Optional stack: string
Inherited from
Error.stack
prepareStackTrace
▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Type declaration
▸ (err, stackTraces): any
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
Inherited from
Error.prepareStackTrace
stackTraceLimit
▪ Static stackTraceLimit: number
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace
▸ captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace