@witchcraft/spellcraft
    Preparing search index...

    Interface RawShortcut<TRawCommand, TCommand, TCondition>

    Same as Shortcut except you're allowed to exclude all properties except the chain.

    interface RawShortcut<
        TRawCommand extends
            Command["name"]
            | Command = Command["name"] | Command,
        TCommand extends
            TRawCommand extends string ? Command<TRawCommand> : TRawCommand = TRawCommand extends string
            ? Command<TRawCommand>
            : TRawCommand,
        TCondition extends Condition = Condition,
    > {
        chain: (string | Key)[][];
        command?: TRawCommand;
        condition?: TCondition;
        enabled?: boolean;
        forceUnequal?: boolean;
        type?: "shortcut";
    }

    Type Parameters

    Hierarchy

    Index

    Properties

    chain command? condition? enabled? forceUnequal? type?

    Properties

    chain: (string | Key)[][]
    command?: TRawCommand
    condition?: TCondition

    The Condition a shortcut is allowed to be triggered on. If both the command and the shortcut have a condition, both must be met.

    enabled?: boolean

    Whether the shortcut is enabled. Defaults to true.

    forceUnequal?: boolean

    It is sometimes useful for some shortcuts to not equal or conflict with eachother temporarily.

    Only methods that compare shortcut instances are affected.

    While the property is managed by the manager, it can be safely set then unset if not modifying anything.

    type?: "shortcut"

    Settings

    Member Visibility

    On This Page

    Properties