createBooleanOption

Crée une option booléenne qui vaut true si présente et false sinon.

Exemple

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

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

const forceOption = SC.createBooleanOption("force");

const command = SC.create(
	"cleanup",
	{
		options: [verboseOption, forceOption],
	},
	({ options }) => {
		type check = ExpectType<
			typeof options,
			{
				verbose: boolean;
				force: boolean;
			},
			"strict"
		>;
	},
);

await command.execute(["--verbose", "--force"]);

Syntaxe

function createBooleanOption<GenericName extends string>(
  name: GenericName,
  params?: {
    description?: string
    aliases?: readonly string[]
  }
): Option<GenericName, boolean>

Paramètres

• name (string) : nom de l'option utilisé comme --name.
• params (optionnel) : métadonnées supplémentaires de l'option.
• params.description (string, optionnel) : description dans le help.
• params.aliases (string[], optionnel) : alias courts comme -v.

Valeur de retour

• Option<GenericName, boolean> : parseur d'option qui retourne un booléen.

Voir aussi

• createOption - Construit une option à valeur unique.
• createArrayOption - Construit une option tableau.
• create - Construit une commande utilisant cette option.