Add getRemoteConfig JSDoc

This commit is contained in:
Michael B. Gale
2026-06-23 16:55:23 +01:00
parent 82e5ca6c55
commit c7a94c979d

View File

@@ -39,6 +39,16 @@ export function getConfigFileInput(
return undefined;
}
/**
* Attempts to fetch a `UserConfig` from a remote `address`.
*
* @param logger The logger to use.
* @param configFile The remote address of the configuration file.
* @param apiDetails Information about how to connect to the API.
* @param validateConfig Whether to validate the configuration.
*
* @returns The `UserConfig`, if it could be fetched and parsed successfully.
*/
export async function getRemoteConfig(
logger: Logger,
configFile: string,