is-what 3.5.1 → 3.8.0

package/.eslintrc.js

@@ -1,3 +1,4 @@
+// npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-tree-shaking
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',

package/dist/index.cjs.js

@@ -136,7 +136,7 @@ function isBoolean(payload) {
     return getType(payload) === 'Boolean';
 }
 /**
- * Returns whether the payload is a regular expression
+ * Returns whether the payload is a regular expression (RegExp)
  *
  * @param {*} payload
  * @returns {payload is RegExp}
@@ -144,6 +144,42 @@ function isBoolean(payload) {
 function isRegExp(payload) {
     return getType(payload) === 'RegExp';
 }
+/**
+ * Returns whether the payload is a Map
+ *
+ * @param {*} payload
+ * @returns {payload is Map}
+ */
+function isMap(payload) {
+    return getType(payload) === 'Map';
+}
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @param {*} payload
+ * @returns {payload is WeakMap}
+ */
+function isWeakMap(payload) {
+    return getType(payload) === 'WeakMap';
+}
+/**
+ * Returns whether the payload is a Set
+ *
+ * @param {*} payload
+ * @returns {payload is Set}
+ */
+function isSet(payload) {
+    return getType(payload) === 'Set';
+}
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @param {*} payload
+ * @returns {payload is WeakSet}
+ */
+function isWeakSet(payload) {
+    return getType(payload) === 'WeakSet';
+}
 /**
  * Returns whether the payload is a Symbol
  *
@@ -154,7 +190,7 @@ function isSymbol(payload) {
     return getType(payload) === 'Symbol';
 }
 /**
- * Returns whether the payload is a date, and that the date is Valid
+ * Returns whether the payload is a Date, and that the date is valid
  *
  * @param {*} payload
  * @returns {payload is Date}
@@ -163,7 +199,7 @@ function isDate(payload) {
     return getType(payload) === 'Date' && !isNaN(payload);
 }
 /**
- * Returns whether the payload is a blob
+ * Returns whether the payload is a Blob
  *
  * @param {*} payload
  * @returns {payload is Blob}
@@ -172,7 +208,7 @@ function isBlob(payload) {
     return getType(payload) === 'Blob';
 }
 /**
- * Returns whether the payload is a file
+ * Returns whether the payload is a File
  *
  * @param {*} payload
  * @returns {payload is File}
@@ -180,6 +216,24 @@ function isBlob(payload) {
 function isFile(payload) {
     return getType(payload) === 'File';
 }
+/**
+ * Returns whether the payload is a Promise
+ *
+ * @param {*} payload
+ * @returns {payload is Promise}
+ */
+function isPromise(payload) {
+    return getType(payload) === 'Promise';
+}
+/**
+ * Returns whether the payload is an Error
+ *
+ * @param {*} payload
+ * @returns {payload is Error}
+ */
+function isError(payload) {
+    return getType(payload) === 'Error';
+}
 /**
  * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
  *
@@ -233,9 +287,11 @@ exports.isBlob = isBlob;
 exports.isBoolean = isBoolean;
 exports.isDate = isDate;
 exports.isEmptyString = isEmptyString;
+exports.isError = isError;
 exports.isFile = isFile;
 exports.isFullString = isFullString;
 exports.isFunction = isFunction;
+exports.isMap = isMap;
 exports.isNull = isNull;
 exports.isNullOrUndefined = isNullOrUndefined;
 exports.isNumber = isNumber;
@@ -243,8 +299,12 @@ exports.isObject = isObject;
 exports.isObjectLike = isObjectLike;
 exports.isPlainObject = isPlainObject;
 exports.isPrimitive = isPrimitive;
+exports.isPromise = isPromise;
 exports.isRegExp = isRegExp;
+exports.isSet = isSet;
 exports.isString = isString;
 exports.isSymbol = isSymbol;
 exports.isType = isType;
 exports.isUndefined = isUndefined;
+exports.isWeakMap = isWeakMap;
+exports.isWeakSet = isWeakSet;

package/dist/index.esm.js

@@ -132,7 +132,7 @@ function isBoolean(payload) {
     return getType(payload) === 'Boolean';
 }
 /**
- * Returns whether the payload is a regular expression
+ * Returns whether the payload is a regular expression (RegExp)
  *
  * @param {*} payload
  * @returns {payload is RegExp}
@@ -140,6 +140,42 @@ function isBoolean(payload) {
 function isRegExp(payload) {
     return getType(payload) === 'RegExp';
 }
+/**
+ * Returns whether the payload is a Map
+ *
+ * @param {*} payload
+ * @returns {payload is Map}
+ */
+function isMap(payload) {
+    return getType(payload) === 'Map';
+}
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @param {*} payload
+ * @returns {payload is WeakMap}
+ */
+function isWeakMap(payload) {
+    return getType(payload) === 'WeakMap';
+}
+/**
+ * Returns whether the payload is a Set
+ *
+ * @param {*} payload
+ * @returns {payload is Set}
+ */
+function isSet(payload) {
+    return getType(payload) === 'Set';
+}
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @param {*} payload
+ * @returns {payload is WeakSet}
+ */
+function isWeakSet(payload) {
+    return getType(payload) === 'WeakSet';
+}
 /**
  * Returns whether the payload is a Symbol
  *
@@ -150,7 +186,7 @@ function isSymbol(payload) {
     return getType(payload) === 'Symbol';
 }
 /**
- * Returns whether the payload is a date, and that the date is Valid
+ * Returns whether the payload is a Date, and that the date is valid
  *
  * @param {*} payload
  * @returns {payload is Date}
@@ -159,7 +195,7 @@ function isDate(payload) {
     return getType(payload) === 'Date' && !isNaN(payload);
 }
 /**
- * Returns whether the payload is a blob
+ * Returns whether the payload is a Blob
  *
  * @param {*} payload
  * @returns {payload is Blob}
@@ -168,7 +204,7 @@ function isBlob(payload) {
     return getType(payload) === 'Blob';
 }
 /**
- * Returns whether the payload is a file
+ * Returns whether the payload is a File
  *
  * @param {*} payload
  * @returns {payload is File}
@@ -176,6 +212,24 @@ function isBlob(payload) {
 function isFile(payload) {
     return getType(payload) === 'File';
 }
+/**
+ * Returns whether the payload is a Promise
+ *
+ * @param {*} payload
+ * @returns {payload is Promise}
+ */
+function isPromise(payload) {
+    return getType(payload) === 'Promise';
+}
+/**
+ * Returns whether the payload is an Error
+ *
+ * @param {*} payload
+ * @returns {payload is Error}
+ */
+function isError(payload) {
+    return getType(payload) === 'Error';
+}
 /**
  * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
  *
@@ -222,4 +276,4 @@ function isType(payload, type) {
     return getType(payload) === name || Boolean(payload && payload.constructor === type);
 }
 
-export { getType, isAnyObject, isArray, isBlob, isBoolean, isDate, isEmptyString, isFile, isFullString, isFunction, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isType, isUndefined };
+export { getType, isAnyObject, isArray, isBlob, isBoolean, isDate, isEmptyString, isError, isFile, isFullString, isFunction, isMap, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isPlainObject, isPrimitive, isPromise, isRegExp, isSet, isString, isSymbol, isType, isUndefined, isWeakMap, isWeakSet };

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "is-what",
   "sideEffects": false,
-  "version": "3.5.1",
+  "version": "3.8.0",
   "description": "JS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "typings": "types/index.d.ts",
   "scripts": {
+    "ava": "ava",
     "test": "jest",
     "test-w": "jest --watchAll",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
@@ -44,23 +45,33 @@
     "url": "https://github.com/mesqueeb/is-what/issues"
   },
   "homepage": "https://github.com/mesqueeb/is-what#readme",
+  "dependencies": {},
   "devDependencies": {
-    "@babel/core": "^7.8.3",
+    "@babel/core": "^7.9.0",
     "@types/babel-core": "^6.25.6",
-    "@types/jest": "^24.9.0",
-    "@typescript-eslint/eslint-plugin": "^2.16.0",
-    "@typescript-eslint/parser": "^2.16.0",
+    "@types/jest": "^25.2.1",
+    "@typescript-eslint/eslint-plugin": "^2.27.0",
+    "@typescript-eslint/parser": "^2.27.0",
+    "ava": "^3.6.0",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^24.9.0",
+    "babel-jest": "^25.3.0",
     "babel-preset-env": "^1.7.0",
     "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.9.0",
+    "eslint-config-prettier": "^6.10.1",
     "eslint-plugin-tree-shaking": "^1.8.0",
-    "jest": "^24.9.0",
-    "regenerator-runtime": "^0.13.3",
-    "rollup": "^1.29.0",
-    "rollup-plugin-typescript2": "^0.25.3",
-    "typescript": "^3.7.5"
+    "jest": "^25.3.0",
+    "regenerator-runtime": "^0.13.5",
+    "rollup": "^1.32.1",
+    "rollup-plugin-typescript2": "^0.26.0",
+    "ts-node": "^8.8.2",
+    "typescript": "^3.8.3"
   },
-  "dependencies": {}
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  }
 }

package/src/index.ts

@@ -145,7 +145,7 @@ export function isBoolean (payload: any): payload is boolean {
 }
 
 /**
- * Returns whether the payload is a regular expression
+ * Returns whether the payload is a regular expression (RegExp)
  *
  * @param {*} payload
  * @returns {payload is RegExp}
@@ -154,6 +154,46 @@ export function isRegExp (payload: any): payload is RegExp {
   return getType(payload) === 'RegExp'
 }
 
+/**
+ * Returns whether the payload is a Map
+ *
+ * @param {*} payload
+ * @returns {payload is Map}
+ */
+export function isMap (payload: any): payload is Map<any, any> {
+  return getType(payload) === 'Map'
+}
+
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @param {*} payload
+ * @returns {payload is WeakMap}
+ */
+export function isWeakMap (payload: any): payload is WeakMap<any, any> {
+  return getType(payload) === 'WeakMap'
+}
+
+/**
+ * Returns whether the payload is a Set
+ *
+ * @param {*} payload
+ * @returns {payload is Set}
+ */
+export function isSet (payload: any): payload is Set<any> {
+  return getType(payload) === 'Set'
+}
+
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @param {*} payload
+ * @returns {payload is WeakSet}
+ */
+export function isWeakSet (payload: any): payload is WeakSet<any> {
+  return getType(payload) === 'WeakSet'
+}
+
 /**
  * Returns whether the payload is a Symbol
  *
@@ -165,7 +205,7 @@ export function isSymbol (payload: any): payload is symbol {
 }
 
 /**
- * Returns whether the payload is a date, and that the date is Valid
+ * Returns whether the payload is a Date, and that the date is valid
  *
  * @param {*} payload
  * @returns {payload is Date}
@@ -175,7 +215,7 @@ export function isDate (payload: any): payload is Date {
 }
 
 /**
- * Returns whether the payload is a blob
+ * Returns whether the payload is a Blob
  *
  * @param {*} payload
  * @returns {payload is Blob}
@@ -185,7 +225,7 @@ export function isBlob (payload: any): payload is Blob {
 }
 
 /**
- * Returns whether the payload is a file
+ * Returns whether the payload is a File
  *
  * @param {*} payload
  * @returns {payload is File}
@@ -194,6 +234,26 @@ export function isFile (payload: any): payload is File {
   return getType(payload) === 'File'
 }
 
+/**
+ * Returns whether the payload is a Promise
+ *
+ * @param {*} payload
+ * @returns {payload is Promise}
+ */
+export function isPromise (payload: any): payload is Promise<any> {
+  return getType(payload) === 'Promise'
+}
+
+/**
+ * Returns whether the payload is an Error
+ *
+ * @param {*} payload
+ * @returns {payload is Error}
+ */
+export function isError (payload: any): payload is Error {
+  return getType(payload) === 'Error'
+}
+
 /**
  * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
  *

package/test/ava.ts

@@ -0,0 +1,207 @@
+import test from 'ava'
+import {
+  isError,
+  isObject,
+  isPlainObject,
+  isAnyObject,
+  isUndefined,
+  isNull,
+  isNullOrUndefined,
+  isFunction,
+  isArray,
+  isString,
+  isEmptyString,
+  isFullString,
+  isBoolean,
+  isRegExp,
+  isNumber,
+  isDate,
+  isSymbol,
+  isPrimitive,
+  isType,
+  isMap,
+  isWeakMap,
+  isSet,
+  isWeakSet,
+  // isBlob,
+  // isFile,
+  isPromise,
+} from '../src/index'
+
+// const blob = Buffer.from([])
+
+test('Basic true tests', t => {
+  t.is(isError(new Error('')), true)
+  t.is(isUndefined(undefined), true)
+  t.is(isNull(null), true)
+  t.is(isNullOrUndefined(null), true)
+  t.is(isNullOrUndefined(undefined), true)
+  t.is(isObject({}), true)
+  t.is(isObject(new Object()), true)
+  t.is(
+    isFunction(_ => {}),
+    true
+  )
+  t.is(isArray([]), true)
+  t.is(isArray(new Array()), true)
+  t.is(isString(''), true)
+  t.is(isString('_'), true)
+  t.is(isEmptyString(''), true)
+  t.is(isFullString(' '), true)
+  t.is(isBoolean(true), true)
+  t.is(isBoolean(false), true)
+  t.is(isRegExp(/./), true)
+  t.is(isRegExp(/./gi), true)
+  t.is(isNumber(0), true)
+  t.is(isNumber(1), true)
+  t.is(isDate(new Date()), true)
+  t.is(isSymbol(Symbol()), true)
+  t.is(isMap(new Map()), true)
+  t.is(isWeakMap(new WeakMap()), true)
+  t.is(isSet(new Set()), true)
+  t.is(isWeakSet(new WeakSet()), true)
+  // t.is(isBlob(blob), true)
+  // t.is(isFile(new File([''], '', { type: 'text/html' })), true)
+  t.is(isPromise(new Promise((resolve, reject) => {})), true)
+})
+
+test('Basic false tests', t => {
+  t.is(isError({}), false)
+  t.is(isNumber(NaN), false)
+  t.is(isDate(new Date('_')), false)
+  t.is(isDate(NaN), false)
+  t.is(isUndefined(NaN), false)
+  t.is(isNull(NaN), false)
+  t.is(isObject(NaN), false)
+  t.is(isFunction(NaN), false)
+  t.is(isArray(NaN), false)
+  t.is(isString(NaN), false)
+  t.is(isEmptyString(' '), false)
+  t.is(isFullString(''), false)
+  t.is(isBoolean(NaN), false)
+  t.is(isRegExp(NaN), false)
+  t.is(isSymbol(NaN), false)
+  t.is(isMap(new WeakMap()), false)
+  t.is(isWeakMap(new Map()), false)
+  t.is(isSet(new WeakSet()), false)
+  t.is(isWeakSet(new Set()), false)
+  t.is(isNullOrUndefined(NaN), false)
+})
+
+test('Primitive tests', t => {
+  // true
+  t.is(isPrimitive(0), true)
+  t.is(isPrimitive(''), true)
+  t.is(isPrimitive('str'), true)
+  t.is(isPrimitive(Symbol()), true)
+  t.is(isPrimitive(true), true)
+  t.is(isPrimitive(false), true)
+  t.is(isPrimitive(null), true)
+  t.is(isPrimitive(undefined), true)
+  // false
+  t.is(isPrimitive(NaN), false)
+  t.is(isPrimitive([]), false)
+  t.is(isPrimitive(new Array()), false)
+  t.is(isPrimitive({}), false)
+  t.is(isPrimitive(new Object()), false)
+  t.is(isPrimitive(new Date()), false)
+  t.is(
+    isPrimitive(_ => {}),
+    false
+  )
+})
+
+test('Date exception', t => {
+  t.is(isDate(new Date('_')), false)
+})
+
+test('Generic isType', t => {
+  function MyClass () {}
+  // This is correct old fashion syntax for classes, if this is missing
+  MyClass.prototype.constructor = MyClass
+  class MyOtherClass {}
+  const myClass = new MyClass()
+  // this is expected behaviour
+  t.is(isType('', String), true)
+  t.is(isType('_', String), true)
+  t.is(isType('Hello World', String), true)
+  t.is(isType(NaN, Number), true)
+  t.is(isType(0, Number), true)
+  t.is(isType(1, Number), true)
+  t.is(isType({}, Object), true)
+  t.is(isType(new Object(), Object), true)
+  t.is(isType([], Array), true)
+  t.is(isType(new Array(), Array), true)
+  t.is(
+    isType(_ => {}, Function),
+    true
+  )
+  t.is(isType(true, Boolean), true)
+  t.is(isType(false, Boolean), true)
+  t.is(isType(new Date('_'), Date), true)
+  t.is(isType(new Date(), Date), true)
+  t.is(isType(/./, RegExp), true)
+  t.is(isType(/./gi, RegExp), true)
+  t.is(isType(myClass, MyClass), true)
+  t.is(isType(new MyOtherClass(), MyOtherClass), true)
+  t.is(isType(myClass, MyOtherClass), false)
+  t.is(isType(Symbol(), Symbol), true)
+  // t.is(isType(null, Null), true)
+  // t.is(isType(undefined, Undefined), true)
+  // It SHOULD fail
+  t.is(isType(5, String), false)
+  t.is(isType(null, Object), false)
+  // Not sure if this would be the expected behaviour but everything is an object
+  // so I would say so
+  t.is(isType(myClass, Object), true)
+})
+
+test('isObject vs isAnyObject', t => {
+  function MyClass () {}
+  // This is correct old fashion syntax for classes, if this is missing
+  MyClass.prototype.constructor = MyClass
+  const myClass = new MyClass()
+  class MyClass2 {}
+  const myClass2 = new MyClass()
+  const mySpecialObject = {}
+  Object.setPrototypeOf(mySpecialObject, {
+    toDate: function () {
+      return new Date()
+    },
+  })
+  // IS OBJECT
+  // plain object
+  t.is(isObject({}), true)
+  t.is(isObject(new Object()), true)
+  t.is(isPlainObject({}), true)
+  t.is(isPlainObject(new Object()), true)
+  // classes & prototypes
+  t.is(isObject(myClass), false)
+  t.is(isObject(myClass2), false)
+  t.is(isObject(mySpecialObject), false)
+  t.is(isPlainObject(myClass), false)
+  t.is(isPlainObject(myClass2), false)
+  t.is(isPlainObject(mySpecialObject), false)
+  // arrays and dates
+  t.is(isObject([]), false)
+  t.is(isObject(new Array()), false)
+  t.is(isObject(new Date('_')), false)
+  t.is(isObject(new Date()), false)
+  t.is(isPlainObject([]), false)
+  t.is(isPlainObject(new Array()), false)
+  t.is(isPlainObject(new Date('_')), false)
+  t.is(isPlainObject(new Date()), false)
+  // IS ANY OBJECT
+  // plain object
+  t.is(isAnyObject({}), true)
+  t.is(isAnyObject(new Object()), true)
+  // classes & prototypes
+  t.is(isAnyObject(myClass), true)
+  t.is(isAnyObject(myClass2), true)
+  t.is(isAnyObject(mySpecialObject), true)
+  // arrays and dates
+  t.is(isAnyObject([]), false)
+  t.is(isAnyObject(new Array()), false)
+  t.is(isAnyObject(new Date('_')), false)
+  t.is(isAnyObject(new Date()), false)
+})

package/test/index.test.js

@@ -1,3 +1,4 @@
+// @ts-check
 import {
   isObject,
   isPlainObject,
@@ -19,6 +20,7 @@ import {
   isType,
   isBlob,
   isFile,
+  isPromise,
 } from '../dist/index.cjs'
 
 test('Basic true tests', () => {
@@ -45,6 +47,7 @@ test('Basic true tests', () => {
   expect(isSymbol(Symbol())).toBe(true)
   expect(isBlob(new Blob())).toBe(true)
   expect(isFile(new File([''], '', { type: 'text/html' }))).toBe(true)
+  expect(isPromise(new Promise((resolve, reject) => {}))).toBe(true)
 })
 
 test('Basic false tests', () => {

package/types/index.d.ts

@@ -108,12 +108,40 @@ export declare function isNumber(payload: any): payload is number;
  */
 export declare function isBoolean(payload: any): payload is boolean;
 /**
- * Returns whether the payload is a regular expression
+ * Returns whether the payload is a regular expression (RegExp)
  *
  * @param {*} payload
  * @returns {payload is RegExp}
  */
 export declare function isRegExp(payload: any): payload is RegExp;
+/**
+ * Returns whether the payload is a Map
+ *
+ * @param {*} payload
+ * @returns {payload is Map}
+ */
+export declare function isMap(payload: any): payload is Map<any, any>;
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @param {*} payload
+ * @returns {payload is WeakMap}
+ */
+export declare function isWeakMap(payload: any): payload is WeakMap<any, any>;
+/**
+ * Returns whether the payload is a Set
+ *
+ * @param {*} payload
+ * @returns {payload is Set}
+ */
+export declare function isSet(payload: any): payload is Set<any>;
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @param {*} payload
+ * @returns {payload is WeakSet}
+ */
+export declare function isWeakSet(payload: any): payload is WeakSet<any>;
 /**
  * Returns whether the payload is a Symbol
  *
@@ -122,26 +150,40 @@ export declare function isRegExp(payload: any): payload is RegExp;
  */
 export declare function isSymbol(payload: any): payload is symbol;
 /**
- * Returns whether the payload is a date, and that the date is Valid
+ * Returns whether the payload is a Date, and that the date is valid
  *
  * @param {*} payload
  * @returns {payload is Date}
  */
 export declare function isDate(payload: any): payload is Date;
 /**
- * Returns whether the payload is a blob
+ * Returns whether the payload is a Blob
  *
  * @param {*} payload
  * @returns {payload is Blob}
  */
 export declare function isBlob(payload: any): payload is Blob;
 /**
- * Returns whether the payload is a file
+ * Returns whether the payload is a File
  *
  * @param {*} payload
  * @returns {payload is File}
  */
 export declare function isFile(payload: any): payload is File;
+/**
+ * Returns whether the payload is a Promise
+ *
+ * @param {*} payload
+ * @returns {payload is Promise}
+ */
+export declare function isPromise(payload: any): payload is Promise<any>;
+/**
+ * Returns whether the payload is an Error
+ *
+ * @param {*} payload
+ * @returns {payload is Error}
+ */
+export declare function isError(payload: any): payload is Error;
 /**
  * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
  *