跳到主要内容

编程式参数

以下参数适用于编程式节点的节点基础文件。

本文通过简短代码片段介绍代码结构和概念。包含实际代码示例的完整节点构建教程,请参阅构建编程式节点。

编程式节点还使用 execute() 方法。更多信息请参阅编程式 execute 方法。

适用于所有节点的参数,请参阅标准参数。

defaultVersion ​

数字 | 可选

采用完整版本控制方式时,使用 defaultVersion。

n8n 支持两种节点版本控制方式。更多信息请参阅节点版本控制。

methods 与 loadOptions ​

对象 | 可选

包含编程式节点的 loadOptions 方法。你可以用此方法查询服务,获取用户专属设置(例如获取用户的 Gmail 邮件标签),再返回这些设置并显示在图形界面中,供用户在后续查询中选用。

例如,n8n 的 Gmail 节点通过 loadOptions 获取所有邮件标签:

	methods = {
loadOptions: {
// Get all the labels and display them
async getLabels(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const labels = await googleApiRequestAllItems.call(
this,
'labels',
'GET',
'/gmail/v1/users/me/labels',
);
for (const label of labels) {
const labelName = label.name;
const labelId = label.id;
returnData.push({
name: labelName,
value: labelId,
});
}
return returnData;
},
},
};

version ​

数字 或 数组 | 可选

采用轻量版本控制方式时,使用 version。

如果节点只有一个版本,可以使用数字。如果要支持多个版本,请改用数组,并在其中填写每个节点版本的编号。

n8n 支持两种节点版本控制方式,编程式节点可以任选一种。更多信息请参阅节点版本控制。

features ​

对象 | 可选

定义具名功能标志,并根据节点版本进行判断。可以使用 @feature 在 displayOptions 中控制参数是否显示,也可以在代码中通过 this.isNodeFeatureEnabled() 检查这些标志。

更多信息请参阅基于功能的版本控制。

相关资源 ​

本文为社区中文翻译。查看对应英文原文