@witchcraft/spellcraft
    Preparing search index...

    Function setShortcutsProp

    • Sets a settable Shortcuts property.

      Type Parameters

      • TEntries extends ShortcutsSetEntries
      • TProp extends keyof ShortcutsSetEntries
      • TEntry extends
            | {
                error: "DUPLICATE_SHORTCUT"
                | "UNKNOWN_COMMAND"
                | ChainError;
                hooks: GetShortcutHooks<"entries@add">;
                manager: Pick<Manager, "shortcuts" | "commands" | "keys"> & PickManager<
                    "options",
                    "stringifier"
                    | "conditionEquals"
                    | "evaluateCondition",
                > & Record<any, any> & PickManager<"options", "sorter">;
                val: Shortcut;
            }
            | {
                error: "MISSING";
                hooks: GetShortcutHooks<"entries@remove">;
                manager: BaseShortcutsManager;
                val: Shortcut;
            }
      • THooks extends Partial<Hooks>
      • TCheck extends boolean | "only" = true

      Parameters

      • prop: TProp
      • val: TEntry["val"]
      • manager: TEntry["manager"] & { hooks?: THooks }

        Shortcuts is mutated if check is not "only".

      • __namedParameters: { check?: TCheck } = {}

      Returns Result<
          TCheck extends "only" ? true : Shortcut<string, Condition>,

              | MultipleErrors<TEntry["error"]>
              | CanHookErrors<THooks, "canSetShortcutsProp">,
      >

    Settings

    Member Visibility