mirrors/n8n-nodes-starter
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n-nodes-starter.git synced 2025-10-28 22:12:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

⚡ General improvements

Browse source 
Improve explanatory comments, correct typings, make param names consistent, and simplify execute block.
This commit is contained in:
Iván Ovejero 2022-06-28 15:27:25 +02:00
commit 82b2552d10
4 changed files with 36 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

14
nodes/HttpBin/HttpBin.node.ts
View file

@ -1,11 +1,10 @@
/* eslint-disable n8n-nodes-base/filesystem-wrong-node-filename */
import { INodeType, INodeTypeDescription } from 'n8n-workflow';
import { httpVerbFields, httpVerbOperations } from './HttpVerbDescriptions';
import { httpVerbFields, httpVerbOperations } from './HttpVerbDescription';
export class HttpBin implements INodeType {
description: INodeTypeDescription = {
displayName: 'HttpBin',
name: 'httpbin',
name: 'httpBin',
icon: 'file:httpbin.svg',
group: ['transform'],
version: 1,
@ -36,11 +35,10 @@ export class HttpBin implements INodeType {
*
* [Resource & Operation]
*
*
* https://docs.n8n.io/integrations/creating-nodes/code/create-first-node/#resources-and-operations
*
* In our example, the operations are separated into their own file (HTTPVerbDescription)
* to keep this class easy to read
* In our example, the operations are separated into their own file (HTTPVerbDescription.ts)
* to keep this class easy to read.
*
*/
properties: [
@ -52,10 +50,10 @@ export class HttpBin implements INodeType {
options: [
{
name: 'HTTP Verb',
value: 'httpverbs',
value: 'httpVerb',
},
],
default: 'httpverbs',
default: 'httpVerb',
},
...httpVerbOperations,

27
nodes/HttpBin/HttpVerbDescriptions.ts → nodes/HttpBin/HttpVerbDescription.ts
View file

@ -1,15 +1,16 @@
import { INodeProperties } from 'n8n-workflow';
// This maps the operations to when the Resource option HTTP Verbs is selected
// When the resource `httpVerb` is selected, this `operation` parameter will be shown.
export const httpVerbOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
},
},
options: [
@ -38,8 +39,8 @@ export const httpVerbOperations: INodeProperties[] = [
},
];
// Here we define what to show when the GET Operation is selected
// We do that by adding operation: ["get"], to "displayOptions.show"
// Here we define what to show when the `get` operation is selected.
// We do that by adding `operation: ["get"]` to `displayOptions.show`
const getOperation: INodeProperties[] = [
{
name: 'typeofData',
@ -48,7 +49,7 @@ const getOperation: INodeProperties[] = [
displayName: 'Type of Data',
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
operation: ['get'],
},
},
@ -68,7 +69,7 @@ const getOperation: INodeProperties[] = [
displayName: 'Query Parameters',
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
operation: ['get'],
},
},
@ -109,8 +110,8 @@ const getOperation: INodeProperties[] = [
},
];
// Here we define what to show when the DELETE Operation is selected
// We do that by adding operation: ["delete"], to "displayOptions.show"
// Here we define what to show when the DELETE Operation is selected.
// We do that by adding `operation: ["delete"]` to `displayOptions.show`
const deleteOperation: INodeProperties[] = [
{
name: 'typeofData',
@ -119,7 +120,7 @@ const deleteOperation: INodeProperties[] = [
displayName: 'Type of Data',
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
operation: ['delete'],
},
},
@ -143,7 +144,7 @@ const deleteOperation: INodeProperties[] = [
displayName: 'Query Parameters',
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
operation: ['delete'],
typeofData: ['queryParameter'],
},
@ -190,7 +191,7 @@ const deleteOperation: INodeProperties[] = [
displayName: 'JSON Object',
displayOptions: {
show: {
resource: ['httpverbs'],
resource: ['httpVerb'],
operation: ['delete'],
typeofData: ['jsonData'],
},
@ -234,12 +235,12 @@ const deleteOperation: INodeProperties[] = [
export const httpVerbFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* Http Verbs:Get */
/* httpVerb:get */
/* -------------------------------------------------------------------------- */
...getOperation,
/* -------------------------------------------------------------------------- */
/* Http Verbs:Delete */
/* httpVerb:delete */
/* -------------------------------------------------------------------------- */
...deleteOperation,
];