is-what 3.5.0 → 3.7.1

package/.eslintignore

@@ -0,0 +1,8 @@
+# don't ever lint node_modules
+node_modules
+# don't lint build output (make sure it's set to your correct build folder name)
+dist
+# don't lint nyc coverage output
+coverage
+
+test

package/.eslintrc.js

@@ -0,0 +1,17 @@
+// 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',
+  plugins: ['@typescript-eslint', 'tree-shaking'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+  ],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    'tree-shaking/no-side-effects-in-initialization': 'error',
+  },
+}

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}
@@ -154,7 +154,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 +163,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 +172,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 +180,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)
  *
@@ -218,7 +236,7 @@ function isType(payload, type) {
     if (!(type instanceof Function)) {
         throw new TypeError('Type must be a function');
     }
-    if (!type.hasOwnProperty('prototype')) {
+    if (!Object.prototype.hasOwnProperty.call(type, 'prototype')) {
         throw new TypeError('Type is not a class');
     }
     // Classes usually have names (as functions usually have names)
@@ -233,6 +251,7 @@ exports.isBlob = isBlob;
 exports.isBoolean = isBoolean;
 exports.isDate = isDate;
 exports.isEmptyString = isEmptyString;
+exports.isError = isError;
 exports.isFile = isFile;
 exports.isFullString = isFullString;
 exports.isFunction = isFunction;
@@ -243,6 +262,7 @@ exports.isObject = isObject;
 exports.isObjectLike = isObjectLike;
 exports.isPlainObject = isPlainObject;
 exports.isPrimitive = isPrimitive;
+exports.isPromise = isPromise;
 exports.isRegExp = isRegExp;
 exports.isString = isString;
 exports.isSymbol = isSymbol;

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}
@@ -150,7 +150,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 +159,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 +168,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 +176,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)
  *
@@ -214,7 +232,7 @@ function isType(payload, type) {
     if (!(type instanceof Function)) {
         throw new TypeError('Type must be a function');
     }
-    if (!type.hasOwnProperty('prototype')) {
+    if (!Object.prototype.hasOwnProperty.call(type, 'prototype')) {
         throw new TypeError('Type is not a class');
     }
     // Classes usually have names (as functions usually have names)
@@ -222,4 +240,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, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isPlainObject, isPrimitive, isPromise, isRegExp, isString, isSymbol, isType, isUndefined };

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "is-what",
-  "version": "3.5.0",
+  "sideEffects": false,
+  "version": "3.7.1",
   "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",
-    "build": "rollup -c ./build/rollup.js && npm run test"
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "rollup": "rollup -c ./build/rollup.js",
+    "build": "npm run lint && npm run rollup && npm run test"
   },
   "repository": {
     "type": "git",
@@ -41,18 +45,29 @@
     "url": "https://github.com/mesqueeb/is-what/issues"
   },
   "homepage": "https://github.com/mesqueeb/is-what#readme",
+  "dependencies": {},
   "devDependencies": {
-    "@babel/core": "^7.7.4",
+    "@babel/core": "^7.8.7",
     "@types/babel-core": "^6.25.6",
-    "@types/jest": "^24.0.23",
+    "@types/jest": "^25.1.4",
+    "@typescript-eslint/eslint-plugin": "^2.23.0",
+    "@typescript-eslint/parser": "^2.23.0",
+    "ava": "^3.5.0",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^24.9.0",
+    "babel-jest": "^25.1.0",
     "babel-preset-env": "^1.7.0",
-    "jest": "^24.9.0",
-    "regenerator-runtime": "^0.13.3",
-    "rollup": "^1.27.4",
-    "rollup-plugin-typescript2": "^0.25.2",
-    "typescript": "^3.7.2"
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.0",
+    "eslint-plugin-tree-shaking": "^1.8.0",
+    "jest": "^25.1.0",
+    "regenerator-runtime": "^0.13.5",
+    "rollup": "^1.32.1",
+    "rollup-plugin-typescript2": "^0.26.0",
+    "ts-node": "^8.6.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}
@@ -165,7 +165,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 +175,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 +185,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 +194,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)
  *
@@ -238,10 +258,10 @@ export function isType<T extends Function> (payload: any, type: T): payload is T
   if (!(type instanceof Function)) {
     throw new TypeError('Type must be a function')
   }
-  if (!type.hasOwnProperty('prototype')) {
+  if (!Object.prototype.hasOwnProperty.call(type, 'prototype')) {
     throw new TypeError('Type is not a class')
   }
   // Classes usually have names (as functions usually have names)
-  const name: string | undefined | null = (<any>type).name
+  const name: string | undefined | null = (type as any).name
   return getType(payload) === name || Boolean(payload && payload.constructor === type)
 }

package/test/ava.ts

@@ -0,0 +1,195 @@
+import test from 'ava'
+import {
+  isError,
+  isObject,
+  isPlainObject,
+  isAnyObject,
+  isUndefined,
+  isNull,
+  isNullOrUndefined,
+  isFunction,
+  isArray,
+  isString,
+  isEmptyString,
+  isFullString,
+  isBoolean,
+  isRegExp,
+  isNumber,
+  isDate,
+  isSymbol,
+  isPrimitive,
+  isType,
+  // 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(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(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,7 +108,7 @@ 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}
@@ -122,26 +122,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)
  *

package/wallaby.conf.js

@@ -1,23 +0,0 @@
-module.exports = function (wallaby) {
-  return {
-    files: [
-      'src/**/*.ts',
-      'dist/**/*.js'
-    ],
-    tests: [
-      'test/**/*.js'
-    ],
-    env: {
-      type: 'node',
-      runner: 'node'
-    },
-    compilers: {
-      '**/*.+(js|ts)': wallaby.compilers.typeScript({allowJs: true, outDir: './bin'})
-    },
-    preprocessors: {
-      '**/*.jsts': file => file.changeExt('js').content
-    },
-    testFramework: 'jest',
-    debug: true
-  }
-}