is-what 3.11.0 → 3.12.0

package/.eslintignore

@@ -6,3 +6,4 @@ dist
 coverage
 
 test
+.eslintrc.js

package/.eslintrc.js

@@ -13,5 +13,6 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/ban-ts-ignore': 'off',
     'tree-shaking/no-side-effects-in-initialization': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'off'
   },
 }

package/README.md

@@ -1,10 +1,12 @@
 # is What? 🙉
 
+Very simple & small JS type check functions. It's fully TypeScript supported!
+
 ```
 npm i is-what
 ```
 
-Very simple & small JS type check functions. It's fully TypeScript supported!
+Or for deno available at: `"deno.land/x/is_what"`
 
 ## Motivation
 
@@ -110,7 +112,7 @@ getType(specialObject) // returns 'Object'
 
 is-what makes TypeScript know the type during if statements. This means that a check returns the type of the payload for TypeScript users.
 
-```TypeScript
+```ts
 function isNumber (payload: any): payload is number {
   // return boolean
 }
@@ -127,7 +129,7 @@ function fn (payload: string | number): number {
 
 `isPlainObject` and `isAnyObject` with TypeScript will declare the payload to be an object type with any props:
 
-```TypeScript
+```ts
 function isPlainObject (payload: any): payload is {[key: string]: any}
 function isAnyObject (payload: any): payload is {[key: string]: any}
 // The reason to return `{[key: string]: any}` is to be able to do
@@ -139,7 +141,7 @@ if (isPlainObject(payload) && payload.id) return payload.id
 
 If you want more control over which kind of objects are allowed you can use `isObjectLike<T>`:
 
-```TypeScript
+```ts
 import { isObjectLike } from 'is-what'
 // usage examples:
 isObjectLike<{specificKey: string}>(payload)
@@ -149,7 +151,7 @@ isObjectLike<object>(payload)
 
 `isObjectLike<T>` works like this under the hood:
 
-```TypeScript
+```ts
 function isObjectLike<T extends object> (payload: any): payload is T {
   return isAnyObject(payload)
 }

package/{build/rollup.js → build.js}

@@ -18,7 +18,7 @@ import typescript from 'rollup-plugin-typescript2'
 // ------------------------------------------------------------------------------------------
 // setup
 // ------------------------------------------------------------------------------------------
-const pkg = require('../package.json')
+const pkg = require('./package.json')
 const name = pkg.name
 const className = name.replace(/(^\w|-\w)/g, c => c.replace('-', '').toUpperCase())
 const external = Object.keys(pkg.dependencies || [])

package/dist/index.cjs.js

@@ -33,7 +33,7 @@ function isNull(payload) {
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isPlainObject(payload) {
     if (getType(payload) !== 'Object')
@@ -44,7 +44,7 @@ function isPlainObject(payload) {
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isObject(payload) {
     return isPlainObject(payload);
@@ -53,7 +53,7 @@ function isObject(payload) {
  * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {}}
+ * @returns {payload is { [K in any]: never }}
  */
 function isEmptyObject(payload) {
     return isPlainObject(payload) && Object.keys(payload).length === 0;
@@ -62,7 +62,7 @@ function isEmptyObject(payload) {
  * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isAnyObject(payload) {
     return getType(payload) === 'Object';
@@ -80,23 +80,32 @@ function isObjectLike(payload) {
     return isAnyObject(payload);
 }
 /**
- * Returns whether the payload is a function
+ * Returns whether the payload is a function (regular or async)
  *
  * @param {*} payload
- * @returns {payload is Function}
+ * @returns {payload is AnyFunction}
  */
 function isFunction(payload) {
-    return getType(payload) === 'Function';
+    return typeof payload === "function";
 }
 /**
  * Returns whether the payload is an array
  *
- * @param {*} payload
- * @returns {payload is undefined}
+ * @param {any} payload
+ * @returns {payload is any[]}
  */
 function isArray(payload) {
     return getType(payload) === 'Array';
 }
+/**
+ * Returns whether the payload is a an array with at least 1 item
+ *
+ * @param {*} payload
+ * @returns {payload is any[]}
+ */
+function isFullArray(payload) {
+    return isArray(payload) && payload.length > 0;
+}
 /**
  * Returns whether the payload is a an empty array
  *
@@ -134,9 +143,9 @@ function isEmptyString(payload) {
     return payload === '';
 }
 /**
- * Returns whether the payload is a number
+ * Returns whether the payload is a number (but not NaN)
  *
- * This will return false for NaN
+ * This will return `false` for `NaN`!!
  *
  * @param {*} payload
  * @returns {payload is number}
@@ -166,7 +175,7 @@ function isRegExp(payload) {
  * Returns whether the payload is a Map
  *
  * @param {*} payload
- * @returns {payload is Map}
+ * @returns {payload is Map<any, any>}
  */
 function isMap(payload) {
     return getType(payload) === 'Map';
@@ -175,7 +184,7 @@ function isMap(payload) {
  * Returns whether the payload is a WeakMap
  *
  * @param {*} payload
- * @returns {payload is WeakMap}
+ * @returns {payload is WeakMap<any, any>}
  */
 function isWeakMap(payload) {
     return getType(payload) === 'WeakMap';
@@ -184,7 +193,7 @@ function isWeakMap(payload) {
  * Returns whether the payload is a Set
  *
  * @param {*} payload
- * @returns {payload is Set}
+ * @returns {payload is Set<any>}
  */
 function isSet(payload) {
     return getType(payload) === 'Set';
@@ -193,7 +202,7 @@ function isSet(payload) {
  * Returns whether the payload is a WeakSet
  *
  * @param {*} payload
- * @returns {payload is WeakSet}
+ * @returns {payload is WeakSet<any>}
  */
 function isWeakSet(payload) {
     return getType(payload) === 'WeakSet';
@@ -238,7 +247,7 @@ function isFile(payload) {
  * Returns whether the payload is a Promise
  *
  * @param {*} payload
- * @returns {payload is Promise}
+ * @returns {payload is Promise<any>}
  */
 function isPromise(payload) {
     return getType(payload) === 'Promise';
@@ -253,7 +262,7 @@ function isError(payload) {
     return getType(payload) === 'Error';
 }
 /**
- * Returns whether the payload is `NaN` but also a `number`
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
  *
  * @param {*} payload
  * @returns {payload is typeof NaN}
@@ -318,6 +327,7 @@ exports.isEmptyObject = isEmptyObject;
 exports.isEmptyString = isEmptyString;
 exports.isError = isError;
 exports.isFile = isFile;
+exports.isFullArray = isFullArray;
 exports.isFullString = isFullString;
 exports.isFunction = isFunction;
 exports.isMap = isMap;

package/dist/index.esm.js

@@ -29,7 +29,7 @@ function isNull(payload) {
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isPlainObject(payload) {
     if (getType(payload) !== 'Object')
@@ -40,7 +40,7 @@ function isPlainObject(payload) {
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isObject(payload) {
     return isPlainObject(payload);
@@ -49,7 +49,7 @@ function isObject(payload) {
  * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {}}
+ * @returns {payload is { [K in any]: never }}
  */
 function isEmptyObject(payload) {
     return isPlainObject(payload) && Object.keys(payload).length === 0;
@@ -58,7 +58,7 @@ function isEmptyObject(payload) {
  * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
 function isAnyObject(payload) {
     return getType(payload) === 'Object';
@@ -76,23 +76,32 @@ function isObjectLike(payload) {
     return isAnyObject(payload);
 }
 /**
- * Returns whether the payload is a function
+ * Returns whether the payload is a function (regular or async)
  *
  * @param {*} payload
- * @returns {payload is Function}
+ * @returns {payload is AnyFunction}
  */
 function isFunction(payload) {
-    return getType(payload) === 'Function';
+    return typeof payload === "function";
 }
 /**
  * Returns whether the payload is an array
  *
- * @param {*} payload
- * @returns {payload is undefined}
+ * @param {any} payload
+ * @returns {payload is any[]}
  */
 function isArray(payload) {
     return getType(payload) === 'Array';
 }
+/**
+ * Returns whether the payload is a an array with at least 1 item
+ *
+ * @param {*} payload
+ * @returns {payload is any[]}
+ */
+function isFullArray(payload) {
+    return isArray(payload) && payload.length > 0;
+}
 /**
  * Returns whether the payload is a an empty array
  *
@@ -130,9 +139,9 @@ function isEmptyString(payload) {
     return payload === '';
 }
 /**
- * Returns whether the payload is a number
+ * Returns whether the payload is a number (but not NaN)
  *
- * This will return false for NaN
+ * This will return `false` for `NaN`!!
  *
  * @param {*} payload
  * @returns {payload is number}
@@ -162,7 +171,7 @@ function isRegExp(payload) {
  * Returns whether the payload is a Map
  *
  * @param {*} payload
- * @returns {payload is Map}
+ * @returns {payload is Map<any, any>}
  */
 function isMap(payload) {
     return getType(payload) === 'Map';
@@ -171,7 +180,7 @@ function isMap(payload) {
  * Returns whether the payload is a WeakMap
  *
  * @param {*} payload
- * @returns {payload is WeakMap}
+ * @returns {payload is WeakMap<any, any>}
  */
 function isWeakMap(payload) {
     return getType(payload) === 'WeakMap';
@@ -180,7 +189,7 @@ function isWeakMap(payload) {
  * Returns whether the payload is a Set
  *
  * @param {*} payload
- * @returns {payload is Set}
+ * @returns {payload is Set<any>}
  */
 function isSet(payload) {
     return getType(payload) === 'Set';
@@ -189,7 +198,7 @@ function isSet(payload) {
  * Returns whether the payload is a WeakSet
  *
  * @param {*} payload
- * @returns {payload is WeakSet}
+ * @returns {payload is WeakSet<any>}
  */
 function isWeakSet(payload) {
     return getType(payload) === 'WeakSet';
@@ -234,7 +243,7 @@ function isFile(payload) {
  * Returns whether the payload is a Promise
  *
  * @param {*} payload
- * @returns {payload is Promise}
+ * @returns {payload is Promise<any>}
  */
 function isPromise(payload) {
     return getType(payload) === 'Promise';
@@ -249,7 +258,7 @@ function isError(payload) {
     return getType(payload) === 'Error';
 }
 /**
- * Returns whether the payload is `NaN` but also a `number`
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
  *
  * @param {*} payload
  * @returns {payload is typeof NaN}
@@ -303,4 +312,4 @@ function isType(payload, type) {
     return getType(payload) === name || Boolean(payload && payload.constructor === type);
 }
 
-export { getType, isAnyObject, isArray, isBlob, isBoolean, isDate, isEmptyArray, isEmptyObject, isEmptyString, isError, isFile, isFullString, isFunction, isMap, isNaNValue, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isPlainObject, isPrimitive, isPromise, isRegExp, isSet, isString, isSymbol, isType, isUndefined, isWeakMap, isWeakSet };
+export { getType, isAnyObject, isArray, isBlob, isBoolean, isDate, isEmptyArray, isEmptyObject, isEmptyString, isError, isFile, isFullArray, isFullString, isFunction, isMap, isNaNValue, isNull, isNullOrUndefined, isNumber, isObject, isObjectLike, isPlainObject, isPrimitive, isPromise, isRegExp, isSet, isString, isSymbol, isType, isUndefined, isWeakMap, isWeakSet };

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "is-what",
   "sideEffects": false,
-  "version": "3.11.0",
+  "version": "3.12.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",
+    "test": "ava",
+    "jest": "jest",
+    "jest-w": "jest --watchAll",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c ./build/rollup.js",
-    "build": "npm run lint && npm run rollup && npm run test"
+    "rollup": "rollup -c ./build.js",
+    "build": "rm -rf types && rm -rf dist && npm run lint && npm run rollup && npm run test && npm run jest"
   },
   "repository": {
     "type": "git",
@@ -47,25 +47,25 @@
   "homepage": "https://github.com/mesqueeb/is-what#readme",
   "dependencies": {},
   "devDependencies": {
-    "@babel/core": "^7.11.0",
+    "@babel/core": "^7.12.3",
     "@types/babel-core": "^6.25.6",
-    "@types/jest": "^25.2.3",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.34.0",
-    "ava": "^3.11.0",
+    "@types/jest": "^26.0.15",
+    "@typescript-eslint/eslint-plugin": "^4.7.0",
+    "@typescript-eslint/parser": "^4.7.0",
+    "ava": "^3.13.0",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^25.5.1",
+    "babel-jest": "^26.6.3",
     "babel-preset-env": "^1.7.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint": "^7.13.0",
+    "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-tree-shaking": "^1.8.0",
-    "jest": "^25.5.4",
+    "jest": "^26.6.3",
     "regenerator-runtime": "^0.13.7",
-    "rollup": "^1.32.1",
-    "rollup-plugin-typescript2": "^0.27.1",
+    "rollup": "^2.33.1",
+    "rollup-plugin-typescript2": "^0.29.0",
     "tsconfig-paths": "^3.9.0",
-    "ts-node": "^8.10.2",
-    "typescript": "^3.9.7"
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.5"
   },
   "ava": {
     "extensions": [

package/src/index.ts

@@ -1,3 +1,7 @@
+export type AnyFunction = (...args: any[]) => any
+export type AnyAsyncFunction = (...args: any[]) => Promise<any>
+export type AnyClass = new (...args: any[]) => any
+
 /**
  * Returns the object type of the given payload
  *
@@ -32,9 +36,9 @@ export function isNull (payload: any): payload is null {
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export function isPlainObject (payload: any): payload is { [key: string]: any } {
+export function isPlainObject (payload: any): payload is Record<string, any> {
   if (getType(payload) !== 'Object') return false
   return payload.constructor === Object && Object.getPrototypeOf(payload) === Object.prototype
 }
@@ -43,9 +47,9 @@ export function isPlainObject (payload: any): payload is { [key: string]: any }
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export function isObject (payload: any): payload is { [key: string]: any } {
+export function isObject (payload: any): payload is Record<string, any> {
   return isPlainObject(payload)
 }
 
@@ -53,9 +57,9 @@ export function isObject (payload: any): payload is { [key: string]: any } {
  * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {}}
+ * @returns {payload is { [K in any]: never }}
  */
-export function isEmptyObject (payload: any): payload is {} {
+export function isEmptyObject (payload: any): payload is { [K in any]: never } {
   return isPlainObject(payload) && Object.keys(payload).length === 0
 }
 
@@ -63,9 +67,9 @@ export function isEmptyObject (payload: any): payload is {} {
  * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export function isAnyObject (payload: any): payload is { [key: string]: any } {
+export function isAnyObject (payload: any): payload is Record<string, any> {
   return getType(payload) === 'Object'
 }
 
@@ -78,30 +82,40 @@ export function isAnyObject (payload: any): payload is { [key: string]: any } {
  * @param {*} payload
  * @returns {payload is T}
  */
-export function isObjectLike<T extends object> (payload: any): payload is T {
+export function isObjectLike<T extends Record<string, any>> (payload: any): payload is T {
   return isAnyObject(payload)
 }
 
 /**
- * Returns whether the payload is a function
+ * Returns whether the payload is a function (regular or async)
  *
  * @param {*} payload
- * @returns {payload is Function}
+ * @returns {payload is AnyFunction}
  */
-export function isFunction (payload: any): payload is Function {
-  return getType(payload) === 'Function'
+export function isFunction (payload: any): payload is AnyFunction {
+  return typeof payload === "function"
 }
 
 /**
  * Returns whether the payload is an array
  *
- * @param {*} payload
- * @returns {payload is undefined}
+ * @param {any} payload
+ * @returns {payload is any[]}
  */
 export function isArray (payload: any): payload is any[] {
   return getType(payload) === 'Array'
 }
 
+/**
+ * Returns whether the payload is a an array with at least 1 item
+ *
+ * @param {*} payload
+ * @returns {payload is any[]}
+ */
+export function isFullArray (payload: any): payload is any[] {
+  return isArray(payload) && payload.length > 0
+}
+
 /**
  * Returns whether the payload is a an empty array
  *
@@ -143,9 +157,9 @@ export function isEmptyString (payload: any): payload is string {
 }
 
 /**
- * Returns whether the payload is a number
+ * Returns whether the payload is a number (but not NaN)
  *
- * This will return false for NaN
+ * This will return `false` for `NaN`!!
  *
  * @param {*} payload
  * @returns {payload is number}
@@ -178,7 +192,7 @@ export function isRegExp (payload: any): payload is RegExp {
  * Returns whether the payload is a Map
  *
  * @param {*} payload
- * @returns {payload is Map}
+ * @returns {payload is Map<any, any>}
  */
 export function isMap (payload: any): payload is Map<any, any> {
   return getType(payload) === 'Map'
@@ -188,7 +202,7 @@ export function isMap (payload: any): payload is Map<any, any> {
  * Returns whether the payload is a WeakMap
  *
  * @param {*} payload
- * @returns {payload is WeakMap}
+ * @returns {payload is WeakMap<any, any>}
  */
 export function isWeakMap (payload: any): payload is WeakMap<any, any> {
   return getType(payload) === 'WeakMap'
@@ -198,7 +212,7 @@ export function isWeakMap (payload: any): payload is WeakMap<any, any> {
  * Returns whether the payload is a Set
  *
  * @param {*} payload
- * @returns {payload is Set}
+ * @returns {payload is Set<any>}
  */
 export function isSet (payload: any): payload is Set<any> {
   return getType(payload) === 'Set'
@@ -208,7 +222,7 @@ export function isSet (payload: any): payload is Set<any> {
  * Returns whether the payload is a WeakSet
  *
  * @param {*} payload
- * @returns {payload is WeakSet}
+ * @returns {payload is WeakSet<any>}
  */
 export function isWeakSet (payload: any): payload is WeakSet<any> {
   return getType(payload) === 'WeakSet'
@@ -258,7 +272,7 @@ export function isFile (payload: any): payload is File {
  * Returns whether the payload is a Promise
  *
  * @param {*} payload
- * @returns {payload is Promise}
+ * @returns {payload is Promise<any>}
  */
 export function isPromise (payload: any): payload is Promise<any> {
   return getType(payload) === 'Promise'
@@ -275,7 +289,7 @@ export function isError (payload: any): payload is Error {
 }
 
 /**
- * Returns whether the payload is `NaN` but also a `number`
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
  *
  * @param {*} payload
  * @returns {payload is typeof NaN}
@@ -324,7 +338,7 @@ export function isNullOrUndefined (payload: any): payload is null | undefined {
  * @throws {TypeError} Will throw type error if type is an invalid type
  * @returns {payload is T}
  */
-export function isType<T extends Function> (payload: any, type: T): payload is T {
+export function isType<T extends AnyFunction | AnyClass> (payload: any, type: T): payload is T {
   if (!(type instanceof Function)) {
     throw new TypeError('Type must be a function')
   }

package/test/ava.ts

@@ -24,6 +24,7 @@ import {
   isWeakMap,
   isSet,
   isWeakSet,
+  isFullArray,
   // isBlob,
   // isFile,
   isPromise,
@@ -41,10 +42,6 @@ test('Basic true tests', t => {
   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)
@@ -76,7 +73,6 @@ test('Basic false tests', t => {
   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)
@@ -91,6 +87,19 @@ test('Basic false tests', t => {
   t.is(isNullOrUndefined(NaN), false)
 })
 
+test('isFunction', t => {
+  t.is(isFunction(NaN), false)
+  t.is(isFunction(() => {}), true)
+  t.is(isFunction(function () {}), true)
+  t.is(isFunction(async () => {}), true)
+  t.is(isFunction(async function () {}), true)
+  t.is(isFunction(function * () {}), true)
+  t.is(isFunction(async function * () {}), true)
+  const _ = { fn: () => {}, method () {} }
+  t.is(isFunction(_.fn), true)
+  t.is(isFunction(_.method), true)
+})
+
 test('isEmptyObject', t => {
   t.is(isEmptyObject({}), true)
   t.is(isEmptyObject(new Object()), true)
@@ -126,6 +135,27 @@ test('isEmptyArray', t => {
   t.is(isEmptyArray(new WeakSet()), false)
 })
 
+test('isFullArray', t => {
+  t.is(isFullArray(new Array(1)), true)
+  t.is(isFullArray([undefined]), true)
+  t.is(isFullArray([null]), true)
+  t.is(isFullArray(['']), true)
+  
+  t.is(isFullArray([]), false)
+  t.is(isFullArray(new Array()), false)
+  t.is(isFullArray(new Array(0)), false)
+  
+  t.is(isFullArray(null), false)
+  t.is(isFullArray(new Date()), false)
+  t.is(isFullArray(new Error('')), false)
+  t.is(isFullArray(new Date()), false)
+  t.is(isFullArray(Symbol()), false)
+  t.is(isFullArray(new Map()), false)
+  t.is(isFullArray(new WeakMap()), false)
+  t.is(isFullArray(new Set()), false)
+  t.is(isFullArray(new WeakSet()), false)
+})
+
 test('NaN tests', t => {
   t.is(isNaNValue(NaN), true)
   t.is(isNaNValue(new Error('')), false)
@@ -135,7 +165,7 @@ test('NaN tests', t => {
   t.is(isNaNValue({}), false)
   t.is(isNaNValue(new Object()), false)
   t.is(
-    isNaNValue(_ => {}),
+    isNaNValue(() => {}),
     false
   )
   t.is(isNaNValue([]), false)
@@ -177,7 +207,7 @@ test('Primitive tests', t => {
   t.is(isPrimitive(new Object()), false)
   t.is(isPrimitive(new Date()), false)
   t.is(
-    isPrimitive(_ => {}),
+    isPrimitive(() => {}),
     false
   )
 })
@@ -187,11 +217,14 @@ test('Date exception', t => {
 })
 
 test('Generic isType', t => {
-  function MyClass () {}
+  // -----------------------------
   // This is correct old fashion syntax for classes, if this is missing
+  function MyClass () {}
   MyClass.prototype.constructor = MyClass
-  class MyOtherClass {}
+  // @ts-ignore
   const myClass = new MyClass()
+  // -----------------------------
+  class MyOtherClass { constructor() {} }
   // this is expected behaviour
   t.is(isType('', String), true)
   t.is(isType('_', String), true)
@@ -204,7 +237,7 @@ test('Generic isType', t => {
   t.is(isType([], Array), true)
   t.is(isType(new Array(), Array), true)
   t.is(
-    isType(_ => {}, Function),
+    isType(() => {}, Function),
     true
   )
   t.is(isType(true, Boolean), true)
@@ -228,12 +261,15 @@ test('Generic isType', t => {
 })
 
 test('isObject vs isAnyObject', t => {
-  function MyClass () {}
+  // -----------------------------
   // This is correct old fashion syntax for classes, if this is missing
+  function MyClass () {}
   MyClass.prototype.constructor = MyClass
+  // @ts-ignore
   const myClass = new MyClass()
-  class MyClass2 {}
-  const myClass2 = new MyClass()
+  // -----------------------------
+  class MyClass2 { constructor() {} }
+  const myClass2 = new MyClass2()
   const mySpecialObject = {}
   Object.setPrototypeOf(mySpecialObject, {
     toDate: function () {
@@ -276,3 +312,34 @@ test('isObject vs isAnyObject', t => {
   t.is(isAnyObject(new Date('_')), false)
   t.is(isAnyObject(new Date()), false)
 })
+
+test('type related tests', t => {
+  t.pass()
+  // const fn: string | ((k: number) => string) = (p) => 'a'
+  // if (!isFunction(fn)) {
+  //   fn
+  // }
+
+  // const a: Record<string, number> = {}
+  
+  // a[fn(1)] = fn(2)
+
+  // const myArray: string | string[] = ['a', 'b']
+  // if (!isArray(myArray)) {
+  //   myArray
+  // }
+
+  // const a: Record<string, number> = {}
+  
+  // a[myArray[1]] = myArray[0]
+
+  // const myArray: string | any[] = [1, 2, 'a', 'b']
+  // if (!isArray(myArray)) {
+  //   myArray
+  // }
+
+  // const a: Record<string, number> = {}
+  
+  // a[myArray[1]] = myArray[0]
+
+})

package/test/index.test.js

@@ -1,181 +1,15 @@
 // @ts-check
 import {
-  isObject,
-  isPlainObject,
-  isAnyObject,
-  isUndefined,
-  isNull,
-  isNullOrUndefined,
-  isFunction,
-  isArray,
-  isString,
-  isEmptyString,
-  isFullString,
-  isBoolean,
-  isRegExp,
-  isNumber,
-  isDate,
-  isSymbol,
-  isPrimitive,
-  isType,
   isBlob,
   isFile,
-  isPromise,
 } from '../dist/index.cjs'
 
-test('Basic true tests', () => {
-  expect(isUndefined(undefined)).toBe(true)
-  expect(isNull(null)).toBe(true)
-  expect(isNullOrUndefined(null)).toBe(true)
-  expect(isNullOrUndefined(undefined)).toBe(true)
-  expect(isObject({})).toBe(true)
-  expect(isObject(new Object())).toBe(true)
-  expect(isFunction(_ => {})).toBe(true)
-  expect(isArray([])).toBe(true)
-  expect(isArray(new Array())).toBe(true)
-  expect(isString('')).toBe(true)
-  expect(isString('_')).toBe(true)
-  expect(isEmptyString('')).toBe(true)
-  expect(isFullString(' ')).toBe(true)
-  expect(isBoolean(true)).toBe(true)
-  expect(isBoolean(false)).toBe(true)
-  expect(isRegExp(/./)).toBe(true)
-  expect(isRegExp(/./gi)).toBe(true)
-  expect(isNumber(0)).toBe(true)
-  expect(isNumber(1)).toBe(true)
-  expect(isDate(new Date())).toBe(true)
-  expect(isSymbol(Symbol())).toBe(true)
+test('isBlob', () => {
+  expect(isBlob(Blob)).toBe(false)
   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', () => {
-  expect(isNumber(NaN)).toBe(false)
-  expect(isDate(new Date('_'))).toBe(false)
-  expect(isDate(NaN)).toBe(false)
-  expect(isUndefined(NaN)).toBe(false)
-  expect(isNull(NaN)).toBe(false)
-  expect(isObject(NaN)).toBe(false)
-  expect(isFunction(NaN)).toBe(false)
-  expect(isArray(NaN)).toBe(false)
-  expect(isString(NaN)).toBe(false)
-  expect(isEmptyString(' ')).toBe(false)
-  expect(isFullString('')).toBe(false)
-  expect(isBoolean(NaN)).toBe(false)
-  expect(isRegExp(NaN)).toBe(false)
-  expect(isSymbol(NaN)).toBe(false)
-  expect(isNullOrUndefined(NaN)).toBe(false)
-})
-
-test('Primitive tests', () => {
-  // true
-  expect(isPrimitive(0)).toBe(true)
-  expect(isPrimitive('')).toBe(true)
-  expect(isPrimitive('str')).toBe(true)
-  expect(isPrimitive(Symbol())).toBe(true)
-  expect(isPrimitive(true)).toBe(true)
-  expect(isPrimitive(false)).toBe(true)
-  expect(isPrimitive(null)).toBe(true)
-  expect(isPrimitive(undefined)).toBe(true)
-  // false
-  expect(isPrimitive(NaN)).toBe(false)
-  expect(isPrimitive([])).toBe(false)
-  expect(isPrimitive(new Array())).toBe(false)
-  expect(isPrimitive({})).toBe(false)
-  expect(isPrimitive(new Object())).toBe(false)
-  expect(isPrimitive(new Date())).toBe(false)
-  expect(isPrimitive(_ => {})).toBe(false)
 })
 
-test('Date exception', () => {
-  expect(isDate(new Date('_'))).toBe(false)
-})
-
-test('Generic isType', () => {
-  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
-  expect(isType('', String)).toBe(true)
-  expect(isType('_', String)).toBe(true)
-  expect(isType('Hello World', String)).toBe(true)
-  expect(isType(NaN, Number)).toBe(true)
-  expect(isType(0, Number)).toBe(true)
-  expect(isType(1, Number)).toBe(true)
-  expect(isType({}, Object)).toBe(true)
-  expect(isType(new Object(), Object)).toBe(true)
-  expect(isType([], Array)).toBe(true)
-  expect(isType(new Array(), Array)).toBe(true)
-  expect(isType(_ => {}, Function)).toBe(true)
-  expect(isType(true, Boolean)).toBe(true)
-  expect(isType(false, Boolean)).toBe(true)
-  expect(isType(new Date('_'), Date)).toBe(true)
-  expect(isType(new Date(), Date)).toBe(true)
-  expect(isType(/./, RegExp)).toBe(true)
-  expect(isType(/./gi, RegExp)).toBe(true)
-  expect(isType(myClass, MyClass)).toBe(true)
-  expect(isType(new MyOtherClass(), MyOtherClass)).toBe(true)
-  expect(isType(myClass, MyOtherClass)).toBe(false)
-  expect(isType(Symbol(), Symbol)).toBe(true)
-  // expect(isType(null, Null)).toBe(true)
-  // expect(isType(undefined, Undefined)).toBe(true)
-  // It SHOULD fail
-  expect(isType(5, String)).toBe(false)
-  expect(isType(null, Object)).toBe(false)
-  // Not sure if this would be the expected behaviour but everything is an object
-  // so I would say so
-  expect(isType(myClass, Object)).toBe(true)
-})
-
-test('isObject vs isAnyObject', () => {
-  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
-  expect(isObject({})).toBe(true)
-  expect(isObject(new Object())).toBe(true)
-  expect(isPlainObject({})).toBe(true)
-  expect(isPlainObject(new Object())).toBe(true)
-  // classes & prototypes
-  expect(isObject(myClass)).toBe(false)
-  expect(isObject(myClass2)).toBe(false)
-  expect(isObject(mySpecialObject)).toBe(false)
-  expect(isPlainObject(myClass)).toBe(false)
-  expect(isPlainObject(myClass2)).toBe(false)
-  expect(isPlainObject(mySpecialObject)).toBe(false)
-  // arrays and dates
-  expect(isObject([])).toBe(false)
-  expect(isObject(new Array())).toBe(false)
-  expect(isObject(new Date('_'))).toBe(false)
-  expect(isObject(new Date())).toBe(false)
-  expect(isPlainObject([])).toBe(false)
-  expect(isPlainObject(new Array())).toBe(false)
-  expect(isPlainObject(new Date('_'))).toBe(false)
-  expect(isPlainObject(new Date())).toBe(false)
-  // IS ANY OBJECT
-  // plain object
-  expect(isAnyObject({})).toBe(true)
-  expect(isAnyObject(new Object())).toBe(true)
-  // classes & prototypes
-  expect(isAnyObject(myClass)).toBe(true)
-  expect(isAnyObject(myClass2)).toBe(true)
-  expect(isAnyObject(mySpecialObject)).toBe(true)
-  // arrays and dates
-  expect(isAnyObject([])).toBe(false)
-  expect(isAnyObject(new Array())).toBe(false)
-  expect(isAnyObject(new Date('_'))).toBe(false)
-  expect(isAnyObject(new Date())).toBe(false)
+test('isFile', () => {
+  expect(isFile(File)).toBe(false)
+  expect(isFile(new File([''], '', { type: 'text/html' }))).toBe(true)
 })

package/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "baseUrl": ".",
+    "strict": true,
     "declaration": true,
     "declarationDir": "./types/"
   },

package/types/index.d.ts

@@ -1,3 +1,6 @@
+export declare type AnyFunction = (...args: any[]) => any;
+export declare type AnyAsyncFunction = (...args: any[]) => Promise<any>;
+export declare type AnyClass = new (...args: any[]) => any;
 /**
  * Returns the object type of the given payload
  *
@@ -23,36 +26,32 @@ export declare function isNull(payload: any): payload is null;
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export declare function isPlainObject(payload: any): payload is {
-    [key: string]: any;
-};
+export declare function isPlainObject(payload: any): payload is Record<string, any>;
 /**
  * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export declare function isObject(payload: any): payload is {
-    [key: string]: any;
-};
+export declare function isObject(payload: any): payload is Record<string, any>;
 /**
  * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  *
  * @param {*} payload
- * @returns {payload is {}}
+ * @returns {payload is { [K in any]: never }}
  */
-export declare function isEmptyObject(payload: any): payload is {};
+export declare function isEmptyObject(payload: any): payload is {
+    [K in any]: never;
+};
 /**
  * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
  *
  * @param {*} payload
- * @returns {payload is {[key: string]: any}}
+ * @returns {payload is Record<string, any>}
  */
-export declare function isAnyObject(payload: any): payload is {
-    [key: string]: any;
-};
+export declare function isAnyObject(payload: any): payload is Record<string, any>;
 /**
  * Returns whether the payload is an object like a type passed in < >
  *
@@ -62,21 +61,28 @@ export declare function isAnyObject(payload: any): payload is {
  * @param {*} payload
  * @returns {payload is T}
  */
-export declare function isObjectLike<T extends object>(payload: any): payload is T;
+export declare function isObjectLike<T extends Record<string, any>>(payload: any): payload is T;
 /**
- * Returns whether the payload is a function
+ * Returns whether the payload is a function (regular or async)
  *
  * @param {*} payload
- * @returns {payload is Function}
+ * @returns {payload is AnyFunction}
  */
-export declare function isFunction(payload: any): payload is Function;
+export declare function isFunction(payload: any): payload is AnyFunction;
 /**
  * Returns whether the payload is an array
  *
- * @param {*} payload
- * @returns {payload is undefined}
+ * @param {any} payload
+ * @returns {payload is any[]}
  */
 export declare function isArray(payload: any): payload is any[];
+/**
+ * Returns whether the payload is a an array with at least 1 item
+ *
+ * @param {*} payload
+ * @returns {payload is any[]}
+ */
+export declare function isFullArray(payload: any): payload is any[];
 /**
  * Returns whether the payload is a an empty array
  *
@@ -106,9 +112,9 @@ export declare function isFullString(payload: any): payload is string;
  */
 export declare function isEmptyString(payload: any): payload is string;
 /**
- * Returns whether the payload is a number
+ * Returns whether the payload is a number (but not NaN)
  *
- * This will return false for NaN
+ * This will return `false` for `NaN`!!
  *
  * @param {*} payload
  * @returns {payload is number}
@@ -132,28 +138,28 @@ export declare function isRegExp(payload: any): payload is RegExp;
  * Returns whether the payload is a Map
  *
  * @param {*} payload
- * @returns {payload is Map}
+ * @returns {payload is Map<any, any>}
  */
 export declare function isMap(payload: any): payload is Map<any, any>;
 /**
  * Returns whether the payload is a WeakMap
  *
  * @param {*} payload
- * @returns {payload is WeakMap}
+ * @returns {payload is WeakMap<any, any>}
  */
 export declare function isWeakMap(payload: any): payload is WeakMap<any, any>;
 /**
  * Returns whether the payload is a Set
  *
  * @param {*} payload
- * @returns {payload is Set}
+ * @returns {payload is Set<any>}
  */
 export declare function isSet(payload: any): payload is Set<any>;
 /**
  * Returns whether the payload is a WeakSet
  *
  * @param {*} payload
- * @returns {payload is WeakSet}
+ * @returns {payload is WeakSet<any>}
  */
 export declare function isWeakSet(payload: any): payload is WeakSet<any>;
 /**
@@ -188,7 +194,7 @@ export declare function isFile(payload: any): payload is File;
  * Returns whether the payload is a Promise
  *
  * @param {*} payload
- * @returns {payload is Promise}
+ * @returns {payload is Promise<any>}
  */
 export declare function isPromise(payload: any): payload is Promise<any>;
 /**
@@ -199,7 +205,7 @@ export declare function isPromise(payload: any): payload is Promise<any>;
  */
 export declare function isError(payload: any): payload is Error;
 /**
- * Returns whether the payload is `NaN` but also a `number`
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
  *
  * @param {*} payload
  * @returns {payload is typeof NaN}
@@ -230,4 +236,4 @@ export declare function isNullOrUndefined(payload: any): payload is null | undef
  * @throws {TypeError} Will throw type error if type is an invalid type
  * @returns {payload is T}
  */
-export declare function isType<T extends Function>(payload: any, type: T): payload is T;
+export declare function isType<T extends AnyFunction | AnyClass>(payload: any, type: T): payload is T;