execOptions

execOptions parse les options CLI et résout le résultat sous forme de record { [optionName]: resultOption }. Si le parsing échoue, une erreur détaillée est affichée dans la console. Le --help / -h est généré automatiquement depuis les options déclarées.

Exemple

import { SC } from "@duplojs/server-utils";
import { DP } from "@duplojs/utils";

const portOption = SC.createOption(
	"port",
	DP.coerce.number(),
	{
		description: "HTTP port",
		required: true,
	},
);

const verboseOption = SC.createBooleanOption(
	"verbose",
	{
		aliases: ["v"],
		description: "Enable verbose logs",
	},
);

const options = await SC.execOptions(portOption, verboseOption);






if (options.verbose) {
	console.log(`server starts on ${options.port}`);
}

Syntaxe

function execOptions<
  GenericOptions extends [Option, ...Option[]]
>(
  ...options: GenericOptions
): Promise<ComputeResult<GenericOptions>>

Paramètres

• options ([Option, ...Option[]]) : options à parser depuis les arguments du runtime.

Valeur de retour

• Promise<ComputeResult<GenericOptions>> : promesse qui résout un objet dont les clés sont les noms d'options et les valeurs sont les résultats typés de chaque parser.

Voir aussi

• exec - Lance une commande complète depuis les arguments du runtime.
• createBooleanOption - Construit une option drapeau booléenne.
• createOption - Construit une option à valeur unique.
• createArrayOption - Construit une option tableau.