Skip to content

Commit

Permalink
Deploying to site from @ 3ff8ca5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@squarejesse
squarejesse committed Jan 12, 2024
1 parent 69bc978 commit ea1f0c8
Show file tree
Hide file tree
Showing 24 changed files with 120 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/latest/scripts/pages.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions ...st/zipline-loader/app.cash.zipline.loader/-default-freshness-checker-not-fresh/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<div class="breadcrumbs"><a href="../../index.html">zipline-loader</a><span class="delimiter">/</span><a href="../index.html">app.cash.zipline.loader</a><span class="delimiter">/</span><span class="current">DefaultFreshnessCheckerNotFresh</span></div>
<div class="cover ">
<h1 class="cover"><span>Default</span><wbr><span>Freshness</span><wbr><span>Checker</span><wbr><span>Not</span><wbr><span><span>Fresh</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">DefaultFreshnessCheckerNotFresh</a> : <a href="../-freshness-checker/index.html">FreshnessChecker</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L41">source</a>)</span></span></div><p class="paragraph">A FreshnessChecker that always returns true.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">DefaultFreshnessCheckerNotFresh</a> : <a href="../-freshness-checker/index.html">FreshnessChecker</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L40">source</a>)</span></span></div><p class="paragraph">A FreshnessChecker that never loads locally-cached applications.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand All @@ -79,7 +79,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Decides whether the <a href="is-fresh.html">manifest</a> is eligible to be used.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Returns true if <a href="is-fresh.html">manifest</a> is eligible to be used.</p></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion ...zipline-loader/app.cash.zipline.loader/-default-freshness-checker-not-fresh/is-fresh.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>is</span><wbr><span><span>Fresh</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L42">source</a>)</span></span></div><p class="paragraph">Decides whether the <a href="is-fresh.html">manifest</a> is eligible to be used.</p><p class="paragraph">Returns true to launch the <a href="is-fresh.html">manifest</a> immediately; false to download a fresh ZiplineManifest and launch that.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L41">source</a>)</span></span></div><p class="paragraph">Returns true if <a href="is-fresh.html">manifest</a> is eligible to be used.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":zipline-loader:dokkaHtmlPartial/commonMain" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>fresh</span><wbr><span>At</span><wbr><span>Epoch</span><wbr><span><span>Ms</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the time that <a href="is-fresh.html">manifest</a> was fetched from the server by this client. This could be significantly newer than the time the application was built.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
4 changes: 2 additions & 2 deletions docs/latest/zipline-loader/app.cash.zipline.loader/-freshness-checker/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<div class="breadcrumbs"><a href="../../index.html">zipline-loader</a><span class="delimiter">/</span><a href="../index.html">app.cash.zipline.loader</a><span class="delimiter">/</span><span class="current">FreshnessChecker</span></div>
<div class="cover ">
<h1 class="cover"><span>Freshness</span><wbr><span><span>Checker</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">FreshnessChecker</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L26">source</a>)</span></span></div><p class="paragraph">Checks if a given ZiplineManifest is considered fresh.</p><p class="paragraph">For local development that requires continuous loading (or hot loading), supply a FreshnessChecker that always returns false.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":zipline-loader:dokkaHtmlPartial/commonMain" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-freshness-checker-not-fresh/index.html">DefaultFreshnessCheckerNotFresh</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">FreshnessChecker</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L25">source</a>)</span></span></div><p class="paragraph">Decides whether a locally-cached application is fresh enough to use at the current time.</p><p class="paragraph">This is unused for downloaded applications, which are considered to be fresh by definition.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":zipline-loader:dokkaHtmlPartial/commonMain" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-freshness-checker-not-fresh/index.html">DefaultFreshnessCheckerNotFresh</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand All @@ -79,7 +79,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Decides whether the <a href="is-fresh.html">manifest</a> is eligible to be used.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Returns true if <a href="is-fresh.html">manifest</a> is eligible to be used.</p></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/zipline-loader/app.cash.zipline.loader/-freshness-checker/is-fresh.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>is</span><wbr><span><span>Fresh</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L34">source</a>)</span></span></div><p class="paragraph">Decides whether the <a href="is-fresh.html">manifest</a> is eligible to be used.</p><p class="paragraph">Returns true to launch the <a href="is-fresh.html">manifest</a> immediately; false to download a fresh ZiplineManifest and launch that.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="is-fresh.html"><span class="token function">isFresh</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">manifest<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-zipline-manifest/index.html">ZiplineManifest</a><span class="token punctuation">, </span></span><span class="parameter ">freshAtEpochMs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/FreshnessChecker.kt#L33">source</a>)</span></span></div><p class="paragraph">Returns true if <a href="is-fresh.html">manifest</a> is eligible to be used.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":zipline-loader:dokkaHtmlPartial/commonMain" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>fresh</span><wbr><span>At</span><wbr><span>Epoch</span><wbr><span><span>Ms</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the time that <a href="is-fresh.html">manifest</a> was fetched from the server by this client. This could be significantly newer than the time the application was built.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Loading

0 comments on commit ea1f0c8

Please sign in to comment.