File size: 3,799 Bytes
0a84888 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: Declarative-style parameters
description: A reference document listing the declarative-style parameters of the node base file.
contentType: reference
---
# Declarative-style parameters
These are the parameters available for [node base file](/integrations/creating-nodes/build/reference/node-base-files/index.md) of declarative-style nodes.
This document gives short code snippets to help understand the code structure and concepts. For a full walk-through of building a node, including real-world code examples, refer to [Build a declarative-style node](/integrations/creating-nodes/build/declarative-style-node.md).
Refer to [Standard parameters](/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md) for parameters available to all nodes.
## `methods` and `loadOptions`
_Object_ | _Optional_
`methods` contains the `loadOptions` object. You can use `loadOptions` to query the service to get user-specific settings, then return them and render them in the GUI so the user can include them in subsequent queries. The object must include routing information for how to query the service, and output settings that define how to handle the returned options. For example:
```js
methods : {
loadOptions: {
routing: {
request: {
url: '/webhook/example-option-parameters',
method: 'GET',
},
output: {
postReceive: [
{
// When the returned data is nested under another property
// Specify that property key
type: 'rootProperty',
properties: {
property: 'responseData',
},
},
{
type: 'setKeyValue',
properties: {
name: '={{$responseItem.key}} ({{$responseItem.value}})',
value: '={{$responseItem.value}}',
},
},
{
// If incoming data is an array of objects, sort alphabetically by key
type: 'sort',
properties: {
key: 'name',
},
},
],
},
},
}
},
```
## `routing`
_Object_ | _Required_
`routing` is an object used within an `options` array in operations and input field objects. It contains the details of an API call.
The code example below comes from the [Declarative-style tutorial](/integrations/creating-nodes/build/declarative-style-node.md). It sets up an integration with a NASA API. It shows how to use `requestDefaults` to set up the basic API call details, and `routing` to add information for each operation.
```js
description: INodeTypeDescription = {
// Other node info here
requestDefaults: {
baseURL: 'https://api.nasa.gov',
url: '',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
},
},
properties: [
// Resources here
{
displayName: 'Operation'
// Other operation details
options: [
{
name: 'Get'
value: 'get',
description: '',
routing: {
request: {
method: 'GET',
url: '/planetary/apod'
}
}
}
]
}
]
}
```
<!--
TODO: more info on the routing object
### routing.output
include postReceive actions, including ability to dynamically disable - see DOC-400
### routing.request
### routing.send
-->
## `version`
_Number_ or _Array_ | _Optional_
If you have one version of your node, this can be a number. If you want to support more than one version, turn this into an array, containing numbers for each node version.
n8n supports two methods of node versioning, but declarative-style nodes must use the light versioning approach. Refer to [Node versioning](/integrations/creating-nodes/build/reference/node-versioning.md) for more information.
|