Node.js typings (ReadStream methods)

[tarurar]

I want to talk about node/node.d.ts.
The method destroy of class fs.ReadStream is not available in the definition. I can call this method in regular javascript but not in typescript. Is it ok?

[vvakame]

please send a pull request first. I'll review it.

[DanielRosenwasser]

@tarurar where exactly is this API documented? I can't find it on Node's site.

[tarurar]

@DanielRosenwasser I don't see it either, but if you try to examine the __proto__ of the ReadStream object you will find this method:
ReadStream { open: [Function], _read: [Function], destroy: [Function], close: [Function] }

I saw examples in javascript which uses stream.destroy() to eliminate memory leaks.

[tarurar]

@vvakame ok, done

[DanielRosenwasser]

@tarurar interestingly I just saw a PR relating to this pop up:

nodejs/node#5898 (comment)

In other words, it should probably be documented, but it should be fine to add here.

[rhyek]

Hi. Just hit this. Wanted to make a PR for this, but wanted to understand the difference between the Readable class and the ReadableStream global interface.

The class is defining more methods than the interface, but a few packages I use (like dockerode) uses the global NodeJS.ReadableStream instead of the class. Seems like that may be common.

I believe the interface should define all these methods and the class should implement them, correct?

[orta]

Hi thread, we're moving DefinitelyTyped to use GitHub Discussions for conversations the @types modules in DefinitelyTyped.

To help with the transition, we're closing all issues which haven't had activity in the last 6 months, which includes this issue. If you think closing this issue is a mistake, please pop into the TypeScript Community Discord and mention the issue in the definitely-typed channel.