Skip to content

BooleanOption

Represents a boolean option for a command.

Type parameters

Type parameterValue
T extends boolean | nullnull

Constructors

new BooleanOption()

1
new BooleanOption<T>(options?: OptionOptions<T>): BooleanOption<T>

Create a new boolean option.

Parameters

ParameterTypeDescription
options?OptionOptions<T>The options for the boolean option.

Returns

BooleanOption<T>

Source

twitchfy/packages/chatbot/src/structures/BooleanOption.ts:22

Properties

PropertyModifierTypeDefault valueDescription
defaultValuereadonlynull | TundefinedThe default value of the option.
typereadonly"boolean"'boolean'The type of the option. Set to boolean.