All files index.ts

0% Statements 0/1
100% Branches 1/1
100% Functions 1/1
0% Lines 0/1

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                                                             
/**
 * @packageDocumentation
 *
 * This is the main entry point for the npm package `'aac-voice-api'`.
 * It exports the core classes, functions, and types that
 * make up the public API of the library.
 *
 * @example
 * ```ts
 * import { AACVoiceAPI } from 'aac-voice-api';
 *
 * // Create an instance of the voice API
 * const voice = new AACVoiceAPI();
 *
 * // Add a voice command
 * voice.addVoiceCommand({
 *   name: "jump",
 *   action: () => console.log("player jumped"),
 *   description: "Activates the jump command",
 *   active: true,
 * });
 *
 * // Initialize the API
 * // Whisper Models can be found at https://huggingface.co/ggerganov/whisper.cpp/tree/main
 * voice.initiate("url", "en");
 *
 * // Start listening for voice commands
 * voice.start();
 * ```
 */
export { AACVoiceAPI } from "./AACVoiceAPI";