Skip to content

Commit 05da8bc

Browse files
committed
docs: update docs
1 parent 1cdc64e commit 05da8bc

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/v1.2.1/functions/index.entries.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</div><div class="tsd-comment tsd-typography"></div></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_feeds_posts.PostsEntryBlogSummary.html" class="tsd-signature-type tsd-kind-interface">PostsEntryBlogSummary</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Since"><h4 class="tsd-anchor-link"><a id="Since-4" class="tsd-anchor"></a>Since<a href="#Since-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.2.1 The default type is <code>posts</code></p>
3838
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/yoimerdr/feeddy/blob/b886a566f2b7bdd00e2ec73a5f88cb41356873a7/src/types/entries.ts#L184">src/types/entries.ts:184</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createsPathname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>creates<wbr/>Pathname</span><a href="#createsPathname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createsPathname.createsPathname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">creates<wbr/>Pathname</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">length</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#createsPathname.createsPathname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extracts or generates a URL-friendly pathname string from a blog entry.</p>
3939
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types_feeds_entry.BaseEntry.html" class="tsd-signature-type tsd-kind-interface">BaseEntry</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The blog entry object or string to generate URL from.</p>
40-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">length</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum length for the generated URL. Defaults to <code>40</code>.</p>
40+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">length</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum length for the generated URL.</p>
4141
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A URL-friendly pathname string derived from either the entry's alternate link or title</p>
4242
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-8">createsPathname</span><span class="hl-7">(</span><span class="hl-9">&quot;Entry&#39;s Title&quot;</span><span class="hl-7">) </span><span class="hl-5">// &quot;entry-s-title&quot;</span>
4343
</code><button type="button">Copy</button></pre>

docs/v1.2.1/interfaces/types_entries.Entries.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</div><div class="tsd-comment tsd-typography"></div></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="types_feeds_posts.PostsEntryBlogSummary.html" class="tsd-signature-type tsd-kind-interface">PostsEntryBlogSummary</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Since"><h4 class="tsd-anchor-link"><a id="Since-3" class="tsd-anchor"></a>Since<a href="#Since-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.2.1 The default type is <code>posts</code></p>
3737
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/yoimerdr/feeddy/blob/b886a566f2b7bdd00e2ec73a5f88cb41356873a7/src/types/entries.ts#L184">src/types/entries.ts:184</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createsPathname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>creates<wbr/>Pathname</span><a href="#createsPathname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createsPathname.createsPathname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">creates<wbr/>Pathname</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">length</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#createsPathname.createsPathname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extracts or generates a URL-friendly pathname string from a blog entry.</p>
3838
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="types_feeds_entry.BaseEntry.html" class="tsd-signature-type tsd-kind-interface">BaseEntry</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The blog entry object or string to generate URL from.</p>
39-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">length</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum length for the generated URL. Defaults to <code>40</code>.</p>
39+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">length</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum length for the generated URL. </p>
4040
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A URL-friendly pathname string derived from either the entry's alternate link or title</p>
4141
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-8">createsPathname</span><span class="hl-7">(</span><span class="hl-9">&quot;Entry&#39;s Title&quot;</span><span class="hl-7">) </span><span class="hl-5">// &quot;entry-s-title&quot;</span>
4242
</code><button type="button">Copy</button></pre>

0 commit comments

Comments
 (0)