Package Exports

neat-stack

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (neat-stack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

inspect-with-kind

util.inspect with additional type information

const util = require('util');

util.inspect([1, 2, 3]); //=> '[ 1, 2, 3 ]'

const inspectWithKind = require('inspect-with-kind');

inspectWithKind([1, 2, 3]); //=> '[ 1, 2, 3 ] (array)'

Installation

Use npm.

npm install inspect-with-kind

API

const inspectWithKind = require('inspect-with-kind');

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, Array, RegExp, Date, arguments or a plain Object.
Error stack trace is omitted.
breakLength option defaults to Infinity.
maxArrayLength option defaults to 10.

const util = require('util');
const inspectWithKind = require('inspect-with-kind');

// appends type info
util.inspect(1); //=> '1'
inspectWithKind(1); //=> '1 (number)'
util.inspect('1'); //=> '\'1\''
inspectWithKind('1'); //=> '\'1\' (string)'

// doesn't appends type info, because <Buffer ...> clearly expresses what it is
util.inspect(Buffer.from('1')); //=> '<Buffer 31>'
inspectWithKind(Buffer.from('1')); //=> '<Buffer 31>'

// omits stack trace
util.inspect(new Error('error!')); //=> 'Error: error!\n    at repl:1:14\n    at ContextifyScript ...'
inspectWithKind(new Error('error!')); //=> 'Error: error!'

Example

This module is useful for making TypeError error messages in your Node.js library.

const inspectWithKind = require('inspect-with-kind');

module.exports = function reverse(v) {
  if (typeof v !== 'boolean') {
    throw new TypeError(`Expected a Boolean value, but got ${inspectWithKind(v)}.`);
  }

  return !v;
};

const reverse = require('./reverse.js');

reverse(/true/); // TypeError: Expected a Boolean value, but got /true/ (regexp).

License

Licensed under the MIT License.