Powerful package to check for variable types, values and others.
npm install flk-supportive-isnpm install flk-supportive-is
js
const {Is} = require('flk-supportive-is');
`
$3
`js
import Is from 'flk-supportive-is';
`
$3
`html
`
Dependencies
> No dependencies required to use this library
Usage
$3
Check if the given value is null
` javascript
let name = null;
console.log(Is.null(name)); // true
name = undefined;
console.log(Is.null(name)); // false
`
$3
Check if the given value is undefined
` javascript
let name = 'Hasan';
console.log(Is.undefined(name)); // false
let myVar; // any declared variable without a value will be treated as undefined
console.log(Is.undefined(myVar)); // true
let age = undefined;
console.log(Is.undefined(age)); // true
`
$3
Check if the given value is a number whatever if its data type is String or Number
` javascript
let numberInt = 12;
console.log(Is.numeric(numberInt)); // true
let numberFloat = 12.55;
console.log(Is.numeric(numberFloat)); // true
let numberWrittenInString = '99';
console.log(Is.numeric(numberWrittenInString)); // true
let floatWrittenInString = '99.99';
console.log(Is.numeric(floatWrittenInString)); // true
`
$3
Check if the given value is an integer and its data type is number
` javascript
let number = 12;
console.log(Is.int(numberInt)); // true
let numberInString = '12';
console.log(Is.int(numberInString)); // false
`
$3
Check if the given value is a float number and its data type is number
` javascript
let number = 921;
console.log(Is.float(number)); // false
number = 82.42;
console.log(Is.float(number)); // true
let numberInString = '12.5';
console.log(Is.float(numberInString)); // false
`
$3
Check if the given value is Not a Number
This method works exactly same as isNaN as it is already implementing it xD.
` javascript
let number = 76; // number int
console.log(Is.NaN(number)); // false
number = '76'; // string
console.log(Is.NaN(number)); // true
`
$3
Check if the given value is a regex expression.
` javascript
let regex = /[a-z]+/;
console.log(Is.regex(regex)); // true
let string = '/[a-z]+/';
console.log(Is.regex(string)); // false
`
$3
Check if the given value is an array
` javascript
let myArray = [4 , 'hello', 9];
console.log(Is.array(myArray)); // true
`
$3
Check if the given value is an object
Any type of objects will be validated true no matter its object type
> Arrays are types of objects so any passed array will be validated as true
` javascript
let myObject = {};
console.log(Is.object(myObject)); // true
class myClass {}
let anotherObject = new myClass;
console.log(Is.object(myObject)); // true
let myArray = [];
console.log(Is.object(myArray)); // true
// to check if the given value is an object but not an array
//you must mix between Is.object AND Is.array to avoid an array
if (Is.object(myVar) && ! Is.array(myVar)) {
// do something with that object
}
`
$3
Check if the given value is a plain object
Any type of objects will be validated as false unless it's a {} plain object.
` javascript
let myObject = {};
console.log(Is.plainObject(myObject)); // true
class myClass {}
let anotherObject = new myClass;
console.log(Is.plainObject(myObject)); // false
let myArray = [];
console.log(Is.plainObject(myArray)); // false
`
$3
Check if the given value is a valid html id attribute
` javascript
let id = 'my-id';
console.log(Is.validHtmlId(id)); // true
let invalidId = 'my,id';
console.log(Is.validHtmlId(invalidId)); //false
`
$3
Check if the given value is a jquery object
` javascript
let body = $('body');
console.log(Is.jquery(body)); // true
`
$3
Check if the given value is a dom element
> Dom Elements are objects of HTMLElement, so any html element will be validated as true, something like document.body
> document and window are not validated as true as they are not part of the html elements
` javascript
console.log(Is.dom(document)); // false
console.log(Is.dom(document.document)); // true
let myForm = document.getElementById('my-form');
console.log(Is.dom(document.body)); // true
`
$3
Check if the given value is an instance of HTMLFormElement.
` javascript
let myForm = document.getElementById('my-form');
console.log(Is.formElement(myForm)); // true
console.log(Is.formElement(document.body)); // false
`
$3
Check if the given value is an instance of FormData.
` javascript
let myForm = document.getElementById('my-form');
let formDataForm = new FormData(myForm);
console.log(Is.formData(myForm)); // false
console.log(Is.formData(formDataForm)); // true
`
$3
Check if the given object value is an object of the given class name
` javascript
class MyClass {}
let myObject = new MyClass;
console.log(Is.a(moyObject, 'MyClass')); // true
`
$3
Check if the given object is iterable
` javascript
console.log(Is.iterable([])); // true
console.log(Is.iterable({})); // false
console.log(Is.iterable(new Map)); // true
console.log(Is.iterable(new Set)); // true
`
$3
Check if the given value is a Symbol
` javascript
console.log(Is.symbol(Symbol())); // true
console.log(Is.symbol(Symbol('foo'))); // true
`
$3
Check if the given value is string
` javascript
console.log(Is.string('this is a string')); // true
`
$3
> Is.bool has an alias method Is.boolean
Check if the given value is a boolean value.
` javascript
console.log(Is.bool(true)); // true
console.log(Is.bool(false)); // true
`
$3
Check if the given value is a function
` javascript
function sum(x, y) {
return x + y;
}
// you must pass the function name not the function call
console.log(Is.function(sum)); // true
// if you passed the function call it will be not a function in this situation
console.log(Is.function(sum(2, 3))); // false
`
$3
Check if the given value is a callable value
` javascript
function sum(x, y) {
return x + y;
}
console.log(Is.callable(sum)); // true
let callback = function () {
return 'hello';
}
console.log(Is.callable(callback)); // true
console.log(Is.callable(callback())); // false
`
$3
Check if the given value is a native function
` javascript
let isArray = Array.isArray;
console.log(Is.native(isArray)); // true
console.log(Is.native(Math.min)); // true
Math.sum = function (num1, num2) {
return num1 + num2;
};
console.log(Is.native(Math.sum)); // false
`
$3
Check if the given value is a string, number or boolean
` javascript
console.log(Is.scalar('hello')); // true
console.log(Is.scalar(22.5)); // true
console.log(Is.scalar(false)); // true
console.log(Is.scalar(null)); // false
console.log(Is.scalar(undefined)); // false
console.log(Is.scalar([])); // false
console.log(Is.scalar({})); // false
`
$3
Check if the given value is empty
> This is a kind of smart method that will validate the given value whether it is empty or not based on its type
` javascript
// undefined values are considered empty
let value = undefined;
console.log(Is.empty(value)); // true
// null values are considered empty
value = null;
console.log(Is.empty(value)); // true
// Also any objects with no values are considered empty
value = {};
console.log(Is.empty(value)); // true
value.name = 'Hasan';
console.log(Is.empty(value)); // false
// Arrays
value = [];
console.log(Is.empty(value)); // true
value.push(12);
console.log(Is.empty(value)); // false
// The Zero is not considered as empty value
value = 0;
console.log(Is.empty(value)); // false
`
$3
Check if the given value string is a valid json format
` javascript
let value = '{"name":"Hasan","job":"Full Stack Developer"}';
console.log(Is.json(value)); // true
`
$3
Check if the given value is a valid url
` javascript
let url = 'google.com';
console.log(Is.url(url)); // true
url = 'https://google.com';
console.log(Is.url(url)); // true
url = 'www.google.com';
console.log(Is.url(url)); // true
url = 'www.google.com?q=hello+world';
console.log(Is.url(url)); // true
let url = 'google';
console.log(Is.url(url)); // false
`
$3
Check if the given value string is a valid email
` javascript
let myEmail = 'hassanzohdy@gmail.com';
console.log(Is.email(myEmail)); // true
`
$3
Check if cookies are enabled in the browser
` javascript
if (! Is.cookeEnabled()) {
// Oops!, cookies are not enabled!
}
`
$3
Check if current visitor is browsing from a sort-of mobile
> this property contains set of methods
` javascript
// To check if user is browsing from an android device
if (Is.mobile.andriod()) {
// do something
}
// To check if user is browsing from a blackBerry mobile
if (Is.mobile.blackBerry()) {
// do something
}
// To check if user is browsing from an ios device
if (Is.mobile.ios()) {
// do something
}
// To check if user is browsing from an ios device
if (Is.mobile.ios()) {
// do something
}
// To check if user is browsing from an iphone
if (Is.mobile.iphone()) {
// do something
}
// To check if user is browsing from an ipad
if (Is.mobile.ipad()) {
// do something
}
// To check if user is browsing from an ipod
if (Is.mobile.ipod()) {
// do something
}
// To check if user is browsing from a windows mobile
if (Is.mobile.windows()) {
// do something
}
// To check if user is browsing from any type of mobile
if (Is.mobile.any()) {
// do something
}
`
$3
Check if current visitor is browsing from a desktop device
> Please note that any non mobile type will be considered as desktop.
` javascript
if (! Is.cookeEnabled()) {
// Oops!, cookies are not enabled!
}
`
$3
Check if the current browser matches the given name
`javascript
if (Is.browser('chrome')) {
// do something
} else if (Is.browser('firefox')) {
// do something
} else if (Is.browser('opera')) {
// do something
} else if (Is.browser('safari')) {
// do something
} else if (Is.browser('ie')) {
// do something
} else if (Is.browser('edge')) {
// do something
}
`
$3
> Works only with Egypt mobile numbers, feel free to PR your country mobile number validation.
#### .eg
> Validate mobile number for the following syntaxes:
- 01[0|1|2|5]-8(digits)
- +201[0|1|2|5]-8(digits)
- 201[0|1|2|5]-8(digits)
`js
let withCode = true; // to bypass mobile numbers starting with country code
console.log(Is.mobileNumber.eg('01002223344')); // true
console.log(Is.mobileNumber.eg('+201002223344', withCode)); // true
console.log(Is.mobileNumber.eg('201002223344', withCode)); // true
``