Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

inspect-with-kind

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

inspect-with-kind

`util.inspect` with additional type information

  • 1.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
91K
decreased by-39.07%
Maintainers
1
Weekly downloads
 
Created
Source

inspect-with-kind

NPM version Build Status Coverage Status

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

Copyright (c) 2017 Shinnosuke Watanabe

Licensed under the MIT License.

Keywords

FAQs

Package last updated on 26 Jun 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc