DeepSpeech/native_client/javascript/README.md
Anas Abou Allaban 510d71353f Update README
Signed-off-by: Anas Abou Allaban <aabouallaban@pm.me>
2020-04-03 13:28:56 +02:00

30 lines
738 B
Markdown

Full project description and documentation on GitHub: [https://github.com/mozilla/DeepSpeech](https://github.com/mozilla/DeepSpeech).
## Generating TypeScript Type Definitions
You can generate the TypeScript type declaration file using `dts-gen`.
This requires a compiled/installed version of the DeepSpeech NodeJS client.
To generate a new `index.d.ts` type declaration file, run:
```sh
npm install -g dts-gen
dts-gen --module deepspeech --file index.d.ts
```
### Example usage
```javascript
/// index.ts
import DeepSpeech from "deepspeech";
let modelPath = '/path/to/model';
let model = new DeepSpeech.Model(modelPath);
model.setBeamWidth(1000);
let audioBuffer = ...;
model.sttWithMetadata(audioBuffer);
FreeModel(model);
```