Skip to content

Commit ff05e1e

Browse files
committed
Add Configuration Path and Configuration Loader Callback type aliases
1 parent 241f920 commit ff05e1e

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed
+13-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
/**
2-
* Configuration Items
3-
*
4-
* A general type for describing a key-value store containing configuration items
5-
* for an application or component.
2+
* A key-value store containing configuration items for an application or component.
63
*/
7-
export type Items = Record<PropertyKey, any>; /* eslint-disable-line @typescript-eslint/no-explicit-any */
4+
export type Items = Record<PropertyKey, any>; /* eslint-disable-line @typescript-eslint/no-explicit-any */
5+
6+
/**
7+
* A [module-name](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import#modulename) from
8+
* where configuration {@link Items} are to be loaded from.
9+
*/
10+
export type ConfigurationPath = string;
11+
12+
/**
13+
* Callback that is responsible for loading configuration {@link Items}.
14+
*/
15+
export type ConfigurationLoaderCallback = () => Promise<Items>;

0 commit comments

Comments
 (0)