From bc8070a41d12491ad79ac6ac4aa0e05d442cff68 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 25 Apr 2023 16:34:07 +0200 Subject: [PATCH] config-loader: add ConfigSourceIteratorItem Signed-off-by: Patrik Oldsberg --- packages/config-loader/api-report.md | 22 ++++++++------------- packages/config-loader/src/sources/index.ts | 1 + packages/config-loader/src/sources/types.ts | 17 ++++++++++------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/packages/config-loader/api-report.md b/packages/config-loader/api-report.md index 662446ad03..c6a06626c7 100644 --- a/packages/config-loader/api-report.md +++ b/packages/config-loader/api-report.md @@ -12,21 +12,9 @@ import { Observable } from '@backstage/types'; // @public export interface AsyncConfigSourceIterator - extends AsyncIterator< - { - configs: ConfigSourceData[]; - }, - void, - void - > { + extends AsyncIterator { // (undocumented) - [Symbol.asyncIterator](): AsyncIterator< - { - configs: ConfigSourceData[]; - }, - void, - void - >; + [Symbol.asyncIterator](): AsyncIterator; } // @public @@ -73,6 +61,12 @@ export interface ConfigSourceData extends AppConfig { path?: string; } +// @public +export interface ConfigSourceIteratorItem { + // (undocumented) + configs: ConfigSourceData[]; +} + // @public export class ConfigSources { static default(options: ConfigSourcesDefaultOptions): ConfigSource; diff --git a/packages/config-loader/src/sources/index.ts b/packages/config-loader/src/sources/index.ts index 364cc59298..57b285f214 100644 --- a/packages/config-loader/src/sources/index.ts +++ b/packages/config-loader/src/sources/index.ts @@ -38,4 +38,5 @@ export type { ConfigSourceData, ReadConfigDataOptions, AsyncConfigSourceIterator, + ConfigSourceIteratorItem, } from './types'; diff --git a/packages/config-loader/src/sources/types.ts b/packages/config-loader/src/sources/types.ts index 2c1641a526..c173c9cc71 100644 --- a/packages/config-loader/src/sources/types.ts +++ b/packages/config-loader/src/sources/types.ts @@ -43,12 +43,17 @@ export interface ReadConfigDataOptions { * @public */ export interface AsyncConfigSourceIterator - extends AsyncIterator<{ configs: ConfigSourceData[] }, void, void> { - [Symbol.asyncIterator](): AsyncIterator< - { configs: ConfigSourceData[] }, - void, - void - >; + extends AsyncIterator { + [Symbol.asyncIterator](): AsyncIterator; +} + +/** + * An item returned by {@link AsyncConfigSourceIterator}. + * + * @public + */ +export interface ConfigSourceIteratorItem { + configs: ConfigSourceData[]; } /**