cli-testing-library/src/user-event/keyboard/index.ts

Simple and complete CLI testing utilities that encourage good testing practices.

import { keyboardImplementation } from "./keyboardImplementation";
import { defaultKeyMap } from "./keyMap";
import type { TestInstance } from "../../types";
import type { keyboardKey, keyboardOptions } from "./types";

export type { keyboardOptions, keyboardKey };

export function keyboard(
  instance: TestInstance,
  text: string,
  options?: Partial<keyboardOptions & { delay: number }>,
): void | Promise<void> {
  const { promise } = keyboardImplementationWrapper(instance, text, options);

  if ((options?.delay ?? 0) > 0) {
    return promise;
  } else {
    // prevent users from dealing with UnhandledPromiseRejectionWarning in sync call
    promise.catch(console.error);
  }
}

export function keyboardImplementationWrapper(
  instance: TestInstance,
  text: string,
  config: Partial<keyboardOptions> = {},
): {
  promise: Promise<void>;
} {
  const { delay = 0, keyboardMap = defaultKeyMap } = config;
  const options = {
    delay,
    keyboardMap,
  };

  return {
    promise: keyboardImplementation(instance, text, options),
  };
}