@witchcraft/spellcraft
    Preparing search index...

    Function setKeysProp

    • Sets a settable Keys property.

      Type Parameters

      • TEntries extends KeysSetEntries
      • TProp extends
            | "entries@add"
            | "entries@remove"
            | `toggles@add@${string}`
            | `toggles@remove@${string}`
            | `variants@add@${string}`
            | `variants@remove@${string}`
            | "nativeModifierKeys"
            | "nativeToggleKeys"
            | "layout"
      • TEntry extends
            | {
                error: "INVALID_VARIANT_PAIR"
                | "DUPLICATE_KEY";
                hooks: GetKeyHooks<"entries@add">;
                manager: BaseKeysManager;
                val: Key;
            }
            | {
                error: "MISSING"
                | "KEY_IN_USE";
                hooks: GetKeyHooks<"entries@remove">;
                manager: PickManager<"options", "stringifier"> & Record<any, any> & Pick<
                    Manager,
                    "keys",
                > & Pick<Manager, "shortcuts" | "commands">;
                val: Key;
            }
            | {
                error: never;
                hooks: GetKeyHooks<`variants@${"add" | "remove"}@${string}`>;
                manager: BaseKeysManager;
                val: Key;
            }
            | {
                error: never;
                hooks: GetKeyHooks<`variants@${"add" | "remove"}@${string}`>;
                manager: BaseKeysManager;
                val: string;
            }
            | {
                error: never;
                hooks: GetKeyHooks<"nativeModifierKeys" | "nativeToggleKeys">;
                manager: BaseKeysManager;
                val: string[];
            }
            | {
                error: never;
                hooks: GetKeyHooks<"layout">;
                manager: BaseKeysManager;
                val: { x: number; y: number };
            }
      • THooks extends Partial<Hooks>
      • TCheck extends boolean | "only" = true

      Parameters

      Returns Result<
          TCheck extends "only" ? true : Key,
          MultipleErrors<TEntry["error"]> | CanHookErrors<THooks, "canSetKeysProp">,
      >