Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigStoreOptions

Data object representing the configuration of a configuration store. This object describes the configuration of a chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the retrieved configuration chunk, and you can also configures the store if it needs configuration to retrieve the configuration chunk.

Hierarchy

  • ConfigStoreOptions

Index

Constructors

constructor

Methods

getConfig

  • getConfig(): {}
  • Sets the configuration of the store

    Returns {}

    • [key: string]: any

getFormat

  • getFormat(): string
  • Sets the format of the configuration that is retrieved from the store.

    Returns string

getType

  • getType(): string
  • Sets the configuration type

    Returns string

isOptional

  • isOptional(): boolean
  • Sets whether or not the store is optional. When the configuration is retrieve, if an optional store returns a failure, the failure is ignored and an empty json object is used instead (for this store).

    Returns boolean

setConfig

  • Sets the configuration of the store

    Parameters

    • config: {}
      • [key: string]: any

    Returns ConfigStoreOptions

setFormat

  • Sets the format of the configuration that is retrieved from the store.

    Parameters

    • format: string

    Returns ConfigStoreOptions

setOptional

  • Sets whether or not the store is optional. When the configuration is retrieve, if an optional store returns a failure, the failure is ignored and an empty json object is used instead (for this store).

    Parameters

    • optional: boolean

    Returns ConfigStoreOptions

setType

  • Sets the configuration type

    Parameters

    • type: string

    Returns ConfigStoreOptions

Generated using TypeDoc