(doc -) Updates documentation

origamitower · May 3, 2017 · c48d1c6 · c48d1c6
1 parent 0f9f091
commit c48d1c6
Show file tree

Hide file tree

Showing 75 changed files with 2,472 additions and 65 deletions.
diff --git a/docs/api/en/-unknown-module-.folktale.data.future._deferred.prototype.html b/docs/api/en/-unknown-module-.folktale.data.future._deferred.prototype.html
@@ -0,0 +1,37 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title></title>
+    <link rel="stylesheet" href="prism.css">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <div id="header">
+      <div class="doc-title"><a href="folktale.html"><span class="doc-title"><span class="product-name">Folktale</span><span class="version">v2.0.0-alpha5</span></span></a><ul class="navigation"><li class="navigation-item"><a href="https://github.com/origamitower/folktale" title="">GitHub</a></li><li class="navigation-item"><a href="folktale.html#cat-2-support" title="">Support</a></li><li class="navigation-item"><a href="folktale.html#cat-3-contributing" title="">Contributing</a></li></ul></div>
+    </div>
+    <div id="content-wrapper"><div id="content-panel"><h1 class="entity-title">(Anonymous)</h1><div class="highlight-summary"><div><p>A container for methods of Deferreds.</p>
+</div></div><h2 class="section-title">Documentation</h2><div class="documentation"><div><p>A container for methods of Deferreds.</p>
+</div></div><div class="members"><h2 class="section-title" id="properties">Properties</h2><div class="member-category"><h3 class="category" id="cat-data-fields">Data Fields</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.data.future._deferred._listeners.html">get _listeners</a><div class="doc-summary"><div><p>An array of visitors providing functions to be ran when the deferred&#39;s state changes.</p>
+</div></div><div class="special-tags"><span class="tagged required">Abstract</span></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred._state.html">get _state</a><div class="doc-summary"><div><p>The current state of the deferred, as an ExecutionState.</p>
+</div></div><div class="special-tags"><span class="tagged required">Abstract</span></div></div></div></div><div class="member-category"><h3 class="category" id="cat-debugging">Debugging</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.data.future._deferred.inspect.html">inspect()</a><div class="doc-summary"><div><p>Returns a textual description of the object.</p>
+</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred.tostring.html">toString()</a><div class="doc-summary"><div><p>Returns a textual description of the object.</p>
+</div></div><div class="special-tags"></div></div></div></div><div class="member-category"><h3 class="category" id="cat-extracting-values">Extracting Values</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.data.future._deferred.future.html">future()</a><div class="doc-summary"><div><p>Retrieves the value of a deferred as a Future.</p>
+</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred.promise.html">promise()</a><div class="doc-summary"><div><p>Retrieves the value of a deferred as a Promise. Cancellations are mapped to a rejected promise with a special object.</p>
+</div></div><div class="special-tags"></div></div></div></div><div class="member-category"><h3 class="category" id="cat-reacting-to-deferreds">Reacting to Deferreds</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.data.future._deferred.listen.html">listen(pattern)</a><div class="doc-summary"><div><p>Adds a visitor to be invoked when the deferred&#39;s state changes.</p>
+</div></div><div class="special-tags"></div></div></div></div><div class="member-category"><h3 class="category" id="cat-resolving">Resolving</h3><div class="member-list"><div class="member"><a class="member-name" href="folktale.data.future._deferred.cancel.html">cancel()</a><div class="doc-summary"><div><p>Resolves a deferred with a cancellation value.</p>
+</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred.maybecancel.html">maybeCancel()</a><div class="doc-summary"><div><p>Resolves a deferred with a cancellation value, but doesn&#39;t throw if the deferred has already been resolved.</p>
+</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred.reject.html">reject(reason)</a><div class="doc-summary"><div><p>Resolves a deferred with a failure value.</p>
+</div></div><div class="special-tags"></div></div><div class="member"><a class="member-name" href="folktale.data.future._deferred.resolve.html">resolve(value)</a><div class="doc-summary"><div><p>Resolves a deferred successfully with a value.</p>
+</div></div><div class="special-tags"></div></div></div></div></div></div><div id="meta-panel"><div class="meta-section"></div><div class="table-of-contents"><div class="meta-section-title">On This Page</div><ul class="toc-list level-1"><li class="toc-item"><span class="no-anchor">Documentation</span><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#properties">Properties</a><ul class="toc-list level-2"><li class="toc-item"><a href="#cat-data-fields">Data Fields</a></li><li class="toc-item"><a href="#cat-debugging">Debugging</a></li><li class="toc-item"><a href="#cat-extracting-values">Extracting Values</a></li><li class="toc-item"><a href="#cat-reacting-to-deferreds">Reacting to Deferreds</a></li><li class="toc-item"><a href="#cat-resolving">Resolving</a></li></ul></li></ul></div><div class="meta-section"><strong class="meta-section-title">Authors</strong><div class="meta-field"><strong class="meta-field-title">Authors</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta</li></ul></div></div><div class="meta-field"><strong class="meta-field-title">Maintainers</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta &lt;[email protected]&gt; (http://robotlolita.me/)</li></ul></div></div></div></div></div>
+    <script>
+void function() {
+  var xs = document.querySelectorAll('.documentation pre code');
+  for (var i = 0; i < xs.length; ++i) {
+    xs[i].className = 'language-javascript code-block';
+  }
+}()
+    </script>
+    <script src="prism.js"></script>
+  </body>
+</html>
diff --git a/docs/api/en/-unknown-module-.folktale.data.future._executionstate.inspect.html b/docs/api/en/-unknown-module-.folktale.data.future._executionstate.inspect.html
@@ -0,0 +1,26 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>toString</title>
+    <link rel="stylesheet" href="prism.css">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <div id="header">
+      <div class="doc-title"><a href="folktale.html"><span class="doc-title"><span class="product-name">Folktale</span><span class="version">v2.0.0-alpha5</span></span></a><ul class="navigation"><li class="navigation-item"><a href="https://github.com/origamitower/folktale" title="">GitHub</a></li><li class="navigation-item"><a href="folktale.html#cat-2-support" title="">Support</a></li><li class="navigation-item"><a href="folktale.html#cat-3-contributing" title="">Contributing</a></li></ul></div>
+    </div>
+    <div id="content-wrapper"><div id="content-panel"><h1 class="entity-title">toString</h1><div class="highlight-summary"><div><p>A textual representation of the state.</p>
+</div></div><div class="deprecation-section"><strong class="deprecation-title">This feature is experimental!</strong><p>This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.</p></div><div class="definition"><h2 class="section-title" id="signature">Signature</h2><div class="signature">toString()</div><div class="type-definition"><div class="type-definition-container"><div class="type-title-container"><strong class="type-title">Type</strong><a class="info" href="guides.type-notation-used-in-signatures.html">(what is this?)</a></div><pre class="type"><code class="language-haskell">() =&gt; String</code></pre></div></div></div><h2 class="section-title">Documentation</h2><div class="documentation"><div><p>A textual representation of the state.</p>
+</div></div><div class="members"><h2 class="section-title" id="properties">Properties</h2></div><div class="source-code"><h2 class="section-title" id="source-code">Source Code</h2><div class="source-location"></div><pre class="source-code"><code class="language-javascript">() =&gt; typeName</code></pre></div></div><div id="meta-panel"><div class="meta-section"><div class="meta-field"><strong class="meta-field-title">Stability</strong><div class="meta-field-value">experimental</div></div><div class="meta-field"><strong class="meta-field-title">Licence</strong><div class="meta-field-value">MIT</div></div></div><div class="table-of-contents"><div class="meta-section-title">On This Page</div><ul class="toc-list level-1"><li class="toc-item"><a href="#signature">Signature</a></li><li class="toc-item"><span class="no-anchor">Documentation</span><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#properties">Properties</a><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#source-code">Source Code</a></li></ul></div><div class="meta-section"><strong class="meta-section-title">Authors</strong><div class="meta-field"><strong class="meta-field-title">Copyright</strong><div class="meta-field-value">(c) 2013-2017 Quildreen Motta, and CONTRIBUTORS</div></div><div class="meta-field"><strong class="meta-field-title">Authors</strong><div class="meta-field-value"><ul class="meta-list"><li>@boris-marinov</li></ul></div></div><div class="meta-field"><strong class="meta-field-title">Maintainers</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta &lt;[email protected]&gt; (http://robotlolita.me/)</li></ul></div></div></div></div></div>
+    <script>
+void function() {
+  var xs = document.querySelectorAll('.documentation pre code');
+  for (var i = 0; i < xs.length; ++i) {
+    xs[i].className = 'language-javascript code-block';
+  }
+}()
+    </script>
+    <script src="prism.js"></script>
+  </body>
+</html>
diff --git a/.../api/en/-unknown-module-.folktale.data.future._executionstate.variants.0.constructor.html b/.../api/en/-unknown-module-.folktale.data.future._executionstate.variants.0.constructor.html
@@ -0,0 +1,28 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>constructor</title>
+    <link rel="stylesheet" href="prism.css">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <div id="header">
+      <div class="doc-title"><a href="folktale.html"><span class="doc-title"><span class="product-name">Folktale</span><span class="version">v2.0.0-alpha5</span></span></a><ul class="navigation"><li class="navigation-item"><a href="https://github.com/origamitower/folktale" title="">GitHub</a></li><li class="navigation-item"><a href="folktale.html#cat-2-support" title="">Support</a></li><li class="navigation-item"><a href="folktale.html#cat-3-contributing" title="">Contributing</a></li></ul></div>
+    </div>
+    <div id="content-wrapper"><div id="content-panel"><h1 class="entity-title">constructor</h1><div class="highlight-summary"><div><p>The constructor for the variant</p>
+</div></div><div class="deprecation-section"><strong class="deprecation-title">This feature is experimental!</strong><p>This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.</p></div><div class="definition"><h2 class="section-title" id="signature">Signature</h2><div class="signature">get constructor()</div><div class="type-definition"></div></div><h2 class="section-title">Documentation</h2><div class="documentation"><div><p>The constructor for the variant</p>
+</div></div><div class="members"><h2 class="section-title" id="properties">Properties</h2></div><div class="source-code"><h2 class="section-title" id="source-code">Source Code</h2><div class="source-location">Defined in src/core/adt/data.js at line 95, column 25</div><pre class="source-code"><code class="language-javascript">get constructor() {
+        return constructor;
+      }</code></pre></div></div><div id="meta-panel"><div class="meta-section"><div class="meta-field"><strong class="meta-field-title">Stability</strong><div class="meta-field-value">experimental</div></div><div class="meta-field"><strong class="meta-field-title">Licence</strong><div class="meta-field-value">MIT</div></div></div><div class="table-of-contents"><div class="meta-section-title">On This Page</div><ul class="toc-list level-1"><li class="toc-item"><a href="#signature">Signature</a></li><li class="toc-item"><span class="no-anchor">Documentation</span><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#properties">Properties</a><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#source-code">Source Code</a></li></ul></div><div class="meta-section"><strong class="meta-section-title">Authors</strong><div class="meta-field"><strong class="meta-field-title">Copyright</strong><div class="meta-field-value">(c) 2013-2017 Quildreen Motta, and CONTRIBUTORS</div></div><div class="meta-field"><strong class="meta-field-title">Authors</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta</li></ul></div></div><div class="meta-field"><strong class="meta-field-title">Maintainers</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta &lt;[email protected]&gt; (http://robotlolita.me/)</li></ul></div></div></div></div></div>
+    <script>
+void function() {
+  var xs = document.querySelectorAll('.documentation pre code');
+  for (var i = 0; i < xs.length; ++i) {
+    xs[i].className = 'language-javascript code-block';
+  }
+}()
+    </script>
+    <script src="prism.js"></script>
+  </body>
+</html>
diff --git a/.../api/en/-unknown-module-.folktale.data.future._executionstate.variants.0.hasinstance.html b/.../api/en/-unknown-module-.folktale.data.future._executionstate.variants.0.hasinstance.html
@@ -0,0 +1,30 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>hasInstance</title>
+    <link rel="stylesheet" href="prism.css">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <div id="header">
+      <div class="doc-title"><a href="folktale.html"><span class="doc-title"><span class="product-name">Folktale</span><span class="version">v2.0.0-alpha5</span></span></a><ul class="navigation"><li class="navigation-item"><a href="https://github.com/origamitower/folktale" title="">GitHub</a></li><li class="navigation-item"><a href="folktale.html#cat-2-support" title="">Support</a></li><li class="navigation-item"><a href="folktale.html#cat-3-contributing" title="">Contributing</a></li></ul></div>
+    </div>
+    <div id="content-wrapper"><div id="content-panel"><h1 class="entity-title">hasInstance</h1><div class="highlight-summary"><div><p>True if the value is an instance of the state.</p>
+</div></div><div class="deprecation-section"><strong class="deprecation-title">This feature is experimental!</strong><p>This API is still experimental, so it may change or be removed in future versions. You should not rely on it for production applications.</p></div><div class="definition"><h2 class="section-title" id="signature">Signature</h2><div class="signature">hasInstance(value)</div><div class="type-definition"><div class="type-definition-container"><div class="type-title-container"><strong class="type-title">Type</strong><a class="info" href="guides.type-notation-used-in-signatures.html">(what is this?)</a></div><pre class="type"><code class="language-haskell">(Variant) =&gt; Boolean</code></pre></div></div></div><h2 class="section-title">Documentation</h2><div class="documentation"><div><p>True if the value is an instance of the state.</p>
+</div></div><div class="members"><h2 class="section-title" id="properties">Properties</h2></div><div class="source-code"><h2 class="section-title" id="source-code">Source Code</h2><div class="source-location">Defined in src/core/adt/data.js at line 95, column 25</div><pre class="source-code"><code class="language-javascript">hasInstance(value) {
+        return Boolean(value) 
+        &amp;&amp;     adt.hasInstance(value) 
+        &amp;&amp;     value[TAG] === name;
+      }</code></pre></div></div><div id="meta-panel"><div class="meta-section"><div class="meta-field"><strong class="meta-field-title">Stability</strong><div class="meta-field-value">experimental</div></div><div class="meta-field"><strong class="meta-field-title">Licence</strong><div class="meta-field-value">MIT</div></div></div><div class="table-of-contents"><div class="meta-section-title">On This Page</div><ul class="toc-list level-1"><li class="toc-item"><a href="#signature">Signature</a></li><li class="toc-item"><span class="no-anchor">Documentation</span><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#properties">Properties</a><ul class="toc-list level-2"></ul></li><li class="toc-item"><a href="#source-code">Source Code</a></li></ul></div><div class="meta-section"><strong class="meta-section-title">Authors</strong><div class="meta-field"><strong class="meta-field-title">Copyright</strong><div class="meta-field-value">(c) 2013-2017 Quildreen Motta, and CONTRIBUTORS</div></div><div class="meta-field"><strong class="meta-field-title">Authors</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta</li></ul></div></div><div class="meta-field"><strong class="meta-field-title">Maintainers</strong><div class="meta-field-value"><ul class="meta-list"><li>Quildreen Motta &lt;[email protected]&gt; (http://robotlolita.me/)</li></ul></div></div></div></div></div>
+    <script>
+void function() {
+  var xs = document.querySelectorAll('.documentation pre code');
+  for (var i = 0; i < xs.length; ++i) {
+    xs[i].className = 'language-javascript code-block';
+  }
+}()
+    </script>
+    <script src="prism.js"></script>
+  </body>
+</html>