is-what 4.0.0 → 4.1.3

package/package.json

@@ -1,17 +1,31 @@
 {
   "name": "is-what",
   "sideEffects": false,
-  "version": "4.0.0",
-  "description": "JS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.",
   "type": "module",
-  "exports": "./dist/index.js",
-  "typings": "./types/index.d.ts",
+  "version": "4.1.3",
+  "description": "JS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13",
+    "npm": ">=7"
+  },
   "scripts": {
-    "test": "ava",
-    "lint": "tsc --noEmit src/index.ts && eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c ./build.js",
-    "build": "rimraf types && rimraf dist && npm run lint && npm run rollup && npm run test",
-    "release": "npm run build && np"
+    "test": "vitest run",
+    "lint": "tsc --noEmit ./src/index.ts && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
   },
   "repository": {
     "type": "git",
@@ -39,41 +53,30 @@
     "is-plain-object"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mesqueeb/is-what/issues"
   },
   "homepage": "https://github.com/mesqueeb/is-what#readme",
   "devDependencies": {
-    "@babel/core": "^7.13.8",
-    "@types/babel-core": "^6.25.6",
-    "@typescript-eslint/eslint-plugin": "^4.16.1",
-    "@typescript-eslint/parser": "^4.16.1",
-    "ava": "^3.15.0",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-preset-env": "^1.7.0",
-    "eslint": "^7.21.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-tree-shaking": "^1.8.0",
-    "np": "^7.4.0",
-    "prettier": "^2.2.1",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.40.0",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.2.3"
-  },
-  "engines": {
-    "node": ">=12.13",
-    "npm": ">=7"
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.1"
   },
   "ava": {
     "extensions": {
       "ts": "module"
     },
-    "nonSemVerExperiments": {
-      "configurableModuleFormat": true
-    },
     "nodeArguments": [
       "--loader=ts-node/esm"
     ]
@@ -83,6 +86,12 @@
     "branch": "production"
   },
   "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
     "root": true,
     "parser": "@typescript-eslint/parser",
     "plugins": [
@@ -96,10 +105,11 @@
       "prettier"
     ],
     "rules": {
+      "@typescript-eslint/no-empty-function": "off",
       "@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"
+      "@typescript-eslint/ban-ts-comment": "off"
     }
   }
 }

package/.babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["env"]
-}

package/.eslintignore

@@ -1,9 +0,0 @@
-# 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
-.eslintrc.js

package/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: mesqueeb
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "semi": false,
-  "bracketSpacing": true,
-  "quoteProps": "consistent"
-}

package/.vscode/settings.json

@@ -1,9 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.tabSize": 2, // make sure this is the same as .prettierrc
-  "editor.insertSpaces": true,
-  "files.insertFinalNewline": true,
-  "files.trimFinalNewlines": true,
-  "files.trimTrailingWhitespace": true
-}

package/build.js

@@ -1,40 +0,0 @@
-/* eslint-disable */
-
-// npm i -D rollup rollup-plugin-typescript2 typescript
-import typescript from 'rollup-plugin-typescript2'
-
-// ------------------------------------------------------------------------------------------
-// formats
-// ------------------------------------------------------------------------------------------
-// amd – Asynchronous Module Definition, used with module loaders like RequireJS
-// cjs – CommonJS, suitable for Node and Browserify/Webpack
-// esm – Keep the bundle as an ES module file
-// iife – A self-executing function, suitable for inclusion as a <script> tag. (If you want to create a bundle for your application, you probably want to use this, because it leads to smaller file sizes.)
-// umd – Universal Module Definition, works as amd, cjs and iife all in one
-// system – Native format of the SystemJS loader
-
-// ------------------------------------------------------------------------------------------
-// setup
-// ------------------------------------------------------------------------------------------
-const pkg = require('./package.json')
-const name = pkg.name
-const className = name.replace(/(^\w|-\w)/g, (c) => c.replace('-', '').toUpperCase())
-
-export default [
-  {
-    input: 'src/index.ts',
-    output: [
-      {
-        file: 'dist/index.js',
-        format: 'esm',
-        sourcemap: false,
-        name: className,
-        exports: 'named',
-      },
-    ],
-    plugins: [
-      typescript({ useTsconfigDeclarationDir: true, tsconfigOverride: { exclude: ['test/**/*'] } }),
-    ],
-    external: Object.keys(pkg.dependencies || []),
-  },
-]

