Skip to content

Commit 065ca6e

Browse files
joanllenasjoanllenas
committed
Bump docs version
1 parent 9bd0437 commit 065ca6e

43 files changed

Lines changed: 85 additions & 85 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/latest/classes/core.Decoder.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/latest/classes/result.Err-1.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/latest/classes/result.Ok-1.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/latest/documents/Advanced_Usage.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/latest/documents/Basic_Usage.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Basic Usage | ts.data.json - v3.1.0-beta.0</title><meta name="description" content="Documentation for ts.data.json"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ts.data.json - v3.1.0-beta.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ts.data.json</a></li><li><a href="Basic_Usage.html">Basic Usage</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="basic-usage" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Basic Usage<a href="#basic-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>ts.data.json</code> helps you validate JSON data at runtime with compile-time type safety. This guide will show you how to use the library effectively.</p>
1+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Basic Usage | ts.data.json - v3.1.0</title><meta name="description" content="Documentation for ts.data.json"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ts.data.json - v3.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ts.data.json</a></li><li><a href="Basic_Usage.html">Basic Usage</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="basic-usage" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Basic Usage<a href="#basic-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p><code>ts.data.json</code> helps you validate JSON data at runtime with compile-time type safety. This guide will show you how to use the library effectively.</p>
22
<p>You can play with this examples in <a href="https://stackblitz.com/edit/ts-data-json-decoder-playground-phjiwonj?file=src%2Fmain.ts">this stackblitz playground</a>.</p>
33
<a id="simple-types" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Simple Types<a href="#simple-types" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Let's start with the basics. Here's how to decode simple JSON values:</p>
44
<pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">*</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-3">JsonDecoder</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-4">&#39;ts.data.json&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// String decoder</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-6">nameDecoder</span><span class="hl-1"> = </span><span class="hl-3">JsonDecoder</span><span class="hl-1">.</span><span class="hl-7">string</span><span class="hl-1">();</span><br/><span class="hl-3">nameDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-4">&#39;John&#39;</span><span class="hl-1">); </span><span class="hl-5">// Ok(&quot;John&quot;)</span><br/><span class="hl-3">nameDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-8">123</span><span class="hl-1">); </span><span class="hl-5">// Err(&quot;123 is not a valid string&quot;)</span><br/><br/><span class="hl-5">// Number decoder</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-6">ageDecoder</span><span class="hl-1"> = </span><span class="hl-3">JsonDecoder</span><span class="hl-1">.</span><span class="hl-7">number</span><span class="hl-1">();</span><br/><span class="hl-3">ageDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-8">25</span><span class="hl-1">); </span><span class="hl-5">// Ok(25)</span><br/><span class="hl-3">ageDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-4">&#39;25&#39;</span><span class="hl-1">); </span><span class="hl-5">// Err(&quot;\&quot;25\&quot; is not a valid number&quot;)</span><br/><br/><span class="hl-5">// Boolean decoder</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-6">isActiveDecoder</span><span class="hl-1"> = </span><span class="hl-3">JsonDecoder</span><span class="hl-1">.</span><span class="hl-7">boolean</span><span class="hl-1">();</span><br/><span class="hl-3">isActiveDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-2">true</span><span class="hl-1">); </span><span class="hl-5">// Ok(true)</span><br/><span class="hl-3">isActiveDecoder</span><span class="hl-1">.</span><span class="hl-7">decode</span><span class="hl-1">(</span><span class="hl-4">&#39;true&#39;</span><span class="hl-1">); </span><span class="hl-5">// Err(&quot;\&quot;true\&quot; is not a valid boolean&quot;)</span>
@@ -52,4 +52,4 @@
5252

5353
</li>
5454
</ol>
55-
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#basic-usage"><span>Basic <wbr/>Usage</span></a><ul><li><a href="#simple-types"><span>Simple <wbr/>Types</span></a></li><li><a href="#object-decoding"><span>Object <wbr/>Decoding</span></a></li><li><a href="#nested-objects"><span>Nested <wbr/>Objects</span></a></li><li><a href="#arrays"><span>Arrays</span></a></li><li><a href="#error-recovery"><span>Error <wbr/>Recovery</span></a></li><li><a href="#handling-results"><span>Handling <wbr/>Results</span></a></li><li><a href="#type-inference"><span>Type <wbr/>Inference</span></a></li><li><a href="#best-practices"><span>Best <wbr/>Practices</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ts.data.json - v3.1.0-beta.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p><p><a href='https://github.com/joanllenas/ts.data.json' title='ts.data.json on GitHub'><img class='github-img' width='24' height='24' /></a></p></footer><div class="overlay"></div></body></html>
55+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#basic-usage"><span>Basic <wbr/>Usage</span></a><ul><li><a href="#simple-types"><span>Simple <wbr/>Types</span></a></li><li><a href="#object-decoding"><span>Object <wbr/>Decoding</span></a></li><li><a href="#nested-objects"><span>Nested <wbr/>Objects</span></a></li><li><a href="#arrays"><span>Arrays</span></a></li><li><a href="#error-recovery"><span>Error <wbr/>Recovery</span></a></li><li><a href="#handling-results"><span>Handling <wbr/>Results</span></a></li><li><a href="#type-inference"><span>Type <wbr/>Inference</span></a></li><li><a href="#best-practices"><span>Best <wbr/>Practices</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ts.data.json - v3.1.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p><p><a href='https://github.com/joanllenas/ts.data.json' title='ts.data.json on GitHub'><img class='github-img' width='24' height='24' /></a></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)