n8n/packages/nodes-base/nodes/StopAndError/StopAndError.node.ts
Michael Kret 61e26804ba
refactor(core): Remove linting exceptions in nodes-base (#4794)
*  enabled array-type

*  await-thenable on

*  ban-types on

*  default-param-last on

*  dot-notation on

*  member-delimiter-style on

*  no-duplicate-imports on

*  no-empty-interface on

*  no-floating-promises on

*  no-for-in-array on

*  no-invalid-void-type on

*  no-loop-func on

*  no-shadow on

*  ban-ts-comment re enabled

*  @typescript-eslint/lines-between-class-members on

* address my own comment

* @typescript-eslint/return-await on

* @typescript-eslint/promise-function-async on

* @typescript-eslint/no-unnecessary-boolean-literal-compare on

* @typescript-eslint/no-unnecessary-type-assertion on

* prefer-const on

* @typescript-eslint/prefer-optional-chain on

Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2022-12-02 21:54:28 +01:00

108 lines
2.5 KiB
TypeScript

import { IExecuteFunctions } from 'n8n-core';
import {
INodeExecutionData,
INodeType,
INodeTypeDescription,
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!',
typeOptions: {
alwaysOpenEditWindow: true,
},
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);
}
}