Fix types for pino.multistream

[clemyan]

Fixes TypeScript types for pino.multistream.

Also, the implementation of pino.multistream is actually pretty loose with the first argument. It can handle:

• An object with stream and optionally level properties (i.e. a StreamEntry)
• An object with a write method (i.e. a DestinationStream)
• An array of the above

However, only array of StreamEntry is documented, and the current types reflect that. I don't know if that is intentional, so I have not changed that for now. If not, then the correct type should be (DestinationStream | StreamEntry)[] | DestinationStream | StreamEntry

[mcollina]

could you add tests for the types? They live in: https://github.com/pinojs/pino/tree/master/test/types

[clemyan]

Added tests.

How about the first argument? Should we change the types to more closely align with the actual implementation, or just stick to the documented JS usage?

[mcollina]

Added tests.

Thanks

How about the first argument? Should we change the types to more closely align with the actual implementation, or just stick to the documented JS usage?

I'm lost. I think the types are ok as is, but maybe I'm missing some detail.

[mcollina]

lgtm

[clemyan]

I'm lost. I think the types are ok as is, but maybe I'm missing some detail.

Well, in terms of the implementation, pino.multistream is pretty liberal with it first argument. Each of the following works as expected

pino.multistream(process.stdout) // Single stream
pino.multistream([process.stdout]) // Array of streams
pino.multistream({ stream: process.stdout, level: 'info' }) // Single StreamEntry
pino.multistream([{ stream: process.stdout, level: 'info' }]) // Array of StreamEntries

// Mixed array
pino.multistream([
	process.stdout,
	{ stream: process.stderr, level: 'error' },
]) 

However, only the "Array of StreamEntries" usage is documented. So the TypeScript types in this PR only allows array of StreamEntries. Question is whether the types should allow any or all of the other cases.

[mcollina]

I think we should document all signatures and allow them in TS. Could you get them in?

[clemyan]

I have added the other signatures to the types and tests.

[mcollina]

lgtm

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.