Class Kfg<D, S>

constructor

• new Kfg<D extends KfgDriver<any, any>, S extends SchemaDefinition>(
      driver: D,
      schema: S,
  ): Kfg<D, S>

  Creates a new instance of Kfg.

  Type Parameters

  • D extends KfgDriver<any, any>

    The type of the driver.

  • S extends SchemaDefinition

    The type of the schema.

  Parameters

  • driver: D

    The driver instance.

  • schema: S

    The schema to use for validating the configuration.

  Returns Kfg<D, S>

$store

driver

schema

$config

• get $config(): D["config"]

  Returns the driver configuration from the store.

  Returns D["config"]

del

• del<P extends string>(path: P): inPromise<D["async"], void>

  Deletes a value from the configuration.

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns inPromise<D["async"], void>

get

• get<P extends string>(
      path: P,
  ): inPromise<D["async"], DeepGet<StaticSchema<S>, P>>

  Gets a value from the configuration.

  Type Parameters

  • P extends string

  Parameters

  • path: P

    The path to the value.

  Returns inPromise<D["async"], DeepGet<StaticSchema<S>, P>>

  The value at the given path.

has

• has<P extends string>(...paths: P[]): inPromise<D["async"], boolean>

  Checks if a value exists in the configuration.

  Type Parameters

  • P extends string

  Parameters

  • ...paths: P[]

    The paths to the values.

  Returns inPromise<D["async"], boolean>

  True if all values exist, false otherwise.

inject

• inject(data: Partial<StaticSchema<S>>): inPromise<D["async"], void>

  Injects a partial value directly into the root configuration object.

  Parameters

  • data: Partial<StaticSchema<S>>

  Returns inPromise<D["async"], void>

insert

• insert<P extends string>(
      path: P,
      partial: Partial<DeepGet<StaticSchema<S>, P>>,
  ): inPromise<D["async"], void>

  Inserts a partial value into an object in the configuration.

  Type Parameters

  • P extends string

  Parameters

  • path: P
  • partial: Partial<DeepGet<StaticSchema<S>, P>>

  Returns inPromise<D["async"], void>

load

• load(
      options?: Partial<D["config"]> & { only_importants?: boolean },
  ): inPromise<D["async"], void>

  Alias for mount().

  Parameters

  • Optionaloptions: Partial<D["config"]> & { only_importants?: boolean }

  Returns inPromise<D["async"], void>

mount

• mount(
      options?: D["config"] & { only_importants?: boolean },
  ): inPromise<D["async"], void>

  Mounts the configuration using the driver.

  Parameters

  • Optionaloptions: D["config"] & { only_importants?: boolean }

    The loading options.

  Returns inPromise<D["async"], void>

reload

• reload(
      options?: Partial<D["config"]> & { only_importants?: boolean },
  ): inPromise<D["async"], void>

  Reloads the configuration.

  Parameters

  • Optionaloptions: Partial<D["config"]> & { only_importants?: boolean }

    The loading options.

  Returns inPromise<D["async"], void>

save

• save(data?: any): inPromise<D["async"], void>

  Saves the configuration.

  Parameters

  • Optionaldata: any

    Optional data to save.

  Returns inPromise<D["async"], void>

set

• set<P extends string>(
      path: P,
      value: DeepGet<StaticSchema<S>, P>,
      options?: { description?: string },
  ): inPromise<D["async"], void>

  Sets a value in the configuration.

  Type Parameters

  • P extends string

  Parameters

  • path: P
  • value: DeepGet<StaticSchema<S>, P>
  • Optionaloptions: { description?: string }

  Returns inPromise<D["async"], void>

toJSON

• toJSON(): StaticSchema<S>

  Returns cached data.

  Returns StaticSchema<S>

unmount

• unmount(): void

  Unmounts the driver.

  Returns void