[RFC] Remove "end" event

[clue]

This PR is a RFC – any input is welcome.

Whenever we reach EOF for a stream, we invoke the end() method. This will always emit an "end" and a "close" event.

This PR aims to serve as a discussion basis whether it actually makes sense to keep both.

[clue]

Not sure about the API and its implications here, so I'm just putting this out here for now.

[cboden]

+1

close is always immediately emitted after an end emit. I think it was originally a distinction when calling end to be after jobs were finished but before resources were severed but that's not the case.

[cboden]

Also flagged this for v0.5 as it's technically an API break.

One scenario I thought of is that since end is emitted before close it could be an event priority hook for some people...I can't think of a scenario as the stream state doesn't change between events, but I suppose it could be a possible case.

[clue]

close is always immediately emitted after an end emit. I think it was originally a distinction when calling end to be after jobs were finished but before resources were severed but that's not the case.

Exactly my point, looks like a half-baked feature which never quite made it.

After looking up Node.js's documentation I stumbled upon this:

• https://nodejs.org/api/net.html#net_class_net_socket
• https://nodejs.org/api/stream.html#stream_event_end

A related blog post related to the stream2 API also includes this:

Event: 'end'
Emitted when the stream has received an EOF (FIN in TCP terminology). Indicates that no more 'data' events will happen. If the stream is also writable, it may be possible to continue writing.

As such, afaict it looks like the end event is related to half-open duplex streams. This is a feature that we currently do not support, I've just filed #27 for this.

If this is indeed the only use case, I'd suggest removing the end event.

[clue]

To be clear: I'm currently 👎 on getting this in, I'm merely hoping to spark some discussion.

IMHO we should look into #27 instead. In this case we could probably make proper use of the end event in future versions.

[clue]

See #59 instead.