Package Exports

@analytics/type-utils

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@analytics/type-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Type Utilities

A tiny tree shakable utility library for runtime type checking.

The entire package weighs in at 657 bytes.

See live demo.

Why this package?

This package exposes re-usable runtime type checking functions. This is useful for shrinking bundle sizes.

How to install

Install @analytics/type-utils from npm.

npm install @analytics/type-utils

API

Below is the api for @analytics/type-utils.

`isBrowser`

Check if currently in browser context

import { isBrowser } from '@analytics/type-utils'

if (isBrowser) {
  console.log('do things in browser env')
}

`isString`

Check if value is string

import { isString } from '@analytics/type-utils'

const xyz = 'hi'
console.log(isString(xyz))
// true

`isNumber`

Check if value is number

import { isNumber } from '@analytics/type-utils'

const xyz = 123
console.log(isNumber(xyz))
// true

`isBoolean`

Check if value is boolean

import { isBoolean } from '@analytics/type-utils'

const myBool = true
console.log(isBoolean(myBool))
// true

`isArray`

Check if value is array

import { isArray } from '@analytics/type-utils'

const myArr = ['x', 'y']
console.log(isArray(myArr))
// true

`isObject`

Check if value is object

import { isObject } from '@analytics/type-utils'

const myObj = { cool: 'hello' }
console.log(isObject(myObj))
// true

`isUndefined`

Check if value is undefined

import { isUndefined } from '@analytics/type-utils'

let myval
console.log(isUndefined(myval))
// true

`isRegex`

Check if value is regular expression.

import { isRegex } from '@analytics/type-utils'

let myval = /pattern/gm
console.log(isRegex(myval))
// true

`isNoOp`

Check if value is a noOp function.

import { isNoOp } from '@analytics/type-utils'

function empty () { }
console.log(isNoOp(isNoOp))
// true

`isTruthy`

Check if value is truthy.

import { isTruthy } from '@analytics/types-utils'

console.log(isTruthy('')) // false
console.log(isTruthy('false')) // false
console.log(isTruthy('FALSE')) // false
console.log(isTruthy(0)) // false
console.log(isTruthy(null)) // false
console.log(isTruthy(undefined)) // false
console.log(isTruthy('true')) // true
console.log(isTruthy(1)) // true
console.log(isTruthy({})) // true
console.log(isTruthy([])) // true
console.log(isTruthy(function() { })) // true

`isEmail`

Check if value is an email.

import { isEmail } from '@analytics/type-utils'

console.log(isEmail('email@email.com'))
// true
console.log(isEmail('other-thing'))
// false

`isElement`

Check if value is a a DOM node.

import { isElement } from '@analytics/type-utils'

const formElement = document.querySelector('.my-form')
console.log(isElement(formElement))
// true

`isNodeList`

Check if value is a list of DOM nodes.

import { isNodeList } from '@analytics/type-utils'

const buttons = document.querySelectorAll('button')
console.log(isNodeList(buttons))
// true

`isForm`

Check if value is a noOp function.

import { isForm } from '@analytics/type-utils'

const formElement = document.querySelector('.my-form')
console.log(isForm(formElement))
// true