inspect-with-kind
util.inspect
with additional type information
const inspect = ;const inspectWithKind = ; ; //=> '[ 1, 2, 3 ]'; //=> '[ 1, 2, 3 ] (array)'
Installation
npm install inspect-with-kind
API
const inspectWithKind = ;
inspectWithKind(value [, options])
value: any type
options: Object
(util.inspect
options)
Return: string
Almost the same as util.inspect
, but:
- It appends a type information to the string if the first argument is one of
boolean
,string
,number
,bigint
,Array
,RegExp
,Date
,arguments
or a plainObject
. - Error stack trace is omitted.
breakLength
option defaults toInfinity
.maxArrayLength
option defaults to10
.
const util = ;const inspectWithKind = ; // appends type infoutil; //=> '1'; //=> '1 (number)'util; //=> '\'1\''; //=> '\'1\' (string)' // doesn't appends type info, because <Buffer ...> clearly expresses what it isutil; //=> '<Buffer 31>'; //=> '<Buffer 31>' // omits stack traceutil; //=> 'Error: error!\n at repl:1:14\n at ContextifyScript ...'; //=> 'Error: error!'
Example
This module is useful for making TypeError
error messages in your Node.js library.
const inspectWithKind = ; module { if typeof v !== 'boolean' throw `Expected a Boolean value, but got .`; return !v;};
const reverse = ; ; // TypeError: Expected a Boolean value, but got /true/ (regexp).
License
ISC License © 2017 Shinnosuke Watanabe