Options
All
  • Public
  • Public/Protected
  • All
Menu

Details of a config

Hierarchy

  • ConfigOption

Index

Properties

default: any

Default value of the option

desc?: string

Provide a description for the option

name?: string

Provide a name to display in WebUI. If not provided, WebUI will use key as the name.

needRestart?: boolean

Indicate whether user need to restart CORE to see changes.

options?: string[]

Only applies to 'string', provide options in a dropdown menu.

range?: [number, number]

Only applies to 'integer' and 'float'

type: "string" | "boolean" | "integer" | "float"

Type of the option

Methods

  • validator(data: string): string | true
  • Validator for notify user about invalid values. return true to pass the validation. return a string to send a error message to WebUI.

    Parameters

    • data: string

    Returns string | true

Generated using TypeDoc