Correct Client.stream return type: from EventEmitter to ResultStream

[p-flock]

The client implementation of the stream method returns a ResultStream. This commit corrects the type listed in the index.ts file to line up with the implementation

[p-flock]

Just pre-emptively saying I have signed the datastax CLA

[absurdfarce]

Thanks for the PR @p-flock! And for the pre-emptive note about the CLA. ;)

With regard to the change itself, the intent of the stream() interface is to provide an easy entry point for handlers of streaming events along the lines of what's laid out in the documentation. I could perhaps see a case for making the returned type stream.Readable in order to expose some additional context but it's not immediately clear to me that you buy much by going a step further and marking that function as returning types.ResultStream. Is there some specific bit of functionality on types.ResultStream that you're looking to expose? I'm not opposed to the idea necessarily.. I'm just trying to get a better handle on your use case in order to understand the proposed change.

Thanks again!

[p-flock]

Thanks for the PR @p-flock! And for the pre-emptive note about the CLA. ;)

With regard to the change itself, the intent of the stream() interface is to provide an easy entry point for handlers of streaming events along the lines of what's laid out in the documentation. I could perhaps see a case for making the returned type stream.Readable in order to expose some additional context but it's not immediately clear to me that you buy much by going a step further and marking that function as returning types.ResultStream. Is there some specific bit of functionality on types.ResultStream that you're looking to expose? I'm not opposed to the idea necessarily.. I'm just trying to get a better handle on your use case in order to understand the proposed change.

Thanks again!

thanks for following up @absurdfarce , sorry for the delayed response.

The change I'm hoping to make is not actually to the implementation, just to correct the type that is specified in the index.ts file.

the client implementation of stream
has @returns {ResultStream} in it's docblock, and that matches the implementation below.

what I believe is incorrect is the index.d.ts file which lists the return type of this method as events.EventEmitter which causes unexpected type errors for typescript libraries or applications which rely on that method.

For example in my application I cast the result of Client.streamcalls with as unknown as Readable, because that matches the runtime behavior of the the datastax driver.

It's possible I'm mistaken and there is good reason for the type specified in the definition file to be events.EventEmitter, but when I first came across this it seemed like a simple issue of the type definition file not being maintained along with library updates, since this library is not actually compiled with typescript it is very understandable for the mismatch to go unnoticed.

This change would also make the listed type make more sense alongside other Client class methods, e.g. execute which has it's return type listed as Promise<types.ResultSet> in the index.d.ts file, matching the doc-block and implementation in the library code.

As you mentioned, it would also be correct to have the specified return type be stream.Readable, and would be just as functional for library users. I figured I would stay in line with the other methods convention of using the internal type, in this case types.ResultStream, but happy to amend my commit to use stream.Readable if you would prefer.