Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

since

2.0.0

Hierarchy

Index

Methods

Methods

getOrElse

  • getOrElse<O, T>(property: string, other: O): T | O

  • Returns the configuration indicated by its 'property' if it exists, or a default value passed as 'other'

    since

    2.0.0

    Type parameters

    • O

    • T

    Parameters

    • property: string
    • other: O

      default value to return if property is not defined in configuration

    Returns T | O

getProperty

  • getProperty<T>(property: string): T

  • Returns the configuration indicated by its property

    throws

    {Error} if there is no such configuration property

    since

    2.0.0

    Type parameters

    • T

    Parameters

    • property: string

    Returns T

getRawObject

  • getRawObject(): object

hasProperty

  • hasProperty(property: string): boolean

  • Returns true if the property is defined in the configuration file, otherwise false

    since

    2.0.0

    Parameters

    • property: string

    Returns boolean

    true if the property is defined in the configuration file, otherwise false

setProperty

  • setProperty<T>(property: string, value: T): void

  • Assigns a value to a property.

    since

    2.0.0

    Type parameters

    • T

    Parameters

    • property: string
    • value: T

    Returns void

Generated using TypeDoc