is-what 4.1.0

package/.babelrc

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

package/.eslintignore

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

@@ -0,0 +1,12 @@
+# 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

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

package/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Luca Ban - Mesqueeb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,272 @@
+# is What? 🙉
+
+Very simple & small JS type check functions. It's fully TypeScript supported!
+
+```
+npm i is-what
+```
+
+Or for deno available at: `"deno.land/x/is_what"`
+
+## Motivation
+
+I built is-what because the existing solutions were all too complex or too poorly built.
+
+I was looking for:
+
+- A simple way to check any kind of type (including non-primitives)
+- Be able to check if an object is a plain object `{}` or a special object (like a class instance) ‼️
+- Let TypeScript automatically know what type a value is when checking
+
+And that's exactly what `is-what` is! (what a great wordplay 😃)
+
+## Usage
+
+is-what is really easy to use, and most functions work just like you'd expect.
+
+```js
+// import functions you want to use like so:
+import { isString, isDate, isPlainObject } from 'is-what'
+```
+
+1. First I'll go over the simple functions available. Only `isNumber` and `isDate` have special treatment.
+2. After that I'll talk about working with Objects (plain objects vs class instances etc.).
+3. Lastly I'll talk about TypeScript implementation
+
+### Simple type check functions
+
+```js
+// basics
+isBoolean(true) // true
+isBoolean(false) // true
+isUndefined(undefined) // true
+isNull(null) // true
+
+// strings
+isString('') // true
+isEmptyString('') // true
+isFullString('') // false
+
+// numbers
+isNumber(0) // true
+isNumber('0') // false
+isNumber(NaN) // false *
+isPositiveNumber(1) // true
+isNegativeNumber(-1) // true
+// * see below for special NaN use cases!
+
+// arrays
+isArray([]) // true
+isEmptyArray([]) // true
+isFullArray([1]) // true
+
+// objects
+isPlainObject({}) // true *
+isEmptyObject({}) // true
+isFullObject({ a: 1 }) // true
+// * see below for special object (& class instance) use cases!
+
+// functions
+isFunction(function () {}) // true
+isFunction(() => {}) // true
+
+// dates
+isDate(new Date()) // true
+isDate(new Date('invalid date')) // false
+
+// maps & sets
+isMap(new Map()) // true
+isSet(new Set()) // true
+isWeakMap(new WeakMap()) // true
+isWeakSet(new WeakSet()) // true
+
+// others
+isRegExp(/\s/gi) // true
+isSymbol(Symbol()) // true
+isBlob(new Blob()) // true
+isFile(new File([''], '', { type: 'text/html' })) // true
+isError(new Error('')) // true
+isPromise(new Promise((resolve) => {})) // true
+
+// primitives
+isPrimitive('') // true
+// true for any of: boolean, null, undefined, number, string, symbol
+```
+
+### Let's talk about NaN
+
+`isNaN` is a built-in JS Function but it really makes no sense:
+
+```js
+// 1)
+typeof NaN === 'number' // true
+// 🤔 ("not a number" is a "number"...)
+
+// 2)
+isNaN('1') // false
+// 🤔 the string '1' is not-"not a number"... so it's a number??
+
+// 3)
+isNaN('one') // true
+// 🤔 'one' is NaN but `NaN === 'one'` is false...
+```
+
+With is-what the way we treat NaN makes a little bit more sense:
+
+```js
+import { isNumber, isNaNValue } from 'is-what'
+
+// 1)
+isNumber(NaN) // false!
+// let's not treat NaN as a number
+
+// 2)
+isNaNValue('1') // false
+// if it's not NaN, it's not NaN!!
+
+// 3)
+isNaNValue('one') // false
+// if it's not NaN, it's not NaN!!
+
+isNaNValue(NaN) // true
+```
+
+### isPlainObject vs isAnyObject
+
+Checking for a JavaScript object can be really difficult. In JavaScript you can create classes that will behave just like JavaScript objects but might have completely different prototypes. With is-what I went for this classification:
+
+- `isPlainObject` will only return `true` on plain JavaScript objects and not on classes or others
+- `isAnyObject` will be more loose and return `true` on regular objects, classes, etc.
+
+```js
+// define a plain object
+const plainObject = { hello: 'I am a good old object.' }
+
+// define a special object
+class SpecialObject {
+  constructor(somethingSpecial) {
+    this.speciality = somethingSpecial
+  }
+}
+const specialObject = new SpecialObject('I am a special object! I am a class instance!!!')
+
+// check the plain object
+isPlainObject(plainObject) // returns true
+isAnyObject(plainObject) // returns true
+getType(plainObject) // returns 'Object'
+
+// check the special object
+isPlainObject(specialObject) // returns false !!!!!!!!!
+isAnyObject(specialObject) // returns true
+getType(specialObject) // returns 'Object'
+```
+
+> Please note that `isPlainObject` will only return `true` for normal plain JavaScript objects.
+
+### Getting and checking for specific types
+
+You can check for specific types with `getType` and `isType`:
+
+```js
+import { getType, isType } from 'is-what'
+
+getType('') // returns 'String'
+// pass a Type as second param:
+isType('', String) // returns true
+```
+
+## TypeScript
+
+is-what makes TypeScript know the type during if statements. This means that a check returns the type of the payload for TypeScript users.
+
+```ts
+function isNumber(payload: any): payload is number {
+  // return boolean
+}
+// As you can see above, all functions return a boolean for JavaScript, but pass the payload type to TypeScript.
+
+// usage example:
+function fn(payload: string | number): number {
+  if (isNumber(payload)) {
+    // ↑ TypeScript already knows payload is a number here!
+    return payload
+  }
+  return 0
+}
+```
+
+`isPlainObject` and `isAnyObject` with TypeScript will declare the payload to be an object type with any props:
+
+```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
+if (isPlainObject(payload) && payload.id) return payload.id
+// if isPlainObject() would return `payload is object` then it would give an error at `payload.id`
+```
+
+### isObjectLike
+
+If you want more control over what kind of interface/type is casted when checking for objects.
+
+To cast to a specific type while checking for `isAnyObject`, can use `isObjectLike<T>`:
+
+```ts
+import { isObjectLike } from 'is-what'
+
+const payload = { name: 'Mesqueeb' } // current type: `{ name: string }`
+
+// Without casting:
+if (isAnyObject(payload)) {
+  // in here `payload` is casted to: `Record<string | number | symbol, any>`
+  // WE LOOSE THE TYPE!
+}
+
+// With casting:
+// you can pass a specific type for TS that will be casted when the function returns
+if (isObjectLike<{ name: string }>(payload)) {
+  // in here `payload` is casted to: `{ name: string }`
+}
+```
+
+Please note: this library will not actually check the shape of the object, you need to do that yourself.
+
+`isObjectLike<T>` works like this under the hood:
+
+```ts
+function isObjectLike<T extends object>(payload: any): payload is T {
+  return isAnyObject(payload)
+}
+```
+
+## Meet the family
+
+- [is-what 🙉](https://github.com/mesqueeb/is-what)
+- [merge-anything 🥡](https://github.com/mesqueeb/merge-anything)
+- [filter-anything ⚔️](https://github.com/mesqueeb/filter-anything)
+- [find-and-replace-anything 🎣](https://github.com/mesqueeb/find-and-replace-anything)
+- [compare-anything 🛰](https://github.com/mesqueeb/compare-anything)
+- [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
+- [flatten-anything 🏏](https://github.com/mesqueeb/flatten-anything)
+
+## Source code
+
+It's litterally just these functions:
+
+```js
+function getType(payload) {
+  return Object.prototype.toString.call(payload).slice(8, -1)
+}
+function isUndefined(payload) {
+  return getType(payload) === 'Undefined'
+}
+function isString(payload) {
+  return getType(payload) === 'String'
+}
+function isAnyObject(payload) {
+  return getType(payload) === 'Object'
+}
+// etc...
+```
+
+See the full source code [here](https://github.com/mesqueeb/is-what/blob/master/src/index.ts).

package/build.js

@@ -0,0 +1,40 @@
+/* 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 || []),
+  },
+]