mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-15 09:04:07 -08:00
103 lines
2.4 KiB
TypeScript
103 lines
2.4 KiB
TypeScript
import type {
|
|
IExecuteFunctions,
|
|
INodeExecutionData,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
} from 'n8n-workflow';
|
|
import { jsonParse, NodeOperationError } from 'n8n-workflow';
|
|
|
|
const errorObjectPlaceholder = `{
|
|
"code": "404",
|
|
"description": "The resource could not be fetched"
|
|
}`;
|
|
|
|
export class StopAndError implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Stop and Error',
|
|
name: 'stopAndError',
|
|
icon: 'fa:exclamation-triangle',
|
|
group: ['input'],
|
|
version: 1,
|
|
description: 'Throw an error in the workflow',
|
|
defaults: {
|
|
name: 'Stop and Error',
|
|
color: '#ff0000',
|
|
},
|
|
inputs: ['main'],
|
|
// eslint-disable-next-line n8n-nodes-base/node-class-description-outputs-wrong
|
|
outputs: [],
|
|
properties: [
|
|
{
|
|
displayName: 'Error Type',
|
|
name: 'errorType',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Error Message',
|
|
value: 'errorMessage',
|
|
},
|
|
{
|
|
name: 'Error Object',
|
|
value: 'errorObject',
|
|
},
|
|
],
|
|
default: 'errorMessage',
|
|
description: 'Type of error to throw',
|
|
},
|
|
{
|
|
displayName: 'Error Message',
|
|
name: 'errorMessage',
|
|
type: 'string',
|
|
placeholder: 'An error occurred!',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
errorType: ['errorMessage'],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Error Object',
|
|
name: 'errorObject',
|
|
type: 'json',
|
|
description: 'Object containing error properties',
|
|
default: '',
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
placeholder: errorObjectPlaceholder,
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
errorType: ['errorObject'],
|
|
},
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const errorType = this.getNodeParameter('errorType', 0) as 'errorMessage' | 'errorObject';
|
|
const { id: workflowId, name: workflowName } = this.getWorkflow();
|
|
|
|
let toThrow: string | { name: string; message: string; [otherKey: string]: unknown };
|
|
|
|
if (errorType === 'errorMessage') {
|
|
toThrow = this.getNodeParameter('errorMessage', 0) as string;
|
|
} else {
|
|
const json = this.getNodeParameter('errorObject', 0) as string;
|
|
|
|
const errorObject = jsonParse<any>(json);
|
|
|
|
toThrow = {
|
|
name: 'User-thrown error',
|
|
message: `Workflow ID ${workflowId} "${workflowName}" has failed`,
|
|
...errorObject,
|
|
};
|
|
}
|
|
|
|
throw new NodeOperationError(this.getNode(), toThrow);
|
|
}
|
|
}
|