is/source/index.ts

import * as util from 'util';

export const enum TypeName {
	null = 'null',
	boolean = 'boolean',
	undefined = 'undefined',
	string = 'string',
	number = 'number',
	symbol = 'symbol',
	Function = 'Function',
	Array = 'Array',
	Buffer = 'Buffer',
	Object = 'Object',
	RegExp = 'RegExp',
	Date = 'Date',
	Error = 'Error',
	Map = 'Map',
	Set = 'Set',
	WeakMap = 'WeakMap',
	WeakSet = 'WeakSet',
	Int8Array = 'Int8Array',
	Uint8Array = 'Uint8Array',
	Uint8ClampedArray = 'Uint8ClampedArray',
	Int16Array = 'Int16Array',
	Uint16Array = 'Uint16Array',
	Int32Array = 'Int32Array',
	Uint32Array = 'Uint32Array',
	Float32Array = 'Float32Array',
	Float64Array = 'Float64Array',
	ArrayBuffer = 'ArrayBuffer',
	SharedArrayBuffer = 'SharedArrayBuffer',
	Promise = 'Promise'
}

const toString = Object.prototype.toString;
const isOfType = (type: string) => (value: any) => typeof value === type; // tslint:disable-line:strict-type-predicates

const getObjectType = (value: any): TypeName | null => {
	const objectName = toString.call(value).slice(8, -1) as string;

	if (objectName) {
		return objectName as TypeName;
	}

	return null;
};

const isObjectOfType = (typeName: TypeName) => (value: any) => {
	return getObjectType(value) === typeName;
};

function is(value: any): TypeName { // tslint:disable-line:only-arrow-functions
	if (value === null) {
		return TypeName.null;
	}

	if (value === true || value === false) {
		return TypeName.boolean;
	}

	const type = typeof value;

	if (type === 'undefined') {
		return TypeName.undefined;
	}

	if (type === 'string') {
		return TypeName.string;
	}

	if (type === 'number') {
		return TypeName.number;
	}

	if (type === 'symbol') {
		return TypeName.symbol;
	}

	if (is.function_(value)) {
		return TypeName.Function;
	}

	if (Array.isArray(value)) {
		return TypeName.Array;
	}

	if (Buffer.isBuffer(value)) {
		return TypeName.Buffer;
	}

	const tagType = getObjectType(value);
	if (tagType) {
		return tagType;
	}

	if (value instanceof String || value instanceof Boolean || value instanceof Number) {
		throw new TypeError('Please don\'t use object wrappers for primitive types');
	}

	return TypeName.Object;
}

namespace is { // tslint:disable-line:no-namespace
	const isObject = (value: any) => typeof value === 'object';

	// tslint:disable:variable-name
	export const undefined = isOfType('undefined');
	export const string = isOfType('string');
	export const number = isOfType('number');
	export const function_ = isOfType('function');
	export const null_ = (value: any) => value === null;

	export const class_ = (value: any) => function_(value) && value.toString().startsWith('class ');
	export const boolean = (value: any) => value === true || value === false;
	// tslint:enable:variable-name

	export const symbol = isOfType('symbol');

	export const array = Array.isArray;
	export const buffer = Buffer.isBuffer;

	export const nullOrUndefined = (value: any) => null_(value) || undefined(value);
	export const object = (value: any) => !nullOrUndefined(value) && (function_(value) || isObject(value));
	export const iterable = (value: any) => !nullOrUndefined(value) && function_(value[Symbol.iterator]);
	export const generator = (value: any) => iterable(value) && function_(value.next) && function_(value.throw);

	export const nativePromise = isObjectOfType(TypeName.Promise);

	const hasPromiseAPI = (value: any) =>
		!null_(value) &&
		isObject(value) &&
		function_(value.then) &&
		function_(value.catch);

	export const promise = (value: any) => nativePromise(value) || hasPromiseAPI(value);

	// TODO: Change to use `isObjectOfType` once Node.js 6 or higher is targeted
	const isFunctionOfType = (type: string) => (value: any) => function_(value) && function_(value.constructor) && value.constructor.name === type;

	export const generatorFunction = isFunctionOfType('GeneratorFunction');
	export const asyncFunction = isFunctionOfType('AsyncFunction');
	export const boundFunction = (value: any) => function_(value) && !value.hasOwnProperty('prototype');

	export const regExp = isObjectOfType(TypeName.RegExp);
	export const date = isObjectOfType(TypeName.Date);
	export const error = isObjectOfType(TypeName.Error);
	export const map = isObjectOfType(TypeName.Map);
	export const set = isObjectOfType(TypeName.Set);
	export const weakMap = isObjectOfType(TypeName.WeakMap);
	export const weakSet = isObjectOfType(TypeName.WeakSet);

	export const int8Array = isObjectOfType(TypeName.Int8Array);
	export const uint8Array = isObjectOfType(TypeName.Uint8Array);
	export const uint8ClampedArray = isObjectOfType(TypeName.Uint8ClampedArray);
	export const int16Array = isObjectOfType(TypeName.Int16Array);
	export const uint16Array = isObjectOfType(TypeName.Uint16Array);
	export const int32Array = isObjectOfType(TypeName.Int32Array);
	export const uint32Array = isObjectOfType(TypeName.Uint32Array);
	export const float32Array = isObjectOfType(TypeName.Float32Array);
	export const float64Array = isObjectOfType(TypeName.Float64Array);

