https://github.com/saqqdy/grace-recognition
A composition api for SpeechRecognition
https://github.com/saqqdy/grace-recognition
Last synced: 4 months ago
JSON representation
A composition api for SpeechRecognition
- Host: GitHub
- URL: https://github.com/saqqdy/grace-recognition
- Owner: saqqdy
- License: mit
- Created: 2023-03-30T08:14:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T12:12:12.000Z (about 2 years ago)
- Last Synced: 2025-06-24T08:02:02.567Z (4 months ago)
- Language: TypeScript
- Size: 481 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# grace-recognition
A composition api for SpeechSynthesis
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]
[![Sonar][sonar-image]][sonar-url]
### **[Documentation](https://www.saqqdy.com/grace-recognition)** • **[Change Log](./CHANGELOG.md)**
## Installing
```bash
# use pnpm
$ pnpm install grace-recognition
# use npm
$ npm install grace-recognition --save
# use yarn
$ yarn add grace-recognition
```
## Usage
1. Simple use:
```ts
export type RecognitionEventType =
| 'start'
| 'audiostart'
| 'soundstart'
| 'speechstart'
| 'result'
| 'speechend'
| 'soundend'
| 'audioend'
| 'end'
| 'error'
| 'nomatch'
export interface RecognitionOptions {
preferTouchEvent: boolean
lang: 'zh-CN' | string
interimResults: boolean
maxAlternatives: number
continuous: boolean
onStatusChange?: (
status: RecognitionEventType,
event: Event | SpeechRecognitionEvent | SpeechRecognitionErrorEvent
) => void
}
import GraceRecognition from 'grace-recognition'
const recognition = new GraceRecognition({
continuous: true,
onStatusChange: (
status: RecognitionEventType,
event: Event | SpeechRecognitionEvent | SpeechRecognitionErrorEvent
) => {}
})
recognition.start('very good')
recognition.recognition('powered by saqqdy')
```
2. Using unpkg CDN:
```html
const recognition = new GraceRecognition()
```
## Support & Issues
Please open an issue [here](https://github.com/saqqdy/grace-recognition/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/grace-recognition.svg?style=flat-square
[npm-url]: https://npmjs.org/package/grace-recognition
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/grace-recognition/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/grace-recognition&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/grace-recognition.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/grace-recognition?branch=master
[download-image]: https://img.shields.io/npm/dm/grace-recognition.svg?style=flat-square
[download-url]: https://npmjs.org/package/grace-recognition
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_grace-recognition
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_grace-recognition