Skip to content

Commit

Permalink
Docs and NPM bump
Browse files Browse the repository at this point in the history
  • Loading branch information
@Pierce01
Pierce01 committed Nov 7, 2023
1 parent 2186b20 commit 04d6161
Show file tree
Hide file tree
Showing 79 changed files with 886 additions and 730 deletions.
2 changes: 1 addition & 1 deletion docs/assets/navigation.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

50 changes: 30 additions & 20 deletions docs/classes/Client.html
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/classes/_internal_.Content.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Content</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L5">lib/Content.ts:5</a></li></ul></aside>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L5">lib/Content.ts:5</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -61,14 +61,14 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">client</span>: <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="_internal_.Content.html" class="tsd-signature-type tsd-kind-class">Content</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L11">lib/Content.ts:11</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L11">lib/Content.ts:11</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L6">lib/Content.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L6">lib/Content.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="util" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>util</span><a href="#util" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">util</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getElementNames</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elements</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/Types.Elements.html" class="tsd-signature-type tsd-kind-interface">Elements</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">lazyMap</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elements</span>, <span class="tsd-kind-parameter">formattedNames</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/Types.Elements.html" class="tsd-signature-type tsd-kind-interface">Elements</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
Expand Down Expand Up @@ -104,7 +104,7 @@ <h5><span class="tsd-kind-parameter">elements</span>: <a href="../interfaces/Typ
<h5><span class="tsd-kind-parameter">formattedNames</span>: <a href="../interfaces/Types.Elements.html" class="tsd-signature-type tsd-kind-interface">Elements</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Types.Elements.html" class="tsd-signature-type tsd-kind-interface">Elements</a></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L7">lib/Content.ts:7</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L7">lib/Content.ts:7</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="create" class="tsd-anchor"></a>
Expand All @@ -123,7 +123,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Type
<h5><span class="tsd-kind-parameter">isFormatted</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.ContentDTO.html" class="tsd-signature-type tsd-kind-interface">ContentDTO</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L57">lib/Content.ts:57</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L57">lib/Content.ts:57</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="delete" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -140,7 +140,7 @@ <h5><span class="tsd-kind-parameter">sectionId</span>: <span class="tsd-signatur
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L52">lib/Content.ts:52</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L52">lib/Content.ts:52</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="get" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -157,7 +157,7 @@ <h5><span class="tsd-kind-parameter">sectionId</span>: <span class="tsd-signatur
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.ContentDTO.html" class="tsd-signature-type tsd-kind-interface">ContentDTO</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L41">lib/Content.ts:41</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L41">lib/Content.ts:41</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getVersions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Versions</span><a href="#getVersions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -172,7 +172,7 @@ <h5><span class="tsd-kind-parameter">contentId</span>: <span class="tsd-signatur
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.VersionDTO.html" class="tsd-signature-type tsd-kind-interface">VersionDTO</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L32">lib/Content.ts:32</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L32">lib/Content.ts:32</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getWithoutSection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Without<wbr/>Section</span><a href="#getWithoutSection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -189,7 +189,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.ContentDTO.html" class="tsd-signature-type tsd-kind-interface">ContentDTO</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L46">lib/Content.ts:46</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L46">lib/Content.ts:46</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="listLinkContent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>list<wbr/>Link<wbr/>Content</span><a href="#listLinkContent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -202,7 +202,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">sectionId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L85">lib/Content.ts:85</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L85">lib/Content.ts:85</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="modify" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>modify</span><a href="#modify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -221,7 +221,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Type
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.ContentDTO.html" class="tsd-signature-type tsd-kind-interface">ContentDTO</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L90">lib/Content.ts:90</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L90">lib/Content.ts:90</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="prePopulateContentInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pre<wbr/>Populate<wbr/>Content<wbr/>Info</span><a href="#prePopulateContentInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -236,7 +236,7 @@ <h5><span class="tsd-kind-parameter">contentTypeId</span>: <span class="tsd-sign
<h5><span class="tsd-kind-parameter">sectionId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.NewContentDTO.html" class="tsd-signature-type tsd-kind-interface">NewContentDTO</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/09264c2/src/lib/Content.ts#L80">lib/Content.ts:80</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/2186b20/src/lib/Content.ts#L80">lib/Content.ts:80</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 04d6161

Please sign in to comment.