Handle errors from example node and clarified options about credentials and properties

credentials/HttpBinApi.credentials.ts

@@ -1,4 +1,5 @@
 import {
+	IAuthenticateGeneric,
 	ICredentialDataDecryptedObject,
 	ICredentialTestRequest,
 	ICredentialType,
@@ -17,12 +18,6 @@ export class HttpBinApi implements ICredentialType {
 			type: 'string',
 			default: '',
 		},
-		// {
-		// 	displayName: "API Key",
-		// 	name: "apiKey",
-		// 	type: "string",
-		// 	default: "",
-		// },
 		{
 			displayName: 'Domain',
 			name: 'domain',
@@ -31,26 +26,21 @@ export class HttpBinApi implements ICredentialType {
 		},
 	];
 
-	// authenticate = {
+	// This allows the credential to be used by other parts of n8n
-	// 	type: "headerAuth",
+	// stating how this credential is injected as part of the request
-	// 	properties: {
+	// An example is the Http Request node that can make generic calls
-	// 		name: "api-key",
+	// reusing this credential
-	// 		value: "={{$credentials.apiKey}}",
+	authenticate = {
-	// 	},
+		type: 'generic',
-	// } as IAuthenticateHeaderAuth;
+		properties: {
-
+			header: {
-	authenticate = async (
+				name: 'api-key',
-		credentials: ICredentialDataDecryptedObject,
+				value: '={{$credentials.apiKey}}',
-		requestOptions: IHttpRequestOptions,
+			},
-	): Promise<IHttpRequestOptions> => {
+		},
-		const headers = requestOptions.headers || {};
+	} as IAuthenticateGeneric;
-		const authentication = { Authorization: `Bearer ${credentials.token}` };
-		Object.assign(requestOptions, {
-			headers: { ...authentication, ...headers },
-		});
-		return requestOptions;
-	};
 
+	// The block below tells how this credential can be tested
 	test: ICredentialTestRequest = {
 		request: {
 			baseURL: '={{$credentials?.domain}}',

nodes/ExampleNode/ExampleNode.node.ts

@@ -28,6 +28,10 @@ export class ExampleNode implements INodeType {
 		],
 	};
 
+	// The function below is responsible for actually doing whatever this node
+	// is supposed to do. In this case, we're just appending the `myString` property
+	// with whatever the user has entered.
+	// You can make async calls and use `await`.
 	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
 		const items = this.getInputData();
 
@@ -38,10 +42,24 @@ export class ExampleNode implements INodeType {
 		// value the parameter "myString" resolves to.
 		// (This could be a different value for each item in case it contains an expression)
 		for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
-			myString = this.getNodeParameter('myString', itemIndex, '') as string;
+			try {
-			item = items[itemIndex];
+				myString = this.getNodeParameter('myString', itemIndex, '') as string;
+				item = items[itemIndex];
+
+				item.json['myString'] = myString;
+			} catch (error) {
+
+				// This node should never fail but we want to showcase how
+				// to handle errors.
+				if (this.continueOnFail()) {
+					items.push({json: this.getInputData(itemIndex)[0].json, error});
+				} else {
+					// Adding `itemIndex` allows other workflows to handle this error
+					if (error.context) error.context.itemIndex = itemIndex;
+					throw error;
+				}
+			}
 
-			item.json['myString'] = myString;
 		}
 
 		return this.prepareOutputData(items);

package.json

@@ -42,8 +42,8 @@
     "@typescript-eslint/parser": "^5.29.0",
     "eslint-plugin-n8n-nodes-base": "~1.1.1",
     "gulp": "^4.0.2",
-    "n8n-core": "~0.122.1",
+    "n8n-core": "^0.124.0",
-    "n8n-workflow": "~0.104.0",
+    "n8n-workflow": "^0.106.0",
     "prettier": "^2.7.1",
     "tslint": "^6.1.2",
     "typescript": "~4.6.0"