UNPKG

chek

Version:

Minimal utility for checking types, working with arrays and objects.

817 lines 246 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>default | Chek</title> <meta name="description" content="Documentation for Chek"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">Chek</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">Chek</a> </li> <li> <a href="default.html">default</a> </li> </ul> <h1>Namespace default</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#assign" class="tsd-kind-icon">assign</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#camelcase" class="tsd-kind-icon">camelcase</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#capitalize" class="tsd-kind-icon">capitalize</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#casttype" class="tsd-kind-icon">cast<wbr>Type</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#clone" class="tsd-kind-icon">clone</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#contains" class="tsd-kind-icon">contains</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#containsany" class="tsd-kind-icon">contains<wbr>Any</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#create" class="tsd-kind-icon">create</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#decamelcase" class="tsd-kind-icon">decamelcase</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#del" class="tsd-kind-icon">del</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#duplicates" class="tsd-kind-icon">duplicates</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#extend" class="tsd-kind-icon">extend</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#first" class="tsd-kind-icon">first</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#flatten" class="tsd-kind-icon">flatten</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#fromepoch" class="tsd-kind-icon">from<wbr>Epoch</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#fromjson" class="tsd-kind-icon">fromJSON</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#get" class="tsd-kind-icon">get</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#gettype" class="tsd-kind-icon">get<wbr>Type</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#has" class="tsd-kind-icon">has</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#includes" class="tsd-kind-icon">includes</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#includesany" class="tsd-kind-icon">includes<wbr>Any</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isarray" class="tsd-kind-icon">is<wbr>Array</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isboolean" class="tsd-kind-icon">is<wbr>Boolean</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isbrowser" class="tsd-kind-icon">is<wbr>Browser</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isbuffer" class="tsd-kind-icon">is<wbr>Buffer</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isdate" class="tsd-kind-icon">is<wbr>Date</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isdebug" class="tsd-kind-icon">is<wbr>Debug</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isdirectory" class="tsd-kind-icon">is<wbr>Directory</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isdocker" class="tsd-kind-icon">is<wbr>Docker</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isequal" class="tsd-kind-icon">is<wbr>Equal</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#iserror" class="tsd-kind-icon">is<wbr>Error</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isfile" class="tsd-kind-icon">is<wbr>File</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isfloat" class="tsd-kind-icon">is<wbr>Float</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isfunction" class="tsd-kind-icon">is<wbr>Function</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isinfinite" class="tsd-kind-icon">is<wbr>Infinite</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isinspect" class="tsd-kind-icon">is<wbr>Inspect</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isinteger" class="tsd-kind-icon">is<wbr>Integer</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#ismoment" class="tsd-kind-icon">is<wbr>Moment</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isnode" class="tsd-kind-icon">is<wbr>Node</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isnull" class="tsd-kind-icon">is<wbr>Null</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isnumber" class="tsd-kind-icon">is<wbr>Number</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isobject" class="tsd-kind-icon">is<wbr>Object</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isplainobject" class="tsd-kind-icon">is<wbr>Plain<wbr>Object</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#ispromise" class="tsd-kind-icon">is<wbr>Promise</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isregexp" class="tsd-kind-icon">is<wbr>Reg<wbr>Exp</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isroot" class="tsd-kind-icon">is<wbr>Root</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isstring" class="tsd-kind-icon">is<wbr>String</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#issymbol" class="tsd-kind-icon">is<wbr>Symbol</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#istruthy" class="tsd-kind-icon">is<wbr>Truthy</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#istype" class="tsd-kind-icon">is<wbr>Type</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isundefined" class="tsd-kind-icon">is<wbr>Undefined</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isundefinedornull" class="tsd-kind-icon">is<wbr>Undefined<wbr>OrNull</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isunique" class="tsd-kind-icon">is<wbr>Unique</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#isvalue" class="tsd-kind-icon">is<wbr>Value</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#iswindows" class="tsd-kind-icon">is<wbr>Windows</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#keys" class="tsd-kind-icon">keys</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#last" class="tsd-kind-icon">last</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#lowercase" class="tsd-kind-icon">lowercase</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#noop" class="tsd-kind-icon">noop</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#noopif" class="tsd-kind-icon">noop<wbr>If</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#omit" class="tsd-kind-icon">omit</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#orderby" class="tsd-kind-icon">order<wbr>By</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#padleft" class="tsd-kind-icon">pad<wbr>Left</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#padright" class="tsd-kind-icon">pad<wbr>Right</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#padvalues" class="tsd-kind-icon">pad<wbr>Values</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#pick" class="tsd-kind-icon">pick</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#pop" class="tsd-kind-icon">pop</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#push" class="tsd-kind-icon">push</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#put" class="tsd-kind-icon">put</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#reverse" class="tsd-kind-icon">reverse</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#set" class="tsd-kind-icon">set</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#shift" class="tsd-kind-icon">shift</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#slugify" class="tsd-kind-icon">slugify</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#splice" class="tsd-kind-icon">splice</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#split" class="tsd-kind-icon">split</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#titlecase" class="tsd-kind-icon">titlecase</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#toarray" class="tsd-kind-icon">to<wbr>Array</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#toboolean" class="tsd-kind-icon">to<wbr>Boolean</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#todate" class="tsd-kind-icon">to<wbr>Date</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#todefault" class="tsd-kind-icon">to<wbr>Default</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#toepoch" class="tsd-kind-icon">to<wbr>Epoch</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tofloat" class="tsd-kind-icon">to<wbr>Float</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tointeger" class="tsd-kind-icon">to<wbr>Integer</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tojson" class="tsd-kind-icon">toJSON</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#tomap" class="tsd-kind-icon">to<wbr>Map</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#tonested" class="tsd-kind-icon">to<wbr>Nested</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#toregexp" class="tsd-kind-icon">to<wbr>Reg<wbr>Exp</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tostr" class="tsd-kind-icon">to<wbr>Str</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="default.html#tounnested" class="tsd-kind-icon">to<wbr>Unnested</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#towindow" class="tsd-kind-icon">to<wbr>Window</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tryrequire" class="tsd-kind-icon">try<wbr>Require</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#tryrootrequire" class="tsd-kind-icon">try<wbr>Root<wbr>Require</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#trywrap" class="tsd-kind-icon">try<wbr>Wrap</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#unshift" class="tsd-kind-icon">unshift</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#uppercase" class="tsd-kind-icon">uppercase</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace"><a href="default.html#uuid" class="tsd-kind-icon">uuid</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="assign" class="tsd-anchor"></a> <h3>assign</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">assign&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L168">src/modules/object.ts:168</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Uses Object.assign if available or falls back to polyfill.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>object to assign.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>additional source object.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="camelcase" class="tsd-anchor"></a> <h3>camelcase</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">camelcase<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/string.ts#L12">src/modules/string.ts:12</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Camelcase Converts string to camelcase.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>val: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to be transformed.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="capitalize" class="tsd-anchor"></a> <h3>capitalize</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">capitalize<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/string.ts#L44">src/modules/string.ts:44</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Capitalize Converts string to capitalize.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>val: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to be transformed.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="casttype" class="tsd-anchor"></a> <h3>cast<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">cast<wbr>Type&lt;T&gt;<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/type.ts#L27">src/modules/type.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cast Type Attempts to cast to specified type.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>val: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to be cast.</p> </div> </li> <li> <h5>type: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the type to cast to.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>optional default value to return on null.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="clone" class="tsd-anchor"></a> <h3>clone</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">clone&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, json<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L260">src/modules/object.ts:260</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Clone Performs deep cloning of objects.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>object to be cloned.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> json: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>performs quick shallow clone using JSON.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="contains" class="tsd-anchor"></a> <h3>contains</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">contains<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, transform<span class="tsd-signature-symbol">?: </span><a href="../modules.html#transform" class="tsd-signature-type" data-tsd-kind="Type alias">Transform</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/array.ts#L96">src/modules/array.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Contains Tests if array contains value.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>arr: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the array to be inspected.</p> </div> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to check if is contained in array.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> transform: <a href="../modules.html#transform" class="tsd-signature-type" data-tsd-kind="Type alias">Transform</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="containsany" class="tsd-anchor"></a> <h3>contains<wbr>Any</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">contains<wbr>Any<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, compare<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, transform<span class="tsd-signature-symbol">?: </span><a href="../modules.html#transform" class="tsd-signature-type" data-tsd-kind="Type alias">Transform</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/array.ts#L114">src/modules/array.ts:114</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Contains Any Tests array check if contains value.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>arr: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the array to be inspected.</p> </div> </li> <li> <h5>compare: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>array of values to compare.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> transform: <a href="../modules.html#transform" class="tsd-signature-type" data-tsd-kind="Type alias">Transform</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="create" class="tsd-anchor"></a> <h3>create</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">create&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L445">src/modules/object.ts:445</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create is a convenience method that simply calls Object.create(). If no object is passed creates using null.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>optional object to use with Object.create.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="decamelcase" class="tsd-anchor"></a> <h3>decamelcase</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">decamelcase<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, separator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/string.ts#L29">src/modules/string.ts:29</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Decamelcase converts a camelcase string to --some-flag.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>val: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to de-camelize.</p> </div> </li> <li> <h5>separator: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;-&#x27;</span></h5> <div class="tsd-comment tsd-typography"> <p>the separator char once decamelized.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="del" class="tsd-anchor"></a> <h3>del</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">del&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, immutable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L182">src/modules/object.ts:182</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Del Removes a property within the supplied object.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the object to inspect.</p> </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the dot notated key or array of keys.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> immutable: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>when true original object NOT mutated.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="duplicates" class="tsd-anchor"></a> <h3>duplicates</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">duplicates<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, breakable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/array.ts#L134">src/modules/array.ts:134</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Duplicates Counts the number of duplicates in an array.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>arr: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the array to check for duplicates.</p> </div> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>the value to match.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> breakable: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>when true allows breaking at first duplicate.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="extend" class="tsd-anchor"></a> <h3>extend</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">extend&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> <li class="tsd-signature tsd-kind-icon">extend&lt;T&gt;<span class="tsd-signature-symbol">(</span>shallow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L277">src/modules/object.ts:277</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Extend properties between target/source objects. This is NOT a deep copy.</p> </div> <p>NOTE: use Object.assign if available!!</p> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>extend({ name: &#39;Bob&#39;, active: true }, { active: undefined })</p> </dd> </dl> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>primary target object.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>additional source objects to merge with target.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/object.ts#L291">src/modules/object.ts:291</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Extend properties between target/source objects. This is NOT a deep copy.</p> </div> <p>NOTE: use Object.assign if available!!</p> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>extend(true, { name: &#39;Bob&#39; }, { nested: { key: &#39;value&#39; } })</p> </dd> </dl> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>shallow: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>when true only extends top level.</p> </div> </li> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>primary target object.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>additional source objects to merge with target.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="first" class="tsd-anchor"></a> <h3>first</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">first&lt;T&gt;<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/array.ts#L195">src/modules/array.ts:195</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>First Simple method to get first element just a little less typing.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>arr: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>the array to get first element from.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <a name="flatten" class="tsd-anchor"></a> <h3>flatten</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">flatten&lt;T&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/modules/array.ts#L170">src/modules/array.ts:170</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Flatten Takes multiple arrays and flattens to single array. NOTE: this will NOT work for empty nested arrays but will work for 90 plus % of cases.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>arr: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"> <a name="fromepoch" class="tsd-anchor"></a> <h3>from<wbr>Epoch</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"> <li class="tsd-signature tsd-kind-icon">from<wbr>Epoch<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/mod