Interface ConfigSource

packages/config/core/src/interfaces/ConfigSource.ts:53–66

 * Interface for a configuration source that can provide configuration values.
 */
export interface ConfigSource<Opts = any> {
  options: Opts;

  $onInit?(): Promise<void> | void;

  $onDestroy?(): Promise<void> | void;

  /**
   * Load configuration from the source.
   */
  getAll(): Promise<Record<string, unknown>> | Record<string, unknown>;

  watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB | void | Promise<void>;
}

export type ConfigurationExtends = (Type<ConfigSource> | ConfigSourceOptions)[];