Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

finish event listener registration error #196

Open
emarteca opened this issue Dec 2, 2019 · 0 comments
Open

finish event listener registration error #196

emarteca opened this issue Dec 2, 2019 · 0 comments

Comments

@emarteca
Copy link

emarteca commented Dec 2, 2019

Hi all, I've been working on a tool to identify instances of events registered to the wrong object in uses of some JavaScript event-driven APIs, as part of a research project.
The tool flagged line 34 in lib/catFile.js, on the registration of the “finish” event.

The reason I believe this is indicative of an error is as follows (from looking at the nodejs stream API documentation):
This registration occurs on the stream parameter of the readStream function, which looks by the comments as if it’s designed for readable streams; and on line 93 readStream is called with stderr (a readable stream) as the stream parameter.
However, “finish” is an event for writeable streams, not readable streams.
My guess is that instead of “finish”, the code should register a listener for “end”, which is the event emitted on readable streams once there is no more data to be consumed (described in the stream end event documentation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant