Skip to content

Commit a62d470

Browse files
committed
[3.0.0] re-gen docs
1 parent f157dc9 commit a62d470

7 files changed

+89
-21
lines changed

docs/Protocols.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Protocols Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
20+
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2121
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="search.json">
@@ -118,7 +118,7 @@ <h4>Declaration</h4>
118118
</section>
119119
</section>
120120
<section id="footer">
121-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
121+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
122122
<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>
123123
</section>
124124
</article>

docs/Protocols/UserDefaultsSerializable.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="UserDefaultsSerializable Protocol Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
20+
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2121
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="../search.json">
@@ -197,7 +197,7 @@ <h4>Parameters</h4>
197197
</section>
198198
</section>
199199
<section id="footer">
200-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
200+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
201201
<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>
202202
</section>
203203
</article>

docs/Structs.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Structures Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
20+
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2121
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="search.json">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
132132
</section>
133133
</section>
134134
<section id="footer">
135-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
135+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
136136
<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>
137137
</section>
138138
</article>

docs/Structs/WrappedDefault.html

+29-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="WrappedDefault Structure Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
20+
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2121
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="../search.json">
@@ -130,6 +130,33 @@ <h4>Declaration</h4>
130130
</section>
131131
</div>
132132
</li>
133+
<li class="item">
134+
<div>
135+
<code>
136+
<a name="/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp"></a>
137+
<a name="//apple_ref/swift/Property/projectedValue" class="dashAnchor"></a>
138+
<a class="token" href="#/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp">projectedValue</a>
139+
</code>
140+
</div>
141+
<div class="height-container">
142+
<div class="pointer-container"></div>
143+
<section class="section">
144+
<div class="pointer"></div>
145+
<div class="abstract">
146+
<p>A publisher that delivers updates to subscribers.</p>
147+
148+
</div>
149+
<div class="declaration">
150+
<h4>Declaration</h4>
151+
<div class="language">
152+
<p class="aside-title">Swift</p>
153+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">projectedValue</span><span class="p">:</span> <span class="kt">AnyPublisher</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">,</span> <span class="kt">Never</span><span class="o">&gt;</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
154+
155+
</div>
156+
</div>
157+
</section>
158+
</div>
159+
</li>
133160
<li class="item">
134161
<div>
135162
<code>
@@ -205,7 +232,7 @@ <h4>Parameters</h4>
205232
</section>
206233
</section>
207234
<section id="footer">
208-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
235+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
209236
<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>
210237
</section>
211238
</article>

docs/Structs/WrappedDefaultOptional.html

+29-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="WrappedDefaultOptional Structure Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
20+
<p><a href="../index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2121
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2222
<div class="header-right">
2323
<form role="search" action="../search.json">
@@ -130,6 +130,33 @@ <h4>Declaration</h4>
130130
</section>
131131
</div>
132132
</li>
133+
<li class="item">
134+
<div>
135+
<code>
136+
<a name="/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp"></a>
137+
<a name="//apple_ref/swift/Property/projectedValue" class="dashAnchor"></a>
138+
<a class="token" href="#/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp">projectedValue</a>
139+
</code>
140+
</div>
141+
<div class="height-container">
142+
<div class="pointer-container"></div>
143+
<section class="section">
144+
<div class="pointer"></div>
145+
<div class="abstract">
146+
<p>A publisher that delivers updates to subscribers.</p>
147+
148+
</div>
149+
<div class="declaration">
150+
<h4>Declaration</h4>
151+
<div class="language">
152+
<p class="aside-title">Swift</p>
153+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">projectedValue</span><span class="p">:</span> <span class="kt">AnyPublisher</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">?,</span> <span class="kt">Never</span><span class="o">&gt;</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
154+
155+
</div>
156+
</div>
157+
</section>
158+
</div>
159+
</li>
133160
<li class="item">
134161
<div>
135162
<code>
@@ -193,7 +220,7 @@ <h4>Parameters</h4>
193220
</section>
194221
</section>
195222
<section id="footer">
196-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
223+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
197224
<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>
198225
</section>
199226
</article>

docs/index.html

+24-10
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<a title="Foil Reference"></a>
1717
<header>
1818
<div class="content-wrapper">
19-
<p><a href="index.html">Foil 2.0.0 Docs</a> (100% documented)</p>
19+
<p><a href="index.html">Foil 3.0.0 Docs</a> (100% documented)</p>
2020
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
2121
<div class="header-right">
2222
<form role="search" action="search.json">
@@ -70,7 +70,7 @@ <h2 id='about' class='heading'>About</h2>
7070
<p>Read the post: <a href="https://www.jessesquires.com/blog/2021/03/26/a-better-approach-to-writing-a-userdefaults-property-wrapper/">A better approach to writing a UserDefaults Property Wrapper</a></p>
7171
<h4 id='why-the-name' class='heading'>Why the name?</h4>
7272

73-
<p>Foil, as in let me quickly and easily <strong>wrap</strong> and <strong>store</strong> this leftover food in some <strong>foil</strong> so I can eat it later. 🌯 😉</p>
73+
<p>Foil, as in &ldquo;let me quickly and easily <strong>wrap</strong> and <strong>store</strong> this leftover food in some <strong>foil</strong> so I can eat it later.&rdquo; 🌯 😉</p>
7474

7575
<blockquote>
7676
<p><a href="https://www.wordnik.com/words/aluminum%20foil">Foil</a>:<br>
@@ -126,12 +126,15 @@ <h3 id='using-code-enum-code-keys' class='heading'>Using <code>enum</code> keys<
126126
</code></pre>
127127
<h3 id='observing-changes' class='heading'>Observing changes</h3>
128128

