Export the Stream class so type information can be imported

[sholtrop]

In TypeScript, I would like to be able to do this:

let inferenceStream: Deepspeech.Stream | null = null

To then initialize it later. However, the Stream class is not exported, and as a result neither is its type definition, meaning I cannot import it. This PR just adds the export keyword to solve this.

[community-tc-integration]

No Taskcluster jobs started for this pull request

The `allowPullRequests` configuration for this repository (in `.taskcluster.yml` on the
default branch) does not allow starting tasks for this pull request.

[lissyx]

@reuben it feels like this is something we, want to do, right ?

@sholtrop i know nothing about typescript, what would be the consequences ?

[sholtrop]

Thanks for the quick reply!
Exporting it means the class as well as its type information can be imported/used by users of the library.
The only downside is that the Stream class is not meant to be instantiated by users directly (as is noted in the docs). This will make it possible for users to do so erroneously.
Exporting ONLY the type information is also possible, if that is preferred.

[lissyx]

Exporting ONLY the type information is also possible, if that is preferred.

Yes, I think it would be better in light of that. Can you update your PR?

[sholtrop]

I've named its exported type StreamType. This means this now works:

import {StreamType, Model} from './native_client/javascript'

const model = new Model(`path/to/model`)
let stream: StreamType | null = null
if (true)
  stream = model.createStream()

[reuben]

@reuben it feels like this is something we, want to do, right ?

Yep.

[reuben]

I think we should flip the naming, export type Stream and name the class StreamImpl (and update its users)

[lissyx]

@sholtrop After you switch to StreamImpl, please make sure you have squashed all your commits into one on the PR, then we'll run CI to make sure. Thanks for spotting that!

[sholtrop]

Done! Hope I did everything correctly

[reuben]

Opened #3457 to run tests.

[lissyx]

@reuben Maybe it's worth merging this also on r0.9? A 0.9.3 could benefit from this, too bad we shipped 0.9.2 a few days ago :)

[reuben]

Yeah I think so.