Class Conf<Schema>

constructor

• new Conf<Schema extends StandardSchemaV1<any, any>>(
      partialOptions?: Options<Schema>,
  ): Conf<Schema>

  Creates a new config store.

  Type Parameters

  • Schema extends StandardSchemaV1<any, any>

  Parameters

  • OptionalpartialOptions: Options<Schema> = ...

    Config options.

  Returns Conf<Schema>

events

path

size

• get size(): number

  Number of top-level config items.

  Returns number

store

• get store(): SchemaValues<Schema>

  Get or replace the full config object.

  Reading this property loads and validates the config file from disk.

  Returns SchemaValues<Schema>

• set store(value: SchemaValues<Schema>): void

  Validates value and persists the schema output. Missing top-level keys are filled from the defaults option and schema defaults.

  Parameters

  • value: SchemaValues<Schema>

  Returns void

_closeWatcher

• _closeWatcher(): void

  Close the file watcher if one exists.

  Useful in tests to prevent the process from hanging.

  Returns void

[iterator]

• "[iterator]"(): Generator<SchemaEntry<Schema>, void, unknown>

  Iterate over config entries as [key, value] pairs.

  Returns Generator<SchemaEntry<Schema>, void, unknown>

appendToArray

• appendToArray<
      Key extends string
      | number
      | symbol
      | string & Record<never, never>,
  >(
      key: Key,
      value: SchemaArrayElement<Schema, Key>,
  ): void

  Append an item to an array config value.

  Creates the array when the key does not exist.

  Type Parameters

  • Key extends string | number | symbol | string & Record<never, never>

  Parameters

  • key: Key

    Array key. Supports dot notation when enabled.

  • value: SchemaArrayElement<Schema, Key>

    Item to append.

  Returns void

clear

• clear(): void

  Reset the config to the defaults option and schema default values.

  Returns void

delete

• delete(key: SchemaKeyPath<Schema>): void

  Delete a config item.

  Parameters

  • key: SchemaKeyPath<Schema>

    Item key. Supports dot notation when enabled.

  Returns void

get

• get<Key extends string | number | symbol | string & Record<never, never>>(
      key: Key,
  ): SchemaValue<Schema, Key>

  Get a config item.

  Type Parameters

  • Key extends string | number | symbol | string & Record<never, never>

  Parameters

  • key: Key

    Item key. Supports dot notation when enabled.

  Returns SchemaValue<Schema, Key>

• get<
      Key extends string
      | number
      | symbol
      | string & Record<never, never>,
      DefaultValue,
  >(
      key: Key,
      defaultValue: DefaultValue,
  ): DefaultValue | Exclude<SchemaValue<Schema, Key>, undefined>

  Get a config item, falling back to a default value when missing.

  Type Parameters

  • Key extends string | number | symbol | string & Record<never, never>
  • DefaultValue

  Parameters

  • key: Key

    Item key. Supports dot notation when enabled.

  • defaultValue: DefaultValue

    Value returned when the item does not exist.

  Returns DefaultValue | Exclude<SchemaValue<Schema, Key>, undefined>

has

• has(key: SchemaKeyPath<Schema>): boolean

  Check whether a config item exists.

  Parameters

  • key: SchemaKeyPath<Schema>

    Item key. Supports dot notation when enabled.

  Returns boolean

onDidAnyChange

• onDidAnyChange(
      callback: OnDidAnyChangeCallback<SchemaValues<Schema>>,
  ): Unsubscribe

  Watch the entire config object for changes.

  Parameters

  • callback: OnDidAnyChangeCallback<SchemaValues<Schema>>

    Called with (newValue, oldValue).

  Returns Unsubscribe

  Unsubscribe function.

onDidChange

• onDidChange<
      Key extends string
      | number
      | symbol
      | string & Record<never, never>,
  >(
      key: Key,
      callback: OnDidChangeCallback<SchemaValue<Schema, Key>>,
  ): Unsubscribe

  Watch a config key for changes.

  Type Parameters

  • Key extends string | number | symbol | string & Record<never, never>

  Parameters

  • key: Key

    Item key. Supports dot notation when enabled.

  • callback: OnDidChangeCallback<SchemaValue<Schema, Key>>

    Called with (newValue, oldValue).

  Returns Unsubscribe

  Unsubscribe function.

reset

• reset(...keys: SchemaKeyPath<Schema>[]): void

  Reset items to their default values.

  Values come from the defaults option first, then from the schema. Keys without a default are left unchanged.

  Parameters

  • ...keys: SchemaKeyPath<Schema>[]

    Keys to reset. Supports dot notation when enabled.

  Returns void

set

• set<Key extends string | number | symbol | string & Record<never, never>>(
      key: Key,
      value: SchemaValue<Schema, Key>,
  ): void

  Set one or more config items.

  Type Parameters

  • Key extends string | number | symbol | string & Record<never, never>

  Parameters

  • key: Key

    Item key. Supports dot notation when enabled.

  • value: SchemaValue<Schema, Key>

    Value to set.

  Returns void

• set(key: Partial<SchemaValues<Schema>> & Record<string, unknown>): void

  Set multiple config items.

  Parameters

  • key: Partial<SchemaValues<Schema>> & Record<string, unknown>

    Object of items to set.

  Returns void