@types/keysym

Installation

npm install --save @types/keysym

Summary

This package contains type definitions for keysym (https://github.com/substack/node-keysym).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keysym.

index.d.ts

export interface Record {
    keysym: number;
    names: string[];
    status: string;
    unicode: number;
}

/** Contains all associated keysyms, unicode characters, names, and their status */
export const records: Record[];

/**
 * Converts a keysym into an associated record describing all representations of the key
 * @param keysym - Keysym of the key
 * @returns - Associated record or undefined if one couldn't be found
 */
export function fromKeysym(keysym: number): Record | undefined;

/**
 * Converts a key name into an associated record describing all representations of the key
 * @param name - Name of the key
 * @returns - Associated record or undefined if one couldn't be found
 */
export function fromName(name: string): Record | undefined;

/**
 * Converts a unicode character or value into an array of all matching records describing all possible representations of the key
 * @param code - Unicode character or value
 * @returns - Associated records, will be empty if no matches were found
 * @throws Will throw an error if string is not one character
 */
export function fromUnicode(code: string | number): Record[];

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:38 GMT
• Dependencies: none

Credits

These definitions were written by .