Mention passing errors in the docs #949
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Matteo Collina <matteo.collina@gmail.com>
jsumners
reviewed
Jan 13, 2021
docs/api.md
Outdated
| <a id="errors"></a> | ||
| #### Errors | ||
|
|
||
| Errors can be supplied as either the first parameter or if already using `mergingObject` then as the `err` on the `mergingObject`. |
There was a problem hiding this comment.
This is accurate if the user has not customized the serializers, e.g.:
const logger = pino({
serializers: {
error: stdSerializers.error
}
})In the above, the err serializer, as described in this documentation, will not be defined. Instead, it is renamed to error. So:
// Will not serialize
logger.error({ err: Error('boom') })
// Will serialize
logger.error({ error: Error('boom') })There was a problem hiding this comment.
Tried to point this out, let me know if you have a more concise sentence.
jsumners
reviewed
Jan 13, 2021
jsumners
reviewed
Jan 13, 2021
Co-authored-by: James Sumners <james@sumners.email>
This was referenced Mar 15, 2021
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
fixes #948