Typings: why does for await produce string | Buffer instead of string?

[papb]

Directly from the example from readme:

(async () => {
	for await (const path of globby.stream('*.tmp')) {
		console.log(path); // TypeScript says `path` is `string | Buffer`
	}
})();

Shouldn't path be just a string?

[sindresorhus]

It just returns a NodeJS.ReadableStream type. A stream chunk could be either a string or buffer. There must be a way to specialize it.

[papb]

@sindresorhus I see, but just to make sure: in this case, it should indeed return just a string, right? Or is there any real situation in which globby.stream can generate Buffer chunks?

In other words, is this just a matter of improving typings, or is it more complex?

[sindresorhus]

In other words, is this just a matter of improving typings, or is it more complex?

The typings.