This repository has been archived by the owner on Oct 23, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Helpers to build common effects * Update documentation
- Loading branch information
Showing
35 changed files
with
889 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>AnyAsyncSequenceable Extension Reference</title> | ||
| <link rel="stylesheet" type="text/css" href="../css/jazzy.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../css/highlight.css" /> | ||
| <meta charset='utf-8'> | ||
| <script src="../js/jquery.min.js" defer></script> | ||
| <script src="../js/jazzy.js" defer></script> | ||
|
|
||
| <script src="../js/lunr.min.js" defer></script> | ||
| <script src="../js/typeahead.jquery.js" defer></script> | ||
| <script src="../js/jazzy.search.js" defer></script> | ||
| </head> | ||
| <body> | ||
| <a name="//apple_ref/swift/Extension/AnyAsyncSequenceable" class="dashAnchor"></a> | ||
| <a title="AnyAsyncSequenceable Extension Reference"></a> | ||
| <header> | ||
| <div class="content-wrapper"> | ||
| <p><a href="../index.html"> Docs</a> (95% documented)</p> | ||
| <div class="header-right"> | ||
| <form role="search" action="../search.json"> | ||
| <input type="text" placeholder="Search documentation" data-typeahead> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="content-wrapper"> | ||
| <p id="breadcrumbs"> | ||
| <a href="../index.html"> Reference</a> | ||
| <img id="carat" src="../img/carat.png" alt=""/> | ||
| AnyAsyncSequenceable Extension Reference | ||
| </p> | ||
| </div> | ||
| <div class="content-wrapper"> | ||
| <nav class="sidebar"> | ||
| <ul class="nav-groups"> | ||
| <li class="nav-group-name"> | ||
| <a href="../Classes.html">Classes</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="../Classes/Store.html">Store</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="../Classes/ViewModel.html">ViewModel</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="../Extensions.html">Extensions</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="../Extensions/AnyAsyncSequenceable.html">AnyAsyncSequenceable</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="../Extensions/View.html">View</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="../Protocols.html">Protocols</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="../Protocols/Middlewareable.html">Middlewareable</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="../Protocols/RedUxable.html">RedUxable</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="../Structs.html">Structures</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="../Structs/AnyMiddleware.html">AnyMiddleware</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="../Structs/Reducer.html">Reducer</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="../Structs/UnwrapStore.html">UnwrapStore</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <article class="main-content"> | ||
| <section> | ||
| <section class="section"> | ||
| <h1>AnyAsyncSequenceable</h1> | ||
| <div class="declaration"> | ||
| <div class="language"> | ||
|
|
||
| <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">AnyAsyncSequenceable</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </section> | ||
| <section class="section task-group-section"> | ||
| <div class="task-group"> | ||
| <div class="task-name-container"> | ||
| <a name="/Builders"></a> | ||
| <a name="//apple_ref/swift/Section/Builders" class="dashAnchor"></a> | ||
| <div class="section-name-container"> | ||
| <a class="section-name-link" href="#/Builders"></a> | ||
| <h3 class="section-name"><span>Builders</span> | ||
| </h3> | ||
| </div> | ||
| </div> | ||
| <ul> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:10Asynchrone20AnyAsyncSequenceableV5RedUxE6effectyACyxGxyYacFZ"></a> | ||
| <a name="//apple_ref/swift/Method/effect(_:)" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:10Asynchrone20AnyAsyncSequenceableV5RedUxE6effectyACyxGxyYacFZ">effect(_:<wbr>)</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>Create a simple effect that emits a single event.</p> | ||
|
|
||
| </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="kd">func</span> <span class="nf">effect</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="k">async</span> <span class="o">-></span> <span class="kt">Element</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyAsyncSequenceable</span><span class="o"><</span><span class="kt">Element</span><span class="o">></span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div> | ||
| <h4>Parameters</h4> | ||
| <table class="graybox"> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <code> | ||
| <em>closure</em> | ||
| </code> | ||
| </td> | ||
| <td> | ||
| <div> | ||
| <p>An async closure that returns an event.</p> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <div> | ||
| <h4>Return Value</h4> | ||
| <p>A type erased async sequence.</p> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:10Asynchrone20AnyAsyncSequenceableV5RedUxE13fireAndForgetyACyxGyyYacFZ"></a> | ||
| <a name="//apple_ref/swift/Method/fireAndForget(_:)" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:10Asynchrone20AnyAsyncSequenceableV5RedUxE13fireAndForgetyACyxGyyYacFZ">fireAndForget(_:<wbr>)</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>Creates a fire and forget async sequence. This sequence will not emit any events | ||
| and will finish as soon as the provided closure has been executed.</p> | ||
|
|
||
| </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="kd">func</span> <span class="nf">fireAndForget</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="k">async</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AnyAsyncSequenceable</span><span class="o"><</span><span class="kt">Element</span><span class="o">></span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div> | ||
| <h4>Parameters</h4> | ||
| <table class="graybox"> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <code> | ||
| <em>closure</em> | ||
| </code> | ||
| </td> | ||
| <td> | ||
| <div> | ||
| <p>An async closure.</p> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <div> | ||
| <h4>Return Value</h4> | ||
| <p>A type erased async sequence.</p> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section id="footer"> | ||
| <p>© 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-02-28)</p> | ||
| <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p> | ||
| </section> | ||
| </article> | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.