n8n/packages/nodes-base/nodes/Function.node.ts

75 lines
1.7 KiB
TypeScript
Raw Normal View History

2019-06-23 03:35:23 -07:00
import { IExecuteFunctions } from 'n8n-core';
import {
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
const { NodeVM } = require('vm2');
export class Function implements INodeType {
description: INodeTypeDescription = {
displayName: 'Function',
name: 'function',
icon: 'fa:code',
group: ['transform'],
version: 1,
description: 'Run custom function code which gets executed once per item.',
defaults: {
name: 'Function',
color: '#FF9922',
},
inputs: ['main'],
outputs: ['main'],
properties: [
{
displayName: 'Function',
name: 'functionCode',
typeOptions: {
alwaysOpenEditWindow: true,
rows: 10,
},
type: 'string',
default: 'items[0].json.myVariable = 1;\nreturn items;',
description: 'The JavaScript code to execute.',
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
// const item = this.getInputData();
let items = this.getInputData();
// Copy the items as they may get changed in the functions
items = JSON.parse(JSON.stringify(items));
2019-06-23 03:35:23 -07:00
// Define the global objects for the custom function
const sandbox = {
getNodeParameter: this.getNodeParameter,
helpers: this.helpers,
items,
};
const vm = new NodeVM({
console: 'inherit',
sandbox,
require: {
external: false,
root: './',
}
});
// Get the code to execute
const functionCode = this.getNodeParameter('functionCode', 0) as string;
try {
// Execute the function code
items = await vm.run(`module.exports = async function() {${functionCode}}()`);
} catch (e) {
return Promise.reject(e);
}
return this.prepareOutputData(items);
}
}