📝 Update of CLI runWithPlatform documentation

This commit is contained in:
Eric Doughty-Papassideris
2024-03-28 03:16:56 +01:00
committed by ericlinagora
parent 1aed73c16d
commit ef5bf4af94
@@ -12,10 +12,8 @@ import type { TdrivePlatform } from "../../core/platform/platform";
* Start the platform and its services, run the command (passed as * Start the platform and its services, run the command (passed as
* the `handler` callback), then cleanly shut down the platform. * the `handler` callback), then cleanly shut down the platform.
* @param prefix Prefix text to set on the Ora spinner * @param prefix Prefix text to set on the Ora spinner
* @param handler Callback to run the actual command. * @param handler Callback to run the actual command. If it returns a number,
* - If it returns a number, that will be the exit code of the process. * that will be the exit code of the process.
* - No attempt to catch errors is done here. If it throws, the platform
* shutdown will be skipped and normal unhandled exception stuff will go on.
*/ */
export default async function runWithPlatform( export default async function runWithPlatform(
prefix: string, prefix: string,