Skip to content

Commit cbbad36

Browse files
Merge pull request #78 from QuickDevelopment/feat-(update-docs)
Update docs
2 parents 8ed80e1 + fef24eb commit cbbad36

14 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/classes/Category.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">import</span><
1515
</code><button>Copy</button></pre>
1616
</div><aside class="tsd-sources"><p>Overrides <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetch">fetch</a></p><ul><li>Defined in Api/Category.ts:26</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="fetchMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>fetch<wbr/>Many</span><a href="#fetchMany" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fetchMany.fetchMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Many</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#constructor.new_Category.T-1">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#fetchMany.fetchMany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Fetch multiple objects from the endpoint.</p>
1717
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#constructor.new_Category.T-1">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>2.0.0</p>
18-
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetchMany">fetchMany</a></p><ul><li>Defined in Base/WPJSBase.ts:85</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get data about the current class.</p>
18+
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetchMany">fetchMany</a></p><ul><li>Defined in Base/WPJSBase.ts:84</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get data about the current class.</p>
1919
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="get.get-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>1.0.0</p>
2020
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#get">get</a></p><ul><li>Defined in Base/WPJSBase.ts:62</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getSearchParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Search<wbr/>Params</span><a href="#getSearchParams" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getSearchParams.getSearchParams-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URLSearchParams</span><a href="#getSearchParams.getSearchParams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get the search parameters.</p>
2121
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">URLSearchParams</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#getSearchParams">getSearchParams</a></p><ul><li>Defined in Base/WPJSBase.ts:38</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setSearchParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>set<wbr/>Search<wbr/>Params</span><a href="#setSearchParams" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="setSearchParams.setSearchParams-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#setSearchParams.setSearchParams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set search parameters for the request.</p>

docs/classes/Comment.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-3">import</span><
1515
</code><button>Copy</button></pre>
1616
</div><aside class="tsd-sources"><p>Overrides <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetch">fetch</a></p><ul><li>Defined in Api/Comment.ts:26</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="fetchMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>fetch<wbr/>Many</span><a href="#fetchMany" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fetchMany.fetchMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch<wbr/>Many</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Comment.html#constructor.new_Comment.T-1">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#fetchMany.fetchMany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Fetch multiple objects from the endpoint.</p>
1717
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Comment.html#constructor.new_Comment.T-1">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>2.0.0</p>
18-
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetchMany">fetchMany</a></p><ul><li>Defined in Base/WPJSBase.ts:85</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Comment.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get data about the current class.</p>
18+
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#fetchMany">fetchMany</a></p><ul><li>Defined in Base/WPJSBase.ts:84</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Comment.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get data about the current class.</p>
1919
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="get.get-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Category.html#get.get-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>1.0.0</p>
2020
</div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#get">get</a></p><ul><li>Defined in Base/WPJSBase.ts:62</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getSearchParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Search<wbr/>Params</span><a href="#getSearchParams" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getSearchParams.getSearchParams-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URLSearchParams</span><a href="#getSearchParams.getSearchParams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagProtected">Protected</code> <div class="tsd-comment tsd-typography"><p>Get the search parameters.</p>
2121
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">URLSearchParams</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="WPJSBase.html">WPJSBase</a>.<a href="WPJSBase.html#getSearchParams">getSearchParams</a></p><ul><li>Defined in Base/WPJSBase.ts:38</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setSearchParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>set<wbr/>Search<wbr/>Params</span><a href="#setSearchParams" 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 tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="setSearchParams.setSearchParams-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Search<wbr/>Params</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#setSearchParams.setSearchParams-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set search parameters for the request.</p>

0 commit comments

Comments
 (0)