Skip to content

Commit c7a94c9

Browse files
committed
Add getRemoteConfig JSDoc
1 parent 82e5ca6 commit c7a94c9

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎src/config/file.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ export function getConfigFileInput(
3939
return undefined;
4040
}
4141

42+
/**
43+
* Attempts to fetch a `UserConfig` from a remote `address`.
44+
*
45+
* @param logger The logger to use.
46+
* @param configFile The remote address of the configuration file.
47+
* @param apiDetails Information about how to connect to the API.
48+
* @param validateConfig Whether to validate the configuration.
49+
*
50+
* @returns The `UserConfig`, if it could be fetched and parsed successfully.
51+
*/
4252
export async function getRemoteConfig(
4353
logger: Logger,
4454
configFile: string,

0 commit comments

Comments
 (0)