typings

annyang.d.ts

@@ -0,0 +1,271 @@
+export declare module annyang {
+
+    /**
+     * Options for function `start`
+     * 
+     * @export
+     * @interface StartOptions
+     */
+    export interface StartOptions {
+        /**
+         * Should annyang restart itself if it is closed indirectly, because of silence or window conflicts?
+         * 
+         * @type {boolean}
+         */
+        autoRestart? : boolean
+        /**
+         * Allow forcing continuous mode on or off. Annyang is pretty smart about this, so only set this if you know what you're doing.
+         * 
+         * @type {boolean}
+         */
+        continuous? : boolean
+    }
+
+    /**
+     * A command option that supports custom regular expressions
+     * 
+     * @export
+     * @interface CommandOptionRegex
+     */
+    export interface CommandOptionRegex {
+        /**
+         * @type {RegExp}
+         */
+        regexp: RegExp,
+        /**
+         * @type {() => any}
+         */
+        callback: () => void
+    }
+
+    /**
+     * Commands that annyang should listen to
+     * 
+     * #### Examples:
+     * ````javascript
+     * {'hello :name': helloFunction, 'howdy': helloFunction};
+     * {'hi': helloFunction};
+     * ````
+     * @export
+     * @interface CommandOption
+     */
+    export interface CommandOption {
+        [command:string]: CommandOptionRegex | (() => void)
+    }
+
+    /**
+     * Supported Events that will be triggered to listeners, you attach using `annyang.addCallback()`
+     * 
+     * `start` - Fired as soon as the browser's Speech Recognition engine starts listening
+     * `error` - Fired when the browser's Speech Recogntion engine returns an error, this generic error callback will be followed by more accurate error callbacks (both will fire if both are defined)
+     * `errorNetwork` - Fired when Speech Recognition fails because of a network error
+     * `errorPermissionBlocked` - Fired when the browser blocks the permission request to use Speech Recognition.
+     * `errorPermissionDenied` - Fired when the user blocks the permission request to use Speech Recognition.
+     * `end` - Fired when the browser's Speech Recognition engine stops
+     * `result` - Fired as soon as some speech was identified. This generic callback will be followed by either the `resultMatch` or `resultNoMatch` callbacks.
+     *     Callback functions registered to this event will include an array of possible phrases the user said as the first argument
+     * `resultMatch` - Fired when annyang was able to match between what the user said and a registered command
+     *     Callback functions registered to this event will include three arguments in the following order:
+     *       * The phrase the user said that matched a command
+     *       * The command that was matched
+     *       * An array of possible alternative phrases the user might've said
+     * `resultNoMatch` - Fired when what the user said didn't match any of the registered commands.
+     *     Callback functions registered to this event will include an array of possible phrases the user might've said as the first argument
+     */
+    export type Events = 
+        "resultstart" |
+        "error" |
+        "end" |
+        "result" |
+        "resultMatch" |
+        "resultNoMatch" |
+        "errorNetwork" |
+        "errorPermissionBlocked" |
+        "errorPermissionDenied";
+
+    /**
+     * Start listening.
+     * It's a good idea to call this after adding some commands first, but not mandatory.
+     * 
+     * @export
+     * @param {StartOptions} options
+     */
+    export function start(options : StartOptions) : void
+
+    /**
+     * Stop listening, and turn off mic.
+     * 
+     * @export
+     */
+    export function abort() : void
+
+    /**
+     * Pause listening. annyang will stop responding to commands (until the resume or start methods are called), without turning off the browser's SpeechRecognition engine or the mic.
+     * 
+     * @export
+     */
+    export function pause() : void
+
+    /**
+     * Resumes listening and restores command callback execution when a result matches.
+     * If SpeechRecognition was aborted (stopped), start it.
+     * 
+     * @export
+     */
+    export function resume() : void
+
+    /**
+     * Turn on output of debug messages to the console. Ugly, but super-handy!
+     * 
+     * @export
+     * @param {boolean} [newState=true] Turn on/off debug messages
+     */
+    export function debug(newState? : boolean) : void
+
+    /**
+     * Set the language the user will speak in. If this method is not called, defaults to 'en-US'.
+     * 
+     * @export
+     * @param {string} lang
+     * @see [Languages](https://github.com/TalAter/annyang/blob/master/docs/FAQ.md#what-languages-are-supported)
+     */
+    export function setLanguage(lang : string) : void
+
+    /**
+     * Add commands that annyang will respond to. Similar in syntax to init(), but doesn't remove existing commands.
+     *
+     * #### Examples:
+     * ````javascript
+     * var commands = {'hello :name': helloFunction, 'howdy': helloFunction};
+     * var commands2 = {'hi': helloFunction};
+     *
+     * annyang.addCommands(commands);
+     * annyang.addCommands(commands2);
+     * // annyang will now listen to all three commands
+     * ````
+     * 
+     * @export
+     * @param {CommandOption} commands
+     */
+    export function addCommands(commands : CommandOption) : void
+
+    /**
+     * Remove all existing commands.
+     *
+     * #### Examples:
+     * ````javascript
+     * var commands : annyang.CommandOption = {'hello': helloFunction, 'howdy': helloFunction, 'hi': helloFunction};
+     *
+     * // Remove all existing commands
+     * annyang.removeCommands();
+     * ````
+     * @export
+     */
+    export function removeCommands() : void
+
+    /**
+     * Removes a command 
+     * #### Examples:
+     * ````javascript
+     * // Don't respond to hello
+     * annyang.removeCommands('hello');
+     * ````
+     * @export
+     * @param {string} command
+     */
+    export function removeCommands(command : string) : void
+
+    /**
+     * Removes a list of commands
+     * #### Examples:
+     * ````javascript
+     * var commands : annyang.CommandOption = {'hello': helloFunction, 'howdy': helloFunction, 'hi': helloFunction};
+     * // Add some commands
+     * annyang.addCommands(commands);
+     * // Don't respond to howdy or hi
+     * annyang.removeCommands(['howdy', 'hi']);
+     * ````
+     * 
+     * @export
+     * @param {string[]} command
+     */
+    export function removeCommands(command : string[]) : void
+
+    /**
+     * Add a callback function to be called, when a Event occures
+     * 
+     * @export
+     * @param {Events} event
+     * @param {Function} callback
+     * @param {*} [context]
+     */
+    export function addCallback(event : Events, callback : () => void, context? : any) : void
+
+    /**
+     * Add a callback function to be called, when a Event occures
+     * 
+     * @export
+     * @param {Events} event
+     * @param {(results : string[]) => void} callback
+     * @param {*} [context]
+     */
+    export function addCallback(event : Events, callback : (results : string[]) => void, context? : any) : void
+    /**
+     * @export
+     * @param {Events} event
+     * @param {(userSaid : string, commandText : string, results : string[]) => void} callback
+     * @param {*} [context]
+     */
+    export function addCallback(event : Events, callback : (userSaid : string, commandText : string, results : string[]) => void, context? : any) : void
+
+    /**
+     * @export
+     * @param {Events} [event]
+     * @param {Function} [callback]
+     */
+    export function removeCallback(event? : Events, callback? : Function) : void
+
+    /**
+     * Returns true if speech recognition is currently on.
+     * Returns false if speech recognition is off or annyang is paused.
+     * 
+     * @export
+     * @returns {boolean}
+     */
+    export function isListening() : boolean
+
+    /**
+     * Returns the instance of the browser's SpeechRecognition object used by annyang.
+     * Useful in case you want direct access to the browser's Speech Recognition engine.
+     * 
+     * @export
+     * @returns {*}
+     */
+    export function getSpeechRecognizer() : any
+
+    /**
+     * Simulate speech being recognized. This will trigger the same events and behavior as when the Speech Recognition
+     * detects speech.
+     *
+     * Can accept either a string containing a single sentence, or an array containing multiple sentences to be checked
+     * in order until one of them matches a command (similar to the way Speech Recognition Alternatives are parsed)
+     *
+     * #### Examples:
+     * ````javascript
+     * annyang.trigger('Time for some thrilling heroics');
+     * annyang.trigger(
+     *     ['Time for some thrilling heroics', 'Time for some thrilling aerobics']
+     *   );
+     * ````
+     *
+     * @export
+     * @param {string} command
+     */
+    export function trigger(command : string) : void
+
+    /**
+     * @export
+     * @param {string[]} command
+     */
+    export function trigger(command : string[]) : void
+}

package.json

@@ -25,6 +25,7 @@
   "scripts": {
     "test": "grunt test"
   },
+  "typings": "./annyang.d.ts",
   "devDependencies": {
     "grunt": "~0.4.5",
     "async": "^1.5.0",