package/src/index.ts

@@ -1,395 +0,0 @@
-export type AnyFunction = (...args: any[]) => any
-export type AnyAsyncFunction = (...args: any[]) => Promise<any>
-export type AnyClass = new (...args: any[]) => any
-export type PlainObject = Record<string | number | symbol, any>
-
-type TypeGuard<A, B extends A> = (payload: A) => payload is B
-
-/**
- * Returns the object type of the given payload
- *
- * @param {*} payload
- * @returns {string}
- */
-export function getType(payload: any): string {
-  return Object.prototype.toString.call(payload).slice(8, -1)
-}
-
-/**
- * Returns whether the payload is undefined
- *
- * @param {*} payload
- * @returns {payload is undefined}
- */
-export function isUndefined(payload: any): payload is undefined {
-  return getType(payload) === 'Undefined'
-}
-
-/**
- * Returns whether the payload is null
- *
- * @param {*} payload
- * @returns {payload is null}
- */
-export function isNull(payload: any): payload is null {
-  return getType(payload) === 'Null'
-}
-
-/**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isPlainObject(payload: any): payload is PlainObject {
-  if (getType(payload) !== 'Object') return false
-  return payload.constructor === Object && Object.getPrototypeOf(payload) === Object.prototype
-}
-
-/**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isObject(payload: any): payload is PlainObject {
-  return isPlainObject(payload)
-}
-
-/**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is { [K in any]: never }}
- */
-export function isEmptyObject(payload: any): payload is { [K in any]: never } {
-  return isPlainObject(payload) && Object.keys(payload).length === 0
-}
-
-/**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isFullObject(payload: any): payload is PlainObject {
-  return isPlainObject(payload) && Object.keys(payload).length > 0
-}
-
-/**
- * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isAnyObject(payload: any): payload is PlainObject {
-  return getType(payload) === 'Object'
-}
-
-/**
- * Returns whether the payload is an object like a type passed in < >
- *
- * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
- *
- * @template T this must be passed in < >
- * @param {*} payload
- * @returns {payload is T}
- */
-export function isObjectLike<T extends PlainObject>(payload: any): payload is T {
-  return isAnyObject(payload)
-}
-
-/**
- * Returns whether the payload is a function (regular or async)
- *
- * @param {*} payload
- * @returns {payload is AnyFunction}
- */
-export function isFunction(payload: any): payload is AnyFunction {
-  return typeof payload === 'function'
-}
-
-/**
- * Returns whether the payload is an array
- *
- * @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
- *
- * @param {*} payload
- * @returns {payload is []}
- */
-export function isEmptyArray(payload: any): payload is [] {
-  return isArray(payload) && payload.length === 0
-}
-
-/**
- * Returns whether the payload is a string
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isString(payload: any): payload is string {
-  return getType(payload) === 'String'
-}
-
-/**
- * Returns whether the payload is a string, BUT returns false for ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isFullString(payload: any): payload is string {
-  return isString(payload) && payload !== ''
-}
-
-/**
- * Returns whether the payload is ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isEmptyString(payload: any): payload is string {
-  return payload === ''
-}
-
-/**
- * Returns whether the payload is a number (but not NaN)
- *
- * This will return `false` for `NaN`!!
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export function isNumber(payload: any): payload is number {
-  return getType(payload) === 'Number' && !isNaN(payload)
-}
-
-/**
- * Returns whether the payload is a boolean
- *
- * @param {*} payload
- * @returns {payload is boolean}
- */
-export function isBoolean(payload: any): payload is boolean {
-  return getType(payload) === 'Boolean'
-}
-
-/**
- * Returns whether the payload is a regular expression (RegExp)
- *
- * @param {*} payload
- * @returns {payload is RegExp}
- */
-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<any, any>}
- */
-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<any, any>}
- */
-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<any>}
- */
-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<any>}
- */
-export function isWeakSet(payload: any): payload is WeakSet<any> {
-  return getType(payload) === 'WeakSet'
-}
-
-/**
- * Returns whether the payload is a Symbol
- *
- * @param {*} payload
- * @returns {payload is symbol}
- */
-export function isSymbol(payload: any): payload is symbol {
-  return getType(payload) === 'Symbol'
-}
-
-/**
- * Returns whether the payload is a Date, and that the date is valid
- *
- * @param {*} payload
- * @returns {payload is Date}
- */
-export function isDate(payload: any): payload is Date {
-  return getType(payload) === 'Date' && !isNaN(payload)
-}
-
-/**
- * Returns whether the payload is a Blob
- *
- * @param {*} payload
- * @returns {payload is Blob}
- */
-export function isBlob(payload: any): payload is Blob {
-  return getType(payload) === 'Blob'
-}
-
-/**
- * Returns whether the payload is a File
- *
- * @param {*} payload
- * @returns {payload is File}
- */
-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<any>}
- */
-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 literally the value `NaN` (it's `NaN` and also a `number`)
- *
- * @param {*} payload
- * @returns {payload is typeof NaN}
- */
-export function isNaNValue(payload: any): payload is typeof NaN {
-  return getType(payload) === 'Number' && isNaN(payload)
-}
-
-/**
- * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
- *
- * @param {*} payload
- * @returns {(payload is boolean | null | undefined | number | string | symbol)}
- */
-export function isPrimitive(
-  payload: any
-): payload is boolean | null | undefined | number | string | symbol {
-  return (
-    isBoolean(payload) ||
-    isNull(payload) ||
-    isUndefined(payload) ||
-    isNumber(payload) ||
-    isString(payload) ||
-    isSymbol(payload)
-  )
-}
-
-/**
- * Returns true whether the payload is null or undefined
- *
- * @param {*} payload
- * @returns {(payload is null | undefined)}
- */
-export const isNullOrUndefined = isOneOf(isNull, isUndefined)
-
-export function isOneOf<A, B extends A, C extends A>(
-  a: TypeGuard<A, B>,
-  b: TypeGuard<A, C>
-): TypeGuard<A, B | C>
-export function isOneOf<A, B extends A, C extends A, D extends A>(
-  a: TypeGuard<A, B>,
-  b: TypeGuard<A, C>,
-  c: TypeGuard<A, D>
-): TypeGuard<A, B | C | D>
-export function isOneOf<A, B extends A, C extends A, D extends A, E extends A>(
-  a: TypeGuard<A, B>,
-  b: TypeGuard<A, C>,
-  c: TypeGuard<A, D>,
-  d: TypeGuard<A, E>
-): TypeGuard<A, B | C | D | E>
-export function isOneOf<A, B extends A, C extends A, D extends A, E extends A, F extends A>(
-  a: TypeGuard<A, B>,
-  b: TypeGuard<A, C>,
-  c: TypeGuard<A, D>,
-  d: TypeGuard<A, E>,
-  e: TypeGuard<A, F>
-): TypeGuard<A, B | C | D | E | F>
-export function isOneOf(
-  a: AnyFunction,
-  b: AnyFunction,
-  c?: AnyFunction,
-  d?: AnyFunction,
-  e?: AnyFunction
-): (value: unknown) => boolean {
-  return (value) =>
-    a(value) || b(value) || (!!c && c(value)) || (!!d && d(value)) || (!!e && e(value))
-}
-
-/**
- * Does a generic check to check that the given payload is of a given type.
- * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
- * It will, however, differentiate between object and null
- *
- * @template T
- * @param {*} payload
- * @param {T} type
- * @throws {TypeError} Will throw type error if type is an invalid type
- * @returns {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')
-  }
-  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 = (type as any).name
-  return getType(payload) === name || Boolean(payload && payload.constructor === type)
-}