createBooleanOption

Creates a boolean flag option that is true when present and false when absent.

Example

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"]);

Syntax

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

Parameters

• name (string) : option name used as --name.
• params (optional) : extra option metadata.
• params.description (string, optional) : help description.
• params.aliases (string[], optional) : short aliases like -v.

Return value

• Option<GenericName, boolean> : option parser returning a boolean.

See also

• createOption - Builds a single-value option.
• createArrayOption - Builds an array option.
• create - Builds a command using this option.