config-loader: API report fixes

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-04-03 15:17:59 +02:00
parent 9e6f737c80
commit fc7e071c8f
4 changed files with 17 additions and 6 deletions
+5 -5
View File
@@ -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 = {
/**
@@ -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<string, string | undefined>;
}
@@ -24,6 +24,8 @@ import { simpleDefer, SimpleDeferred, waitOrAbort } from './utils';
/**
* Options for {@link MutableConfigSource.create}.
*
* @public
*/
export interface MutableConfigSourceOptions {
data?: JsonObject;
@@ -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';