typeof-article

Get the native JavaScript type of a value, preceded by the appropriate indefinite article (either a or an), for use in error messages.

Install

Install with npm:

1$ npm install --save typeof-article

Usage

(A few of the types have some extra formatting where it makes sense. For example, instead of a regexp, it returns a regular expression, which IMHO is more readable to users. You can customize mappings if you want)

1var type = require('typeof-article');
2
3console.log(type({}));
4//=> 'an object'
5
6console.log(type([]));
7//=> 'an array'
8
9console.log(type(9));
10//=> 'a number'
11
12console.log(type(/abc/));
13//=> 'a regular expression'
14
15console.log(type(new WeakMap()));
16//=> 'a WeakMap'

Get the object of types-to-articles mappings:

1var types = require('typeof-article').types;

Also exposes a typeOf property, for getting the native type only:

1var type = require('typeof-article');
2type.types.weapmap = 'a WeakMap()';
3
4console.log(type.typeOf(new WeakMap()));
5//=> 'weakmap'

Customize

Customize any of the mappings:

1var type = require('typeof-article');
2type.types.weapmap = 'a WeakMap()';
3
4console.log(type(new WeakMap()));
5//=> 'a WeakMap()'

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Install dev dependencies:

1$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

---

This file was generated by verb-generate-readme, v0.4.2, on January 30, 2017.