# speechyl

> Web Speech API library wrapper

Latest version **1.0.3** (published 2019-05-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install speechyl
pnpm add speechyl
yarn add speechyl
bun add speechyl
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-05-24 |
| First published | 2016-04-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | Floriel Fedry |
| Maintainers | ffloriel |
| Keywords | Web, Speech, synthesis, recognition, html5, api, library |

## Links

- npm: https://www.npmjs.com/package/speechyl
- Repository: https://github.com/Ffloriel/speechYL
- Homepage: https://github.com/Ffloriel/speechYL#readme
- Issues: https://github.com/Ffloriel/speechYL/issues
- npm.io page: https://npm.io/package/speechyl

## Dependencies (1)

- [github-sponsors](https://npm.io/package/github-sponsors.md) ^1.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-05-24
- 1.0.2 — 2016-05-17
- 1.0.1 — 2016-04-21
- 1.0.0 — 2016-04-21

## README

[![npm](https://img.shields.io/npm/l/speechyl.svg?maxAge=2592000?style=flat-square)]()
[![npm](https://img.shields.io/npm/dt/speechyl.svg?maxAge=2592000?style=flat-square)]()

# SpeechYL

SpeechYL (spitʃ waj ɛl) is a Web Speech API library wrapper. It helps with the basic usage of web speech api. You can associate a sentence to a function with just a json object.

## Installation

### From npm

```bash
$ npm install speechyl
```

## Quick tutorial

A quick tutorial available [here](http://ffloriel.github.io/speechYL/documentation/manual/tutorial.html).

## Documentation

Documentation available [here](http://ffloriel.github.io/speechYL/documentation/).

## Usage

### Getting started

Start by importing the library if you are using ES6
```javascript
import SpeechYL from 'speechyl'
```
Or put the script file in the html file :
```html
<script src="speechYL.min.js"></script>
```

```javascript
var speechYL = new SpeechYL();
var lang = "en-EN";
speechYL.setLang(lang);
```

### Simple example commands file

```json

[
    {
        "recognition": "Hello",
        "synthesis": "Hello World"
    },
    {
        "recognition": {
            "en-EN": "log me out",
            "fr-FR": "deconnecte moi"
        },
        "func": "logOut"
    },
    {
        "recognition": {
            "en-EN": "go to the previous page",
            "fr-FR": "va a la page precedente"
        },
        "func": "goPreviousPage"
    },
    {
        "recognition": {
            "en-EN": "go to the next page",
            "fr-FR": "va a la page suivante"
        },
        "func": "goNextPage"
    },

]

```

---
_Source: https://npm.io/package/speechyl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._