All files / src/lib/scriptEventsHandlers handlerApi.ts

100% Statements 6/6
100% Branches 0/0
100% Functions 3/3
100% Lines 5/5

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 439x     9x     12196x                                             2x                 2x        
import * as l10n from "shared/lib/lang/l10n";
import type { FileReaderFn } from "lib/scriptEventsHandlers/handlerTypes";
 
export const createScriptEventHandlerAPI = (
  readFile: FileReaderFn,
): Record<string, unknown> => {
  return {
    /* l10n(key: string, args?: Record<string, string | number>): string
     *
     * @param key - The localization key to translate
     * @param args - Optional arguments to format the translation
     * @return The translated string
     */
    l10n: l10n.default,
 
    /* readFile (filePath: string, encoding?: string): string
     *
     * @param filePath - The path to the file to read
     * @param encoding - The encoding to use when reading the file e.g "utf8" (optional)
     * @return The contents of the file in the specified encoding
     */
    readFile,
 
    /* readText (filePath: string): string
     *
     * @param filePath - The path to the file to read
     * @return The contents of the file as a string
     */
    readText: (filePath: string): string => {
      return readFile(filePath, "utf8");
    },
 
    /* readJSON (filePath: string): unknown
     *
     * @param filePath - The path to the file to read
     * @return The contents of the file as a JSON object
     */
    readJSON: (filePath: string): unknown => {
      return JSON.parse(readFile(filePath, "utf8"));
    },
  };
};