129-
<p>There are <a href="https://www.jessesquires.com/blog/2021/08/08/different-ways-to-observe-properties-in-swift/">many ways to observe property changes</a>. The most common are by using Key-Value Observing or a Combine Publisher. Both require the object with the property to inherit from <code>NSObject</code> and the property must be declared as <code>@objc dynamic</code>.</p>
129+
<p>There are <a href="https://www.jessesquires.com/blog/2021/08/08/different-ways-to-observe-properties-in-swift/">many ways to observe property changes</a>. The most common are by using Key-Value Observing or a Combine Publisher. KVO observing requires the object with the property to inherit from <code>NSObject</code> and the property must be declared as <code>@objc dynamic</code>.</p>
130130
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">class</span> <span class="kt">AppSettings</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
131131
<span class="kd">static</span> <span class="k">let</span> <span class="nv">shared</span> <span class="o">=</span> <span class="kt">AppSettings</span><span class="p">()</span>
132132

133133
<span class="kd">@WrappedDefaultOptional</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="s">"userId"</span><span class="p">)</span>
134134
<span class="kd">@objc</span> <span class="kd">dynamic</span> <span class="k">var</span> <span class="nv">userId</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span>
135+
136+
<span class="kd">@WrappedDefaultOptional</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="s">"average"</span><span class="p">)</span>
137+
<span class="k">var</span> <span class="nv">average</span><span class="p">:</span> <span class="kt">Double</span><span class="p">?</span>
135138
<span class="p">}</span>
136139
</code></pre>
137140
<h4 id='using-kvo' class='heading'>Using KVO</h4>
@@ -140,6 +143,17 @@ <h4 id='using-kvo' class='heading'>Using KVO</h4>
140143
<span class="p">}</span>
141144
</code></pre>
142145
<h4 id='using-combine' class='heading'>Using Combine</h4>
146+
147+
<p><strong>Note:</strong> that <code>average</code> does not need the <code>@objc dynamic</code> annotation, <code>.receiveValue</code> will fire immediately with the current value of <code>average</code> and on every change after.</p>
148+
<pre class="highlight swift"><code><span class="kt">AppSettings</span><span class="o">.</span><span class="n">shared</span><span class="o">.</span><span class="err">$</span><span class="n">average</span>
149+
<span class="o">.</span><span class="n">sink</span> <span class="p">{</span>
150+
<span class="nf">print</span><span class="p">(</span><span class="nv">$0</span><span class="p">)</span>
151+
<span class="p">}</span>
152+
<span class="o">.</span><span class="nf">store</span><span class="p">(</span><span class="nv">in</span><span class="p">:</span> <span class="o">&amp;</span><span class="n">cancellable</span><span class="p">)</span>
153+
</code></pre>
154+
<h4 id='combine-alternative-with-kvo' class='heading'>Combine Alternative with KVO</h4>
155+
156+
<p><strong>Note:</strong> in this case, <code>userId</code> needs the <code>@objc dynamic</code> annotation and <code>AppSettings</code> needs to inherit from <code>NSObject</code>. Then <code>receiveValue</code> will fire only on changes to wrapped object&rsquo;s value. It will not publish the initial value as in the example above.</p>
143157
<pre class="highlight swift"><code><span class="kt">AppSettings</span><span class="o">.</span><span class="n">shared</span>
144158
<span class="o">.</span><span class="nf">publisher</span><span class="p">(</span><span class="nv">for</span><span class="p">:</span> <span class="p">\</span><span class="o">.</span><span class="n">userId</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="k">new</span><span class="p">])</span>
145159
<span class="o">.</span><span class="n">sink</span> <span class="p">{</span>
@@ -179,10 +193,10 @@ <h2 id='additional-resources' class='heading'>Additional Resources</h2>
179193
<h2 id='supported-platforms' class='heading'>Supported Platforms</h2>
180194

181195
<ul>
182-
<li>iOS 9.0+</li>
183-
<li>tvOS 9.0+</li>
184-
<li>watchOS 5.0+</li>
185-
<li>macOS 10.13+</li>
196+
<li>iOS 13.0+</li>
197+
<li>tvOS 13.0+</li>
198+
<li>watchOS 6.0+</li>
199+
<li>macOS 11+</li>
186200
</ul>
187201
<h2 id='requirements' class='heading'>Requirements</h2>
188202

@@ -193,11 +207,11 @@ <h2 id='requirements' class='heading'>Requirements</h2>
193207
</ul>
194208
<h2 id='installation' class='heading'>Installation</h2>
195209
<h3 id='a-href-http-cocoapods-org-cocoapods-a' class='heading'><a href="http://cocoapods.org">CocoaPods</a></h3>
196-
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'Foil'</span><span class="p">,</span> <span class="s1">'~&gt; 2.0.0'</span>
210+
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'Foil'</span><span class="p">,</span> <span class="s1">'~&gt; 3.0.0'</span>
197211
</code></pre>
198212
<h3 id='a-href-https-swift-org-package-manager-swift-package-manager-a' class='heading'><a href="https://swift.org/package-manager/">Swift Package Manager</a></h3>
199213
<pre class="highlight swift"><code><span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span>
200-
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"2.0.0"</span><span class="p">)</span>
214+
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"3.0.0"</span><span class="p">)</span>
201215
<span class="p">]</span>
202216
</code></pre>
203217

@@ -231,7 +245,7 @@ <h2 id='license' class='heading'>License</h2>
231245
</section>
232246
</section>
233247
<section id="footer">
234-
<p>&copy; 2021 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2021-11-19)</p>
248+
<p>&copy; 2022 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2022-01-24)</p>
235249
<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>
236250
</section>
237251
</article>

0 commit comments

Comments
 (0)