Merge pull request #17505 from backstage/rugvip/cleanup

config-loader: add ConfigSourceIteratorItem

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<ConfigSourceIteratorItem, void, void> {
   // (undocumented)
-  [Symbol.asyncIterator](): AsyncIterator<
-    {
-      configs: ConfigSourceData[];
-    },
-    void,
-    void
-  >;
+  [Symbol.asyncIterator](): AsyncIterator<ConfigSourceIteratorItem, void, void>;
 }
 
 // @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;

packages/config-loader/src/sources/index.ts

@@ -38,4 +38,5 @@ export type {
   ConfigSourceData,
   ReadConfigDataOptions,
   AsyncConfigSourceIterator,
+  ConfigSourceIteratorItem,
 } from './types';

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<ConfigSourceIteratorItem, void, void> {
+  [Symbol.asyncIterator](): AsyncIterator<ConfigSourceIteratorItem, void, void>;
+}
+
+/**
+ * An item returned by {@link AsyncConfigSourceIterator}.
+ *
+ * @public
+ */
+export interface ConfigSourceIteratorItem {
+  configs: ConfigSourceData[];
 }
 
 /**