Expose inspect to allow custom object formatting #266
Closed
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.
This PR exposes the
inspect
method, which is used to format objects for the%o
formatting directive, so that it can be called or replaced to suit the needs of users.Some use cases for this are #185 (inspect with same coloring as debug) and #263 ("better" object formatting). My primary use case is to log objects with a smaller depth to avoid spamming the logs from large/deep objects. Other use cases include using the
showHidden
andcustomInspect
options of
util.inspect
.Why not just use
util.inspect
or another custom formatting function directly? My major reasons are:.useColors
property.Note: This PR currently exposes the
.inspect
property both ondebug
itself and on the instances. It can be useful for overriding, but if you wanted to minimize the API expansion, it could be exposed as_inspect
ondebug
or otherwise hidden.Thanks for considering,
Kevin