	export const arrayBuffer = isObjectOfType(TypeName.ArrayBuffer);
	export const sharedArrayBuffer = isObjectOfType(TypeName.SharedArrayBuffer);

	export const truthy = (value: any) => Boolean(value);
	export const falsy = (value: any) => !value;

	export const nan = (value: any) => Number.isNaN(value);

	const primitiveTypes = new Set([
		'undefined',
		'string',
		'number',
		'boolean',
		'symbol'
	]);

	export const primitive = (value: any) => null_(value) || primitiveTypes.has(typeof value);

	export const integer = (value: any) => Number.isInteger(value);
	export const safeInteger = (value: any) => Number.isSafeInteger(value);

	export const plainObject = (value: any) => {
		// From: https://github.com/sindresorhus/is-plain-obj/blob/master/index.js
		let prototype;

		return getObjectType(value) === TypeName.Object &&
			(prototype = Object.getPrototypeOf(value), prototype === null || // tslint:disable-line:ban-comma-operator
				prototype === Object.getPrototypeOf({}));
	};

	const typedArrayTypes = new Set([
		TypeName.Int8Array,
		TypeName.Uint8Array,
		TypeName.Uint8ClampedArray,
		TypeName.Int16Array,
		TypeName.Uint16Array,
		TypeName.Int32Array,
		TypeName.Uint32Array,
		TypeName.Float32Array,
		TypeName.Float64Array
	]);
	export const typedArray = (value: any) => {
		const objectType = getObjectType(value);

		if (objectType === null) {
			return false;
		}

		return typedArrayTypes.has(objectType);
	};

	const isValidLength = (value: any) => safeInteger(value) && value > -1;
	export const arrayLike = (value: any) => !nullOrUndefined(value) && !function_(value) && isValidLength(value.length);

	export const inRange = (value: number, range: number | number[]) => {
		if (number(range)) {
			return value >= Math.min(0, range as number) && value <= Math.max(range as number, 0);
		}

		if (array(range) && range.length === 2) {
			// TODO: Use spread operator here when targeting Node.js 6 or higher
			return value >= Math.min.apply(null, range) && value <= Math.max.apply(null, range);
		}

		throw new TypeError(`Invalid range: ${util.inspect(range)}`);
	};

	const NODE_TYPE_ELEMENT = 1;
	const DOM_PROPERTIES_TO_CHECK = [
		'innerHTML',
		'ownerDocument',
		'style',
		'attributes',
		'nodeValue'
	];

	export const domElement = (value: any) => object(value) && value.nodeType === NODE_TYPE_ELEMENT && string(value.nodeName) &&
		!plainObject(value) && DOM_PROPERTIES_TO_CHECK.every(property => property in value);

	export const nodeStream = (value: any) => !nullOrUndefined(value) && isObject(value) && function_(value.pipe);

	export const infinite = (value: any) => value === Infinity || value === -Infinity;

	const isAbsoluteMod2 = (value: number) => (rem: number) => integer(rem) && Math.abs(rem % 2) === value;
	export const even = isAbsoluteMod2(0);
	export const odd = isAbsoluteMod2(1);

	const isWhiteSpaceString = (value: any) => string(value) && /\S/.test(value) === false;
	const isEmptyStringOrArray = (value: any) => (string(value) || array(value)) && value.length === 0;
	const isEmptyObject = (value: any) => !map(value) && !set(value) && object(value) && Object.keys(value).length === 0;
	const isEmptyMapOrSet = (value: any) => (map(value) || set(value)) && value.size === 0;

	export const empty = (value: any) => falsy(value) || isEmptyStringOrArray(value) || isEmptyObject(value) || isEmptyMapOrSet(value);
	export const emptyOrWhitespace = (value: any) => empty(value) || isWhiteSpaceString(value);

	type ArrayMethod = (fn: (value: any, index: number, arr: any[]) => boolean, thisArg?: any) => boolean;
	const predicateOnArray = (method: ArrayMethod, predicate: any, args: IArguments) => {
		// `args` is the calling function's "arguments object".
		// We have to do it this way to keep node v4 support.
		// So here we convert it to an array and slice off the first item.
		const values = Array.prototype.slice.call(args, 1);

		if (function_(predicate) === false) {
			throw new TypeError(`Invalid predicate: ${util.inspect(predicate)}`);
		}

		if (values.length === 0) {
			throw new TypeError('Invalid number of values');
		}

		return method.call(values, predicate);
	};

	// We can't use rest parameters in node v4 due to the lack of the spread operator.
	// Therefore We have to use anonymous functions for the any() and all() methods
	// tslint:disable:only-arrow-functions no-function-expression
	export function any(...predicate: any[]): any; // tslint:disable-line:variable-name
	export function any(predicate: any) {
		return predicateOnArray(Array.prototype.some, predicate, arguments);
	}

	export function all(...predicate: any[]): any;
	export function all(predicate: any) {
		return predicateOnArray(Array.prototype.every, predicate, arguments);
	}
	// tslint:enable:only-arrow-functions no-function-expression
}

// Some few keywords are reserved, but we'll populate them for Node.js users
// See https://github.com/Microsoft/TypeScript/issues/2536
Object.defineProperties(is, {
	class: {
		value: is.class_
	},
	function: {
		value: is.function_
	},
	null: {
		value: is.null_
	}
});

export default is;

// For CommonJS default export support
module.exports = is;
module.exports.default = is;