is-or-not
Version:
A Set of `is` and `isNot` functions in JavaScript checking and testing on objects and types
300 lines (157 loc) • 10.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - isOrNot</title>
<meta name="description" content="A Set of `is` and `isNot` functions in JavaScript checking and testing on objects and types" />
<meta name="keywords" content="javascript, utils, is, isnot, types, test, check, testing, type check, js, library" />
<meta name="keyword" content="javascript, utils, is, isnot, types, test, check, testing, type check, js, library" />
<meta property="og:title" content="isOrNot"/>
<meta property="og:type" content="website"/>
<meta property="og:image" content=""/>
<meta property="og:site_name" content="isOrNot"/>
<meta property="og:url" content="https://github.com/AlaeddineMessadi/is-or-not"/>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav class="wrap">
<input type="text" id="nav-search" placeholder="Search" />
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/AlaeddineMessadi/is-or-not" target="_blank" class="menu-item" id="website_link" >Github</a></h2><h3>Global</h3><ul><li><a href="global.html#isArray">isArray</a></li><li><a href="global.html#isBoolean">isBoolean</a></li><li><a href="global.html#isDate">isDate</a></li><li><a href="global.html#isEmpty">isEmpty</a></li><li><a href="global.html#isError">isError</a></li><li><a href="global.html#isFunction">isFunction</a></li><li><a href="global.html#isNotArray">isNotArray</a></li><li><a href="global.html#isNotBoolean">isNotBoolean</a></li><li><a href="global.html#isNotDate">isNotDate</a></li><li><a href="global.html#isNotEmpty">isNotEmpty</a></li><li><a href="global.html#isNotError">isNotError</a></li><li><a href="global.html#isNotFunction">isNotFunction</a></li><li><a href="global.html#isNotNull">isNotNull</a></li><li><a href="global.html#isNotNullOrUndefined">isNotNullOrUndefined</a></li><li><a href="global.html#isNotNumber">isNotNumber</a></li><li><a href="global.html#isNotObject">isNotObject</a></li><li><a href="global.html#isNotPrimitive">isNotPrimitive</a></li><li><a href="global.html#isNotRegExp">isNotRegExp</a></li><li><a href="global.html#isNotString">isNotString</a></li><li><a href="global.html#isNotSymbol">isNotSymbol</a></li><li><a href="global.html#isNotUndefined">isNotUndefined</a></li><li><a href="global.html#isNull">isNull</a></li><li><a href="global.html#isNullOrUndefined">isNullOrUndefined</a></li><li><a href="global.html#isNumber">isNumber</a></li><li><a href="global.html#isObject">isObject</a></li><li><a href="global.html#isPrimitive">isPrimitive</a></li><li><a href="global.html#isRegExp">isRegExp</a></li><li><a href="global.html#isString">isString</a></li><li><a href="global.html#isSymbol">isSymbol</a></li><li><a href="global.html#isUndefined">isUndefined</a></li><li><a href="global.html#utils">utils</a></li></ul>
</nav>
<div id="main">
<section class="package">
<h3> </h3>
</section>
<section class="readme usertext">
<article><h1>IsOrNot</h1>
<p><a href="https://travis-ci.com/AlaeddineMessadi/is-or-not"><img src="https://travis-ci.com/AlaeddineMessadi/is-or-not.svg?branch=main" alt="Build Status"></a></p>
<h2>Description</h2>
<p><a href="https://github.com/AlaeddineMessadi/is-or-not">github</a></p>
<p><a href="https://alaeddinemessadi.github.io/is-or-not/index.html">documentation</a></p>
<p>A Set of <code>is</code> and <code>isNot</code> functions in JavaScript checking and testing on objects and types</p>
<h2>Install</h2>
<pre class="prettyprint source lang-bash"><code>$ yarn add is-or-not
</code></pre>
<p>or</p>
<pre class="prettyprint source lang-bash"><code>$ npm install is-or-not
</code></pre>
<h2>Usage</h2>
<pre class="prettyprint source lang-javascript"><code>const utils = require("is-or-not");
utils.isNull(null); // type is null => true
utils.isNull(undefined); // type is undefined => false
utils.isNotNull(undefined); // correct it's undefined=> true
utils.isNotEmpty(["🦄", "🐶", "🐼"]); // array contain values => false
utils.isNotEmpty([]); // array is empty => false
/** ... */
utils.isString("Hello World!"); // Type is String => true
utils.isNotString(["🐶", "🦄"]); // true because type is array => true
/** ... */
utils.isPrimitive("Primitive type?"); // String is a Primitive type => true
utils.isNotPrimitive("Not primitive type?"); // False because it's a string, primitive => false
/** ... */
utils.isNullOrUndefined("Hello!"); // String is not null or undefined => false
utils.isNullOrUndefined(undefined); // => true
utils.isNotNullOrUndefined("Not primitive type?"); // true it's a string => true
utils.isNotNullOrUndefined(null); // it is null => false
.
.
.
</code></pre>
<h2>Documentation</h2>
<p><a href="https://alaeddinemessadi.github.io/is-or-not/index.html">documentation</a></p>
<ul>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isArray">isArray</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isBoolean">isBoolean</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isDate">isDate</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isEmpty">isEmpty</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isError">isError</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isFunction">isFunction</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotArray">isNotArray</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotBoolean">isNotBoolean</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotDate">isNotDate</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotEmpty">isNotEmpty</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotError">isNotError</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotFunction">isNotFunction</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotNull">isNotNull</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotNullOrUndefined">isNotNullOrUndefined</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotNumber">isNotNumber</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotObject">isNotObject</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotPrimitive">isNotPrimitive</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotRegExp">isNotRegExp</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotString">isNotString</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotSymbol">isNotSymbol</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNotUndefined">isNotUndefined</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNull">isNull</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNullOrUndefined">isNullOrUndefined</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isNumber">isNumber</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isObject">isObject</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isPrimitive">isPrimitive</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isRegExp">isRegExp</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isString">isString</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isSymbol">isSymbol</a></li>
<li><a href="https://alaeddinemessadi.github.io/is-or-not/global.html#isUndefined">isUndefined</a></li>
</ul>
<h2>Contribution</h2>
<p>Clone the Github Repository</p>
<pre class="prettyprint source lang-bash"><code>$ git clone git@github.com:AlaeddineMessadi/utils-is.git
</code></pre>
<p>All functions' implementations are in the <code>index.js</code> file.</p>
<p>Tests are defined in the <code>test.js</code> file</p>
<h4>Running tests</h4>
<pre class="prettyprint source lang-bash"><code>$ yarn test
// or
$ yarn test:watch
</code></pre>
<p>or with npm</p>
<pre class="prettyprint source lang-bash"><code>$ npm run test
or
$ npm run test:watch
</code></pre></article>
</section>
<section>
<header>
<h2>
index.js
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line21">line 21</a>
</li></ul></dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>Alaeddine Messadi (https://almessadi.com)</li></ul></dd>
<dt class="tag-license">License:</dt>
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
</dl>
<div class="description usertext"><p>index.js</p></div>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Tue Feb 02 2021 16:06:04 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/search.js" defer></script>
<script src="scripts/collapse.js" defer></script>
</body>
</html>