UNPKG

karabiner.ts-greg-mods

Version:
27 lines (26 loc) 1.18 kB
import { BasicManipulator, FromAndToKeyCode, FromKeyCode, FromKeyParam, map, SideModifierAlias, Modifier, ToKeyParam } from "karabiner.ts"; export declare const layerVarName = "__layer"; export type FromAndToKeyParam = FromKeyParam & ToKeyParam; export type BasicManipulatorBuilder = ReturnType<typeof map>; export declare function isFromAndToKeyCode(key: string | number): key is FromAndToKeyCode; export type Side = "left" | "right"; export declare const sides: Side[]; /** * Returns the side of a sided modifier alias or Modifier or null if not sided. * * Accepts SideModifierAlias (e.g., 'left_shift', '>shift') * or canonical Modifier (e.g., 'shift'). */ export declare function getSideOfMod(mod: SideModifierAlias | Modifier): Side | null; /** * Returns whether a modifier is sided. */ export declare function isSidedMod(mod: SideModifierAlias | Modifier): boolean; /** * Returns the unsided version of a modifier. */ export declare function getUnsidedMod(mod: Modifier): Modifier; /** * Returns the from key code from a BasicManipulator or null if not found. */ export declare function getFromKeyCodeFromBasicManipulator(m: BasicManipulator): FromKeyCode | null;