NiceNode docsNode Spec examples / Modules / nodeConfig
Module: nodeConfig
Table of contents
Type Aliases
- ConfigKey
- ConfigTranslation
- ConfigTranslationAddNodeFlow
- ConfigTranslationControl
- ConfigTranslationMap
- ConfigValue
- ConfigValuesMap
- FilePathControl
- MultiSelectControl
- SelectControl
- SelectTranslation
- TextControl
Variables
Functions
Type Aliases
ConfigKey
Ƭ ConfigKey: string
Defined in
ConfigTranslation
Ƭ ConfigTranslation: Object
Type declaration
| Name | Type |
|---|---|
addNodeFlow? | ConfigTranslationAddNodeFlow |
category? | string |
cliConfigPrefix? | string | string[] |
defaultValue? | ConfigValue |
displayName | string |
documentation? | string |
hideFromUserAfterStart? | boolean |
infoDescription? | string |
initCommandConfig? | boolean |
niceNodeDefaultValue? | ConfigValue |
uiControl | ConfigTranslationControl |
valuesJoinStr? | string |
valuesWrapChar? | string |
warning? | string |
Defined in
ConfigTranslationAddNodeFlow
Ƭ ConfigTranslationAddNodeFlow: "required" | "advanced"
Defined in
ConfigTranslationControl
Ƭ ConfigTranslationControl: FilePathControl | SelectControl | MultiSelectControl | TextControl
Defined in
ConfigTranslationMap
Ƭ ConfigTranslationMap: Record<ConfigKey, ConfigTranslation>
Defined in
ConfigValue
Ƭ ConfigValue: string | string[] | undefined
Defined in
ConfigValuesMap
Ƭ ConfigValuesMap: Record<ConfigKey, string>
Defined in
FilePathControl
Ƭ FilePathControl: Object
Type declaration
| Name | Type |
|---|---|
serviceConfigs? | ServiceConfigs |
type | "filePath" |
Defined in
MultiSelectControl
Ƭ MultiSelectControl: Object
Type declaration
| Name | Type |
|---|---|
controlTranslations | SelectTranslation[] |
type | "select/multiple" |
Defined in
SelectControl
Ƭ SelectControl: Object
Type declaration
| Name | Type |
|---|---|
controlTranslations | SelectTranslation[] |
type | "select/single" |
Defined in
SelectTranslation
Ƭ SelectTranslation: Object
Type declaration
| Name | Type |
|---|---|
config? | string |
info? | string |
serviceConfigs? | ServiceConfigs |
value | string |
Defined in
TextControl
Ƭ TextControl: Object
Type declaration
| Name | Type |
|---|---|
serviceConfigs? | ServiceConfigs |
type | "text" |
Defined in
Variables
FilePathControlType
• Const FilePathControlType: "filePath"
Defined in
Functions
buildCliConfig
▸ buildCliConfig(param0): string
Exclude config keys is used when starting a node with docker and avoiding using the dataDir key because the dataDir key is used for the docker volume mount.
Parameters
| Name | Type |
|---|---|
param0 | Object |
param0.configTranslationMap? | ConfigTranslationMap |
param0.configValuesMap | ConfigValuesMap |
param0.excludeConfigKeys? | string[] |
Returns
string