diff --git a/native_client/javascript/README.md b/native_client/javascript/README.md index 2247cb02..9c8cd861 100644 --- a/native_client/javascript/README.md +++ b/native_client/javascript/README.md @@ -11,3 +11,19 @@ To generate a new `index.d.ts` type declaration file, run: 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); +``` diff --git a/native_client/javascript/tsconfig.json b/native_client/javascript/tsconfig.json index a0ce2c4b..51b30f85 100644 --- a/native_client/javascript/tsconfig.json +++ b/native_client/javascript/tsconfig.json @@ -13,6 +13,6 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts", + "index.d.ts" ] } \ No newline at end of file