Skip to content

Commit

Permalink
Rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lilyball
lilyball committed May 24, 2020
1 parent fc1fb7e commit 2fc1168
Show file tree
Hide file tree
Showing 36 changed files with 286 additions and 72 deletions.
4 changes: 2 additions & 2 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -309,7 +309,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/NoError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="NoError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseCallbackError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseCallbackError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -160,7 +160,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
50 changes: 48 additions & 2 deletions docs/Enums/PromiseContext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseContext Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -456,6 +456,52 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12Tomorrowland14PromiseContextO14isExecutingNowSbvpZ"></a>
<a name="//apple_ref/swift/Variable/isExecutingNow" class="dashAnchor"></a>
<a class="token" href="#/s:12Tomorrowland14PromiseContextO14isExecutingNowSbvpZ">isExecutingNow</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns whether a <code><a href="../Enums/PromiseContext.html#/s:12Tomorrowland14PromiseContextO5nowOryA2CcACmF">.nowOr(_:)</a></code> context is executing synchronously.</p>

<p>When accessed from within a callback registered with <code><a href="../Enums/PromiseContext.html#/s:12Tomorrowland14PromiseContextO5nowOryA2CcACmF">.nowOr(_:)</a></code> this returns <code>true</code> if the
callback is executing synchronously or <code>false</code> if it&rsquo;s executing on the wrapped context.
When accessed from within a callback (including <code><a href="../Structs/Promise.html#/s:12Tomorrowland7PromiseV2on_ACyxq_GAA0B7ContextO_yAC8ResolverVyxq__Gctcfc">Promise.init(on:_:)</a></code> registered with
<code><a href="../Enums/PromiseContext.html#/s:12Tomorrowland14PromiseContextO9immediateyA2CmF">.immediate</a></code> this returns <code>true</code> if and only if the callback is executing synchronously and
is nested within a <code><a href="../Enums/PromiseContext.html#/s:12Tomorrowland14PromiseContextO5nowOryA2CcACmF">.nowOr(_:)</a></code> context that is executing synchronously. When accessed from
any other scenario this always returns <code>false</code>.</p>
<div class="aside aside-remark">
<p class="aside-title">Remark</p>
<p>The behavior of <code><a href="../Enums/PromiseContext.html#/s:12Tomorrowland14PromiseContextO9immediateyA2CmF">.immediate</a></code> is intended to allow <code>Promise(on: .immediate, { … })</code>
to query the synchronous state of its surrounding scope.</p>

</div><div class="aside aside-note">
<p class="aside-title">Note</p>
<p>This flag will return <code>false</code> when executed from within <code>DispatchQueue.main.sync</code>
nested inside a <code>.nowOr</code> callback, or any similar construct that blocks the current thread
and runs code on another thread.</p>

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">isExecutingNow</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -551,7 +597,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseResult.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseResult Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -700,7 +700,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseTimeoutError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseTimeoutError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Functions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -927,7 +927,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -347,7 +347,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs/DelayedPromise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="DelayedPromise Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -304,7 +304,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
28 changes: 24 additions & 4 deletions docs/Structs/Promise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Promise Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.2.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -2677,6 +2677,14 @@ <h4>Return Value</h4>
this event, <code>.immediate</code> is treated the same as <code>.auto</code>. If provided as <code>.operationQueue</code>
it enqueues an operation on the operation queue immediately that becomes ready when the
promise times out.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p>If the <code>delay</code> is less than or equal to zero and the <code>context</code> is <code>.immediate</code> or
<code>.nowOr(_:)</code> then the returned promise will already be resolved; if the receiver is
already resolved the returned promise will adopt the same result, otherwise it will be
rejected with <code>.timedOut</code>.</p>

</div>

</div>
<div class="declaration">
Expand Down Expand Up @@ -3314,13 +3322,21 @@ <h3 class="section-name"><p>Available where <code>Error</code> == <code>Swift.Er
this event, <code>.immediate</code> is treated the same as <code>.auto</code>. If provided as <code>.operationQueue</code>
it enqueues an operation on the operation queue immediately that becomes ready when the
promise times out.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p>If the <code>delay</code> is less than or equal to zero and the <code>context</code> is <code>.immediate</code> or
<code>.nowOr(_:)</code> then the returned promise will already be resolved; if the receiver is
already resolved the returned promise will adopt the same result, otherwise it will be
rejected with <code>.timedOut</code>.</p>

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timeout</span><span class="p">(</span><span class="n">on</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Enums/PromiseContext.html">PromiseContext</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">auto</span><span class="p">,</span> <span class="nv">delay</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Promise</span><span class="o">&lt;</span><span class="kt">Value</span><span class="p">,</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Error</span><span class="o">&gt;</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">timeout</span><span class="p">(</span><span class="n">on</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Enums/PromiseContext.html">PromiseContext</a></span> <span class="o">=</span> <span class="o">.</span><span class="nf">nowOr</span><span class="p">(</span><span class="o">.</span><span class="n">auto</span><span class="p">),</span> <span class="nv">delay</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Promise</span><span class="o">&lt;</span><span class="kt">Value</span><span class="p">,</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Error</span><span class="o">&gt;</span></code></pre>

</div>
</div>
Expand All @@ -3337,7 +3353,11 @@ <h4>Parameters</h4>
<td>
<div>
<p>The context to invoke the callback on. If not provided, defaults to
<code>.auto</code>, which evaluates to <code>.main</code> when invoked on the main thread, otherwise <code>.default</code>.</p>
<code>.nowOr(.auto)</code>, which evaluates to <code>.nowOr(.main)</code> when invoked on the main thread,
otherwise <code>.nowOr(.default)</code>. The usage of <code>.nowOr</code> here means that if the receiver has
already been resolved when this method is called, the returned promise will likewise
already be resolved. If the receiver has not already resolved then this behaves the same
as passing <code>.auto</code>.</p>
</div>
</td>
</tr>
Expand Down Expand Up @@ -3370,7 +3390,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-21)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 2fc1168

Please sign in to comment.