npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

simple-speech-recognition

v1.0.3

Published

A simple wrapper for Speech Recognition APIs in the browser

Downloads

9

Readme

simple-speech-recognition

Why make it complicated if it can be simple? This small library abstracts away all those nitty-gritty details you have to pay attention to when using the browser-integrated SpeechRecognition, and lets you focus on what's important: your own code.

Speech Recognition

Speech recognition is an experimental technology, which is currently being implemented in Browsers (at the time of writing, Chrome is the only one to fully support this).

With this technology you can put in texts into your computer using voice: https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition

This library is a wrapper around the in-browser API. It "fixes" some of the quirky behaviour I've encountered and makes it more simple to be used.

Installation

Install this package using npm or yarn:

npm install simple-speech-recognition
yarn add simple-speech-recognition

Usage

Import the SpeechRecognizer class:

import SpeechRecognizer from 'simple-speech-recognition'

Create one (or more!) instance from the imported class:

const speechRecognizer = new SpeechRecognizer(options)

options can consist of the following fields:

const options = {
    SpeechRecognition: window.SpeechRecognition || window.webkitSpeechRecognition || DummySpeechRecognition,
    timeout: 1000, // The timeout until a speech recognition is completed (after the user has spoken their last word)
    resetCallback, // Callback used whenever an error happens
    resultCallback, // Callback used for results
    lang: 'en-US', // Language set on the Speech Recognition object
    interimResults: true // Whether you want to receive interim results or not
}

Simply pass an object with any fields you want to override.

The resultCallback receives the following message:

{
    transcript: 'Lorem ipsum dolor sit amet', // The recognized words
    finished: false // Whether the received message is the last one in the current recognition cycle
}

You won't receive any messages with finished: false if you passed interimResults: false to the constructor.

Example

Here is a simple example, which will log speech recognition results to the console:

import SpeechRecognizer from 'simple-speech-recognition'

const speechRecognizer = new SpeechRecognizer({
    resultCallback: ({ transcript, finished }) => console.log(transcript)
})

speechRecognizer.start()