diff --git a/packages/config-loader/src/loader.ts b/packages/config-loader/src/loader.ts index ac6749b1a5..743adf592c 100644 --- a/packages/config-loader/src/loader.ts +++ b/packages/config-loader/src/loader.ts @@ -19,13 +19,13 @@ import { ConfigSources } from './sources'; /** * @public - * @deprecated + * @deprecated Use {@link ConfigSources.default} instead. */ export type ConfigTarget = { path: string } | { url: string }; /** * @public - * @deprecated + * @deprecated Use {@link ConfigSources.default} instead. */ export type LoadConfigOptionsWatch = { /** @@ -41,7 +41,7 @@ export type LoadConfigOptionsWatch = { /** * @public - * @deprecated + * @deprecated Use {@link ConfigSources.default} instead. */ export type LoadConfigOptionsRemote = { /** @@ -54,7 +54,7 @@ export type LoadConfigOptionsRemote = { * Options that control the loading of configuration files in the backend. * * @public - * @deprecated + * @deprecated Use {@link ConfigSources.default} instead. */ export type LoadConfigOptions = { // The root directory of the config loading context. Used to find default configs. @@ -84,7 +84,7 @@ export type LoadConfigOptions = { /** * Results of loading configuration files. * @public - * @deprecated + * @deprecated Use {@link ConfigSources.default} instead. */ export type LoadConfigResult = { /** diff --git a/packages/config-loader/src/sources/EnvConfigSource.ts b/packages/config-loader/src/sources/EnvConfigSource.ts index 3f1900b192..0e42bfe79a 100644 --- a/packages/config-loader/src/sources/EnvConfigSource.ts +++ b/packages/config-loader/src/sources/EnvConfigSource.ts @@ -26,7 +26,7 @@ import { AsyncConfigSourceIterator, ConfigSource } from './types'; */ export interface EnvConfigSourceOptions { /** - * The environment variables to use, defaults to {@link process.env}. + * The environment variables to use, defaults to `process.env`. */ env?: Record; } diff --git a/packages/config-loader/src/sources/MutableConfigSource.ts b/packages/config-loader/src/sources/MutableConfigSource.ts index c3d15bf20a..eff015ab3a 100644 --- a/packages/config-loader/src/sources/MutableConfigSource.ts +++ b/packages/config-loader/src/sources/MutableConfigSource.ts @@ -24,6 +24,8 @@ import { simpleDefer, SimpleDeferred, waitOrAbort } from './utils'; /** * Options for {@link MutableConfigSource.create}. + * + * @public */ export interface MutableConfigSourceOptions { data?: JsonObject; diff --git a/packages/config-loader/src/sources/index.ts b/packages/config-loader/src/sources/index.ts index 91cf3de624..364cc59298 100644 --- a/packages/config-loader/src/sources/index.ts +++ b/packages/config-loader/src/sources/index.ts @@ -15,10 +15,19 @@ */ export { ConfigSources } from './ConfigSources'; +export type { + BaseConfigSourcesOptions, + ClosableConfig, + ConfigSourceTarget, + ConfigSourcesDefaultForTargetsOptions, + ConfigSourcesDefaultOptions, +} from './ConfigSources'; export { EnvConfigSource, readEnvConfig } from './EnvConfigSource'; +export type { EnvConfigSourceOptions } from './EnvConfigSource'; export { FileConfigSource } from './FileConfigSource'; export type { FileConfigSourceOptions } from './FileConfigSource'; export { MutableConfigSource } from './MutableConfigSource'; +export type { MutableConfigSourceOptions } from './MutableConfigSource'; export { RemoteConfigSource } from './RemoteConfigSource'; export type { RemoteConfigSourceOptions } from './RemoteConfigSource'; export { StaticConfigSource } from './StaticConfigSource';