Added documentation for MultiStreamRes, StreamEntry, DestinationStream and Level #1342
+133
−17
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Should solve #1327
This PR introduces 2 top-level sections in the documentation:
Interfaces
andTypes
Each describes respectively the interfaces and types involved in the object returned by
pino.multistream()
which is otherwise undocumented.Also:
pino.multistream().add
intest/multistream.test.js
pino.multistream().add
intest/multistream.test.js
pino.multistream
andpino.multistream.add
now throw Error if provided with an invalid stream object