Class ConfigElement

Generic untyped element of the configuration from JSON file.

Hierarchy

BaseConfigElement
- ConfigElement

Index

Constructors

Properties

filePath propertyPath value

Methods

asAbsoluteUrl asAddress asArray asBoolean asEnum asInteger asObject asOneOf asString

Constructors

constructor

new ConfigElement(value: unknown, filePath: string, propertyPath: string, validators?: {
    address: AddressValidator;
    array: ArrayValidator;
    number: NumberValidator;
    oneOfSupported: OneOfSupportedValidator;
    string: StringValidator;
    type: TypeValidator;
}): ConfigElement
Parameters
- value: unknown
- filePath: string
- propertyPath: string
- validators: {
      address: AddressValidator;
      array: ArrayValidator;
      number: NumberValidator;
      oneOfSupported: OneOfSupportedValidator;
      string: StringValidator;
      type: TypeValidator;
  } = configValidators
  
  Keep it as it is - intended only for internal use.
  - address: AddressValidator
  - array: ArrayValidator
  - number: NumberValidator
  - oneOfSupported: OneOfSupportedValidator
  - string: StringValidator
  - type: TypeValidator
Returns ConfigElement

Overrides BaseConfigElement.constructor

Properties

`Readonly` filePath

filePath: string

`Readonly` propertyPath

propertyPath: string

`Readonly` value

value: unknown

Methods

asAbsoluteUrl

asAbsoluteUrl(): string
Returns string

asAddress

asAddress(prefixes?: readonly AddressPrefix[]): string
Parameters
- Optional prefixes: readonly AddressPrefix[]
Returns string

asArray

asArray(limits?: "NotEmpty"): ConfigElement[]
Parameters
- Optional limits: "NotEmpty"
Returns ConfigElement[]

asBoolean

asBoolean(): boolean
Returns boolean

asEnum

asEnum<T>(enumType: Record<string, T>): T
Type Parameters
- T extends string
Parameters
- enumType: Record<string, T>
Returns T

asInteger

asInteger(limits?: Omit<NumberLimits, "integer">): number
Parameters
- limits: Omit<NumberLimits, "integer"> = {}
Returns number

asObject

asObject<TKey>(): ConfigObjectElement<TKey>
Type Parameters
- TKey extends string
Returns ConfigObjectElement<TKey>

asOneOf

asOneOf<T>(supportedValues: readonly T[]): T
Type Parameters
- T extends string
Parameters
- supportedValues: readonly T[]
Returns T

asString

asString(limits?: StringLimits): string
Parameters
- Optional limits: StringLimits
Returns string

Generated using TypeDoc