@nguymin4 Could you comment?

@monotykamary Is it possible to adjust type instead of removing it?

@kibertoad without AsyncIterable the user type in the code below will be any this is bad practice in my opinion

  const stream = knexInstance<User>('users').select('*').stream();
  for await (const user of stream) {
    // user type is any
  }

@nguymin4 Breaking the type is also bad practice, especially since the stream returns a Duplex and there may be cases where a user needs to read and abort the stream; although I haven't considered that the original pull request was to cover instance types over iterables.

@monotykamary Is it possible to adjust type instead of removing it?

In that case, it might just make sense by intersecting both types:

    stream(): stream.PassThrough & AsyncIterable<ArrayMember<T>>;

@monotykamary Could you adjust the PR to do the intersection?

The intersection will not work. It doesn't resolve the type of user correctly and return any. But yeah if people are using loosely typing then we shouldn't make this change.
From API level point of view, I think we are trying to do too much at the same time with stream() which works in Javascript but not nicely in Typescript. In a sense I feel like the pipe method should be the only one return stream.Passthrough. Or alternative solution I'm thinking about is we can have asIterable() method but maybe too much work and not worth the effort.

The intersection will not work.

It seems to work fine on my end:

Does the repository have a specific typescript version target that this doesn't work on?

Doesn't seems to work for me unfortunately 🤔

Edit: Ah damn my bad. It actually works.

Ok seems to work now. So we can merge those two stream methods into one.
stream(options?: Readonly<{ [key: string]: any }>): stream.PassThrough & AsyncIterable<ArrayMember<T>>;

@monotykamary Could you also add a test for the stream.Passthrough as well? Probably something like

// $ExpectType PassThrough
knexInstance<User>('users').select('*').stream().pipe(new PassThrough());

I forgot to add this in previous PR which caused the issue.

Thank you!