📝 Publish documentation

zenika-open-source · Jun 13, 2017 · 9c84b8f · 9c84b8f
1 parent 294ee91
commit 9c84b8f
Show file tree

Hide file tree

Showing 25 changed files with 4,248 additions and 0 deletions.
diff --git a/docs/immutadot/0.1.11/array.html b/docs/immutadot/0.1.11/array.html
diff --git a/docs/immutadot/0.1.11/array_index.js.html b/docs/immutadot/0.1.11/array_index.js.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>array/index.js - Documentation</title>
+
+    <!--[if lt IE 9]>
+        <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/main.css">
+</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="nav">
+    <h2 class="home-link"><a href="index.html">immutad●t</a></h2><h3>Namespaces</h3><ul><li><details open><summary><a href="array.html">array</a></summary><ul class='methods'><li data-type='method'><a href="array.html#.push">push</a></li><li data-type='method'><a href="array.html#.xor">xor</a></li></ul></details></li><li><details open><summary><a href="collection.html">collection</a></summary><ul class='methods'><li data-type='method'><a href="collection.html#.map">map</a></li></ul></details></li><li><details open><summary><a href="core.html">core</a></summary><ul class='methods'><li data-type='method'><a href="core.html#.set">set</a></li><li data-type='method'><a href="core.html#.unset">unset</a></li><li data-type='method'><a href="core.html#.update">update</a></li></ul></details></li><li><details open><summary><a href="lang.html">lang</a></summary><ul class='methods'><li data-type='method'><a href="lang.html#.toggle">toggle</a></li></ul></details></li><li><details open><summary><a href="math.html">math</a></summary><ul class='methods'><li data-type='method'><a href="math.html#.add">add</a></li></ul></details></li><li><details open><summary><a href="seq.html">seq</a></summary><ul class='methods'><li data-type='method'><a href="seq.html#.chain">chain</a></li><li data-type='method'><a href="seq.html#value">value</a></li></ul></details></li></ul>
+</nav>
+
+<div id="main" class="main-container">
+
+        <h1 class="page-title">array/index.js</h1>
+
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="source linenums"><code><ol class="lines"><li id="line1" class="line"><span class="hljs-keyword">import</span> push <span class="hljs-keyword">from</span> <span class="hljs-string">'./push'</span></li><li id="line2" class="line"><span class="hljs-keyword">import</span> xor <span class="hljs-keyword">from</span> <span class="hljs-string">'./xor'</span></li><li id="line3" class="line"></li><li id="line4" class="line"><span class="hljs-comment">/**</span></li><li id="line5" class="line"><span class="hljs-comment"> * Array functions.</span></li><li id="line6" class="line"><span class="hljs-comment"> * @namespace array</span></li><li id="line7" class="line"><span class="hljs-comment"> * @since 0.1.6</span></li><li id="line8" class="line"><span class="hljs-comment"> */</span></li><li id="line9" class="line"><span class="hljs-keyword">export</span> {</li><li id="line10" class="line">  push,</li><li id="line11" class="line">  xor,</li><li id="line12" class="line">}</li><li id="line13" class="line"></li></ol></code></pre>
+        </article>
+    </section>
+
+
+
+
+
+</div>
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script src="scripts/main.js"></script>
+</body>
+</html>
diff --git a/docs/immutadot/0.1.11/array_push.js.html b/docs/immutadot/0.1.11/array_push.js.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>array/push.js - Documentation</title>
+
+    <!--[if lt IE 9]>
+        <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/main.css">
+</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="nav">
+    <h2 class="home-link"><a href="index.html">immutad●t</a></h2><h3>Namespaces</h3><ul><li><details open><summary><a href="array.html">array</a></summary><ul class='methods'><li data-type='method'><a href="array.html#.push">push</a></li><li data-type='method'><a href="array.html#.xor">xor</a></li></ul></details></li><li><details open><summary><a href="collection.html">collection</a></summary><ul class='methods'><li data-type='method'><a href="collection.html#.map">map</a></li></ul></details></li><li><details open><summary><a href="core.html">core</a></summary><ul class='methods'><li data-type='method'><a href="core.html#.set">set</a></li><li data-type='method'><a href="core.html#.unset">unset</a></li><li data-type='method'><a href="core.html#.update">update</a></li></ul></details></li><li><details open><summary><a href="lang.html">lang</a></summary><ul class='methods'><li data-type='method'><a href="lang.html#.toggle">toggle</a></li></ul></details></li><li><details open><summary><a href="math.html">math</a></summary><ul class='methods'><li data-type='method'><a href="math.html#.add">add</a></li></ul></details></li><li><details open><summary><a href="seq.html">seq</a></summary><ul class='methods'><li data-type='method'><a href="seq.html#.chain">chain</a></li><li data-type='method'><a href="seq.html#value">value</a></li></ul></details></li></ul>
+</nav>
+
+<div id="main" class="main-container">
+
+        <h1 class="page-title">array/push.js</h1>
+
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="source linenums"><code><ol class="lines"><li id="line1" class="line"><span class="hljs-keyword">import</span> toArray <span class="hljs-keyword">from</span> <span class="hljs-string">'lodash/toArray'</span></li><li id="line2" class="line"><span class="hljs-keyword">import</span> update <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/update'</span></li><li id="line3" class="line"></li><li id="line4" class="line"><span class="hljs-comment">/**</span></li><li id="line5" class="line"><span class="hljs-comment"> * Replaces by a new array containing the elements of the former array and one or more elements added to the end.</span></li><li id="line6" class="line"><span class="hljs-comment"> * @function push</span></li><li id="line7" class="line"><span class="hljs-comment"> * @memberof array</span></li><li id="line8" class="line"><span class="hljs-comment"> * @param {Object} object The object to modify.</span></li><li id="line9" class="line"><span class="hljs-comment"> * @param {Array|string} path The path of the property to set.</span></li><li id="line10" class="line"><span class="hljs-comment"> * @param {...*} values The values to add.</span></li><li id="line11" class="line"><span class="hljs-comment"> * @return {Object} Returns the updated object.</span></li><li id="line12" class="line"><span class="hljs-comment"> * @example &lt;caption&gt;Add one element.&lt;/caption&gt;</span></li><li id="line13" class="line"><span class="hljs-comment"> * push({ nested: { prop: [1, 2] } }, 'nested.prop', 3) // =&gt; { nested: { prop: [1, 2, 3] } }</span></li><li id="line14" class="line"><span class="hljs-comment"> * @example &lt;caption&gt;Add several elements.&lt;/caption&gt;</span></li><li id="line15" class="line"><span class="hljs-comment"> * push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4) // =&gt; { nested: { prop: [1, 2, 3, 4] } }</span></li><li id="line16" class="line"><span class="hljs-comment"> * @see {@link https://lodash.com/docs#toArray|lodash.toArray} for more information.</span></li><li id="line17" class="line"><span class="hljs-comment"> * @see {@link https://mdn.io/Array.prototype.push|Array.prototype.push} for more information.</span></li><li id="line18" class="line"><span class="hljs-comment"> * @see {@link core.update|update} for more information.</span></li><li id="line19" class="line"><span class="hljs-comment"> * @since 0.1.7</span></li><li id="line20" class="line"><span class="hljs-comment"> */</span></li><li id="line21" class="line"><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> update(<span class="hljs-function">(<span class="hljs-params">value, ...values</span>) =&gt;</span> {</li><li id="line22" class="line">  <span class="hljs-keyword">const</span> newValue = toArray(value)</li><li id="line23" class="line">  newValue.push(...values)</li><li id="line24" class="line">  <span class="hljs-keyword">return</span> newValue</li><li id="line25" class="line">})</li><li id="line26" class="line"></li></ol></code></pre>
+        </article>
+    </section>
+
+
+
+
+
+</div>
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script src="scripts/main.js"></script>
+</body>
+</html>
diff --git a/docs/immutadot/0.1.11/array_xor.js.html b/docs/immutadot/0.1.11/array_xor.js.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>array/xor.js - Documentation</title>
+
+    <!--[if lt IE 9]>
+        <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/main.css">
+</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="nav">
+    <h2 class="home-link"><a href="index.html">immutad●t</a></h2><h3>Namespaces</h3><ul><li><details open><summary><a href="array.html">array</a></summary><ul class='methods'><li data-type='method'><a href="array.html#.push">push</a></li><li data-type='method'><a href="array.html#.xor">xor</a></li></ul></details></li><li><details open><summary><a href="collection.html">collection</a></summary><ul class='methods'><li data-type='method'><a href="collection.html#.map">map</a></li></ul></details></li><li><details open><summary><a href="core.html">core</a></summary><ul class='methods'><li data-type='method'><a href="core.html#.set">set</a></li><li data-type='method'><a href="core.html#.unset">unset</a></li><li data-type='method'><a href="core.html#.update">update</a></li></ul></details></li><li><details open><summary><a href="lang.html">lang</a></summary><ul class='methods'><li data-type='method'><a href="lang.html#.toggle">toggle</a></li></ul></details></li><li><details open><summary><a href="math.html">math</a></summary><ul class='methods'><li data-type='method'><a href="math.html#.add">add</a></li></ul></details></li><li><details open><summary><a href="seq.html">seq</a></summary><ul class='methods'><li data-type='method'><a href="seq.html#.chain">chain</a></li><li data-type='method'><a href="seq.html#value">value</a></li></ul></details></li></ul>
+</nav>
+
+<div id="main" class="main-container">
+
+        <h1 class="page-title">array/xor.js</h1>
+
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="source linenums"><code><ol class="lines"><li id="line1" class="line"><span class="hljs-keyword">import</span> update <span class="hljs-keyword">from</span> <span class="hljs-string">'../core/update'</span></li><li id="line2" class="line"><span class="hljs-keyword">import</span> xor <span class="hljs-keyword">from</span> <span class="hljs-string">'lodash/xor'</span></li><li id="line3" class="line"></li><li id="line4" class="line"><span class="hljs-comment">/**</span></li><li id="line5" class="line"><span class="hljs-comment"> * Replaces by an array of unique values that is the symmetric difference of the former array and the given arrays.</span></li><li id="line6" class="line"><span class="hljs-comment"> * @function xor</span></li><li id="line7" class="line"><span class="hljs-comment"> * @memberof array</span></li><li id="line8" class="line"><span class="hljs-comment"> * @param {Object} object The object to modify.</span></li><li id="line9" class="line"><span class="hljs-comment"> * @param {Array|string} path The path of the property to set.</span></li><li id="line10" class="line"><span class="hljs-comment"> * @param {...Array} arrays The arrays to inspect.</span></li><li id="line11" class="line"><span class="hljs-comment"> * @return {Array} Returns the new array of filtered values.</span></li><li id="line12" class="line"><span class="hljs-comment"> * @example xor({ nested: { prop: [1, 2] } }, 'nested.prop', [2, 3]) // =&gt; { nested: { prop: [1, 3] } }</span></li><li id="line13" class="line"><span class="hljs-comment"> * @see {@link https://lodash.com/docs#xor|lodash.xor} for more information.</span></li><li id="line14" class="line"><span class="hljs-comment"> * @see {@link core.update|update} for more information.</span></li><li id="line15" class="line"><span class="hljs-comment"> * @since 0.1.6</span></li><li id="line16" class="line"><span class="hljs-comment"> */</span></li><li id="line17" class="line"><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> update(xor)</li><li id="line18" class="line"></li></ol></code></pre>
+        </article>
+    </section>
+
+
+
+
+
+</div>
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script src="scripts/main.js"></script>
+</body>
+</html>