https://github.com/ariarzer/type
Tiny library for determining the type. Can detect custom types.
https://github.com/ariarzer/type
type typeof
Last synced: 26 days ago
JSON representation
Tiny library for determining the type. Can detect custom types.
- Host: GitHub
- URL: https://github.com/ariarzer/type
- Owner: ariarzer
- License: mit
- Created: 2018-04-22T21:14:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-29T15:48:05.000Z (about 6 years ago)
- Last Synced: 2025-03-03T15:13:54.918Z (over 1 year ago)
- Topics: type, typeof
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Type
[](https://travis-ci.org/ariarzer/type)
[](https://github.com/ariarzer/type/blob/master/LICENSE)
[](https://github.com/ariarzer/type)
Tiny library for __determining the type__.
Correctly handles arrays and `null` and can detection different objects for the name of the constructor.
Everything works out of the box.
__Size__: 133 B.
### Install
```sh
npm i ariarzer/type
```
### Usage
```js
const type = require('type');
type([]); //=> 'array'
type(new Date()); //=> 'object'
```
Also you can use the second argument `true` to detection objects.
In this case the constructor name is returned in lowercase.
```js
type(new Date(), true); //=> 'date'
type(new myObject(), true); //=> 'myobject'
```
### Configuration
#### Modes:
* **Normal**: works like almost `typeof`, but it is correct to handle `null` and arrays.
* **All**: distinguishes types of objects, returns the name of the object constructor in lowercase.
Examples:
| | normal | all |
|:----------------|:-------------|:-------------|
|`undefined` |`'undefined'` |`'undefined'` |
|`null` |`'null'` |`'null'` |
|`[]` |`'array'` |`'array'` |
|`Symbol()` |`'symbol'` |`'symbol'` |
|`new WeakSet()` |`'object'` |`'weakset'` |
|`new Date()` |`'object'` |`'date'` |
|`new MyObject()` |`'object'` |`'myobject'` |
|`document.createElement('div')` |`'object'` |`'htmldivelement'` |
```js
const config = {
mode: 'all', // string: 'all' || 'normal' (default: 'normal')
}
```
Example of using modes:
```js
const type = require('type');
const myType = type.create({mode: 'all'});
myType(new myObject()); //=> 'myobject'
// But, you can run that...
type(new myObject(), true); //=> 'myobject';
// ...and get a similar result.
```
#### Custom types:
If you want to detect s custom type, for example, the days of the week, you can do this with use a config.
```js
// write a config..
const week = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'];
const customTypes = week.map((item, index) => {
return {
name: item,
is: function (arg) {
return type(arg, true) === 'date' && arg.getDay() === index;
},
};
});
// ...create a custom function...
const daysDetector = type.create(customTypes);
// ..and use it
daysDetector(new Date(2019, 4, 25)) //=> 'saturday' (May 25 2019)
daysDetector(new Date(2019, 4, 26)) //=> 'sunday' (May 26 2019)
daysDetector(new myObject()) //=> 'object'
```
You can use modes and custom types together.