Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ForestInstance

Hierarchy

  • ForestInstance

Index

Constructors

constructor

Properties

Private _config

_config: default

Private _token

_token: string

Private kv

kv: any

Accessors

config

  • get config(): default

host

  • get host(): string

port

  • get port(): number

token

  • get token(): string

Methods

Private drillDown

  • drillDown(state: any, path: string[]): any
  • internal

    Parameters

    • state: any
    • path: string[]

    Returns any

getArray

  • getArray(key: string): any[]
  • get value from the key on stored object. Result value is considered array. No cast is done. Returns empty array if no value is found.

    Parameters

    • key: string

    Returns any[]

getAsClass

  • getAsClass<T>(_class: T): T
  • get value from the key on stored object. Result value is considered the given class. No cast is done. Returned value is undefined if no value is found. getAsClass does not create instance. It just maps the value for typing support

    Type parameters

    • T

    Parameters

    • _class: T

    Returns T

getBool

  • getBool(key: string): boolean
  • get value from the key on stored object. No cast is done. Returns false if no value is found.

    Parameters

    • key: string

    Returns boolean

getKeyValue

  • getKeyValue<T>(key: string): Promise<T>
  • Fetch key value from vault

    Type parameters

    • T = any

    Parameters

    • key: string

    Returns Promise<T>

getNumber

  • getNumber(key: string): number
  • get value from the key on stored object. Result value is considered number. No cast is done. Returns 0 if no value is found.

    Parameters

    • key: string

    Returns number

getNumberArray

  • getNumberArray(key: string): number[]
  • get value from the key on stored object. Result value is considered number array. No cast is done. Returns empty array if no value is found.

    Parameters

    • key: string

    Returns number[]

getString

  • getString(key: string): string
  • get value from the key on stored object. Result value is considered string. No cast is done. Returns empty string if no value is found.

    Parameters

    • key: string

    Returns string

getStringArray

  • getStringArray(key: string): string[]
  • get value from the key on stored object. Result value is considered string array. No cast is done. Returns empty array if no value is found.

    Parameters

    • key: string

    Returns string[]

getValue

  • getValue(key: string): any
  • get value from the key on stored object. No cast is done. Returns undefined if no value is found.

    Parameters

    • key: string

    Returns any

isExist

  • isExist(key: string): boolean
  • check if value exist from the key on stored object. Returns false if no value is found.

    Parameters

    • key: string

    Returns boolean

manageKeyValue

  • manageKeyValue(key: string): Promise<void>
  • Fetch key value from vault, stores the object in memory, and primes it for getString, getNumber, etc methods

    Parameters

    • key: string

    Returns Promise<void>

parseBool

  • parseBool(key: string): boolean
  • get value from the key on stored object. value is considered true if truthy, and false if falsey Returns false if no value is found.

    Parameters

    • key: string

    Returns boolean

parseNumber

  • parseNumber(key: string): number
  • get value from the key on stored object and attempt to parse it. Returns 0 if no value is found or cannot be parsed.

    Parameters

    • key: string

    Returns number

parseString

  • parseString(key: string): string
  • get value from the key on stored object and attempt to parse it. Returns empty string if no value is found.

    Parameters

    • key: string

    Returns string

Generated using TypeDoc