The stream/promises API is poorly documented #45821

Affected URL(s)

https://nodejs.org/api/stream.html#streams-promises-api

Description of the problem

The stream docs page doesn't describe the signature of node:stream/promises pipeline & finished functions.

This is aggravated by the fact that the promise version of stream.pipeline() accepts an options object as last parameter, but the docs doesn't document its properties properly.

The only reference to it is the following paragraph:

The pipeline API provides a promise version, which can also receive an options argument as the last parameter with a signal <AbortSignal> property. When the signal is aborted, destroy will be called on the underlying pipeline, with an AbortError.

Although its note about the options.signal property, the paragraph leaves the property end: boolean (#34805 (comment)) completely undocumented.