@terminus/ngx-tools
Version:
[![CircleCI][circle-badge]][circle-link] [![codecov][codecov-badge]][codecov-project] [![semantic-release][semantic-release-badge]][semantic-release] [![MIT License][license-image]][license-url] <br> [![NPM version][npm-version-image]][npm-url] [![Github
543 lines (494 loc) • 21.7 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('date-fns')) :
typeof define === 'function' && define.amd ? define('@terminus/ngx-tools/type-guards', ['exports', 'date-fns'], factory) :
(global = global || self, factory((global.terminus = global.terminus || {}, global.terminus['ngx-tools'] = global.terminus['ngx-tools'] || {}, global.terminus['ngx-tools']['type-guards'] = {}), global.dateFns));
}(this, (function (exports, dateFns) { 'use strict';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
***************************************************************************** */
/* global Reflect, Promise */
var extendStatics = function(d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
function __extends(d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
}
var __assign = function() {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __rest(s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
}
function __decorate(decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
}
function __param(paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); }
}
function __metadata(metadataKey, metadataValue) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
}
function __awaiter(thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
}
function __exportStar(m, exports) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
function __values(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
}
function __read(o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
}
function __spread() {
for (var ar = [], i = 0; i < arguments.length; i++)
ar = ar.concat(__read(arguments[i]));
return ar;
}
function __spreadArrays() {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
function __await(v) {
return this instanceof __await ? (this.v = v, this) : new __await(v);
}
function __asyncGenerator(thisArg, _arguments, generator) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var g = generator.apply(thisArg, _arguments || []), i, q = [];
return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
function fulfill(value) { resume("next", value); }
function reject(value) { resume("throw", value); }
function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
}
function __asyncDelegator(o) {
var i, p;
return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
}
function __asyncValues(o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
}
function __makeTemplateObject(cooked, raw) {
if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
return cooked;
};
function __importStar(mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result.default = mod;
return result;
}
function __importDefault(mod) {
return (mod && mod.__esModule) ? mod : { default: mod };
}
function __classPrivateFieldGet(receiver, privateMap) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to get private field on non-instance");
}
return privateMap.get(receiver);
}
function __classPrivateFieldSet(receiver, privateMap, value) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to set private field on non-instance");
}
privateMap.set(receiver, value);
return value;
}
/**
* Determine if an item is an Array
*
* NOTE: This is the fastest performer across all primary browsers.
*
* @param item - The item to test
* @returns The result
*
* @example
* isArray([1, 2]); // Returns: true
* isArray<string>(['foo', 'bar']); // Returns: true
* isArray('foo'); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isArray = function (item) { return !!(item && item.constructor === Array); };
/**
* Determine if an item is null
*
* @param x - The value to test
* @returns The result
*
* @example
* isNull(null) // Returns: true
* isNull(1) // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isNull = function (x) { return x === null; };
/**
* Check that all elements are set
*
* @param arr - The array
* @returns Boolean
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function arrayHasAllElementsSet(arr) {
var e_1, _a;
if (!isArray(arr)) {
return false;
}
try {
for (var arr_1 = __values(arr), arr_1_1 = arr_1.next(); !arr_1_1.done; arr_1_1 = arr_1.next()) {
var item = arr_1_1.value;
if (isNull(item) || typeof item === 'undefined') {
return false;
}
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (arr_1_1 && !arr_1_1.done && (_a = arr_1.return)) _a.call(arr_1);
}
finally { if (e_1) throw e_1.error; }
}
return true;
}
/**
* Determine if the item is an AbstractControl
*
* @param x - The item to test
* @returns The result
*
* @example
* isAbstractControl(new FormControl()) // Returns: true
* isAbstractControl('hi') // Returns: false
*/
var isAbstractControl =
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function (x) { return !!x && x.hasOwnProperty('valueChanges'); };
/**
* Determine if an item is a function
*
* NOTE: While this isn't the fastest performing test in every browser, it is the faster when averaged across the browsers we care about.
*
* @param x - The item to test
* @returns The result
*
* @example
* isFunction(() => {}); // Returns: true
* isFunction('foo'); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isFunction = function (x) { return !!(x && x.constructor && x.call && x.apply); };
/**
* Determine if all array elements are of a certain type
*
* @param x - The array to test
* @param guard - The function to test for the specific type
* @returns The result
*
* @example
* isArrayOfType<number>([1, 5], isNumber) // Returns: true
* isArrayOfType<number>([1, 'foo'], isNumber) // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function isArrayOfType(x, guard) {
var e_1, _a;
if (!guard || !isFunction(guard)) {
return false;
}
try {
for (var x_1 = __values(x), x_1_1 = x_1.next(); !x_1_1.done; x_1_1 = x_1.next()) {
var value = x_1_1.value;
if (!guard(value)) {
return false;
}
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (x_1_1 && !x_1_1.done && (_a = x_1.return)) _a.call(x_1);
}
finally { if (e_1) throw e_1.error; }
}
return true;
}
/**
* Determine if a value is a boolean
*
* @param value - The value to test
* @returns The result
*
* @example
* isBoolean(true); // Returns: true
* isBoolean('foo'); // Returns: false
*/
var isBoolean =
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function (value) { return value === true || value === false || Object.prototype.toString.call(value) === '[object Boolean]'; };
/**
* Helper function to determine if input is undefined.
*
* @param input - the input being tested
* @returns boolean
*
* @example
* isUndefined(undefined) // Returns: true
* isUndefined(null) // Returns: false
* isUndefined('foo') // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isUndefined = function (input) { return input === undefined; };
/**
* Determine if the item has a value
*
* @param x - The value being tested
* @returns The result
*
* @example
* isSet<string>('hi') // Returns: true
* isSet<number>(void 0) // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isSet = function (x) { return !isUndefined(x); };
/**
* Coerce the type to DragEvent
*
* @param x - The item to test
* @returns True if the value is a DragEvent
*
* @example
* isDragEvent(myDragEvent); // Returns: true
* isDragEvent(myClickEvent); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isDragEvent = function (x) { return !!x && isSet(x.dataTransfer); };
/**
* Coerce the type to HTMLInputElement
*
* @param x - The item to test
* @returns True if the value is a HTMLInputElement
*
* @example
* const myInput = document.querySelector('#myInput');
* const myDiv = document.querySelector('#myDiv');
*
* isHTMLInputElement(myInput); // Returns: true
* isHTMLInputElement(myDiv); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isHTMLInputElement = function (x) { return !!x && isSet(x.files); };
/**
* Determine if an item is an HTTP response
*
* @param x - The value to check
* @returns The result
*
* @example
* isHttpResponse({headers: {...}}) // Returns: true
* isHttpResponse<MyResponseType>({foo: 'bar'}) // Returns: false
*/
var isHttpResponse = function (x) { return !isNull(x) && !isUndefined(x) && x.hasOwnProperty('headers'); };
/**
* Coerce the type to KeyboardEvent
*
* @param x - The item to test
* @returns True if the value is a KeyboardEvent
*
* @example
* isKeyboardEvent(myKeyboardEvent); // Returns: true
* isKeyboardEvent(myClickEvent); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isKeyboardEvent = function (x) { return !!x && isSet(x.code); };
/**
* Coerce the type to MouseEvent
*
* @param x - The item to test
* @returns True if the value is a MouseEvent
*
* @example
* isMouseEvent(myMouseEvent); // Returns: true
* isMouseEvent(myKeyboardEvent); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isMouseEvent = function (x) { return !!x && isSet(x.relatedTarget); };
/**
* Determine if a value is a number
*
* @param value - The value to check
* @returns The result
*
* @example
* isNumber(2) // Returns: true
* isNumber('2') // Returns: true
* isNumber('a') // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isNumber = function (value) { return !isNaN(parseFloat(value)) && !isNaN(Number(value)); };
/**
* Determine if an item is an object
*
* @param x - The item to test
* @returns The result
*
* @example
* isObject({}); // Returns: true
* isObject('foo'); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isObject = function (x) { return Object.prototype.toString.call(x) === '[object Object]'; };
/**
* Determine if a value is a string
*
* @param x - The value to test
* @returns The result
*
* @example
* isString('foo'); // Returns: true
* isString({}); // Returns: false
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
var isString = function (x) { return !!(typeof x === 'string' || x instanceof String); };
/**
* Determine if an item is a token response
*
* @param x - The item to check
* @returns The result
*
* @example
* isTokenResponse({token: 'any'}) // Returns: true
* isTokenResponse<MyResponseType>({foo: 'bar'}) // Returns: false
*/
var isTokenResponse = function (x) { return !isNull(x) && !isUndefined(x) && x.hasOwnProperty('token'); };
/**
* Determine if an item is a valid date
*
* @param value - The item to test
* @returns The result
*
* @example
* isValidDate('foo'); // Returns: false
* isValidDate('2020-02-07'); // Returns: true
*/
function isValidDate(value) {
var date = (typeof value === 'string') ? new Date(value) : value;
return dateFns.isValid(date);
}
exports.arrayHasAllElementsSet = arrayHasAllElementsSet;
exports.isAbstractControl = isAbstractControl;
exports.isArray = isArray;
exports.isArrayOfType = isArrayOfType;
exports.isBoolean = isBoolean;
exports.isDragEvent = isDragEvent;
exports.isFunction = isFunction;
exports.isHTMLInputElement = isHTMLInputElement;
exports.isHttpResponse = isHttpResponse;
exports.isKeyboardEvent = isKeyboardEvent;
exports.isMouseEvent = isMouseEvent;
exports.isNull = isNull;
exports.isNumber = isNumber;
exports.isObject = isObject;
exports.isSet = isSet;
exports.isString = isString;
exports.isTokenResponse = isTokenResponse;
exports.isUndefined = isUndefined;
exports.isValidDate = isValidDate;
Object.defineProperty(exports, '__esModule', { value: true });
})));
//# sourceMappingURL=terminus-ngx-tools-type-guards.umd.js.map