Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "values"

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

DirectoryScopeProvider

DirectoryScopeProvider: function

A function that provides one or more scope directories to map from relative paths.

Type declaration

    • (): string | string[]

    • Returns string | string[]

ValueItemStorage

ValueItemStorage: object

A storage of value items.

Type declaration

  • [name: string]: any

ValueStorage

ValueStorage: object

A value storage.

Type declaration

ValuesProvider

ValuesProvider: function

A function that provides values.

Type declaration

Variables

Const NOT_CACHED_YET

NOT_CACHED_YET: unique symbol = Symbol('NOT_CACHED_YET')

Functions

applyValuesTo

  • applyValuesTo<TObj>(obj: TObj, valueProvider: function): TObj

  • Applies values to an object.

    Type parameters

    Parameters

    • obj: TObj

      The object to apply the values to.

    • valueProvider: function

      The function that provides the values to apply to string based propertis.

    Returns TObj

    The new object.

fromBuffer

  • fromBuffer(buff: Buffer, format?: string, enc?: string, values?: Value | Value[]): any

  • Parameters

    • buff: Buffer
    • Optional format: string
    • Optional enc: string
    • Optional values: Value | Value[]

    Returns any

getEnvVars

  • Returns value instances of the current list of environment variables.

    Returns Value[]

    Placeholders of process's environment variables.

getPredefinedValues

  • getPredefinedValues(): Value[]

  • Returns a list of predefined values.

    Returns Value[]

    The list of values.

loadFromItems

normalizeValueList

normalizeValueName

  • normalizeValueName(name: any): string

replaceWithValues

  • replaceWithValues(values: Value | Value[], val: any, throwOnError?: boolean): string

  • Handles a value as string and replaces placeholders.

    Parameters

    • values: Value | Value[]

      The "placeholders".

    • val: any

      The value to parse.

    • Default value throwOnError: boolean = false

    Returns string

    The parsed value.

toValueStorage

Generated using TypeDoc