Remove dts-gen docs from JavaScript package README
X-DeepSpeech: NOBUILD
This commit is contained in:
parent
f848bf4940
commit
def8214454
@ -1,18 +1 @@
|
|||||||
Full project description and documentation on [https://deepspeech.readthedocs.io/](https://deepspeech.readthedocs.io/).
|
Full project description and documentation on [https://deepspeech.readthedocs.io/](https://deepspeech.readthedocs.io/).
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
Upon API change, it is required to generate a new `index.d.ts` type declaration
|
|
||||||
file, you have to run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install -g dts-gen
|
|
||||||
dts-gen --module deepspeech --file index.d.ts
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example usage
|
|
||||||
|
|
||||||
See `client.ts`
|
|
||||||
|
Loading…
Reference in New Issue
Block a user