Skip to content

Commit fc017f6

Browse files
d34dmand34dman
committed
deploy: f9700fb 
1 parent d1b9d15 commit fc017f6

7 files changed

Lines changed: 30 additions & 27 deletions

File tree

‎classes/DrupalJsonApiParams.html‎

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

‎index.html‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
<h1>Drupal JSON-API Params</h1>
44
</a>
55
<p><img src="https://img.shields.io/github/actions/workflow/status/d34dman/drupal-jsonapi-params/typedoc.yml?style=flat-square&label=Build" alt="GitHub pages build status">
6-
<img src="https://img.shields.io/codecov/c/github/d34dman/drupal-jsonapi-params/main?style=flat-square" alt="codecov">
6+
<img src="https://img.shields.io/codecov/c/github/d34dman/drupal-jsonapi-params?style=flat-square&logo=codecov" alt="Codecov">
77
<a href="https://www.npmjs.com/package/drupal-jsonapi-params"><img src="https://img.shields.io/npm/v/drupal-jsonapi-params?style=flat-square" alt="npm"></a>
8-
<img src="https://img.shields.io/bundlephobia/minzip/drupal-jsonapi-params?style=flat-square" alt="npm bundle size">
8+
<img src="https://img.shields.io/bundlejs/size/drupal-jsonapi-params?style=flat-square" alt="npm package minimized gzipped size">
99
<img src="https://img.shields.io/npm/types/drupal-jsonapi-params?style=flat-square" alt="npm type definitions">
10-
<a href="http://npmjs.com/package/drupal-jsonapi-params"><img src="https://img.shields.io/npm/dt/drupal-jsonapi-params.svg?maxAge=2592000&style=flat-square" alt="npm downloads"></a>
11-
<a href="https://snyk.io/test/npm/drupal-jsonapi-params"><img src="https://img.shields.io/snyk/vulnerabilities/github/d34dman/drupal-jsonapi-params?style=flat-square" alt="Known Vulnerabilities"></a></p>
10+
<a href="http://npmjs.com/package/drupal-jsonapi-params"><img src="https://img.shields.io/npm/dt/drupal-jsonapi-params.svg?maxAge=2592000&style=flat-square" alt="npm downloads"></a></p>
1211
<p>The <a href="https://jsonapi.org/">JSON:API</a> is part of <a href="https://www.drupal.org/">Drupal</a> Core.</p>
1312
<p>The JSON:API specifications defines standard query parameters to be used to do filtering, sorting, restricting fields that are returned, pagination and so on.</p>
1413
<p>This module provides a helper Class to create the required query. While doing so, it also tries to optimise the query by using the short form, whenever possible.</p>
@@ -231,6 +230,10 @@ <h3>addPageOffset</h3>
231230
</tr>
232231
</tbody></table>
233232
<p><a href="https://www.drupal.org/docs/8/core/modules/jsonapi-module/pagination">Read more about Pagination in Drupal.org Documentation</a></p>
233+
<p><strong>NOTE</strong></p>
234+
<p>JSON:API response have pagination information build into the response. Based on the results in the response, you can get &quot;previous&quot; and &quot;next&quot; links which can be used
235+
to get further items when results overflows into multiple pages.</p>
236+
<p>If you are looking for a practical guide, you can check out the example in this issue on GitHub <a href="https://github.com/d34dman/drupal-jsonapi-params/issues/40">https://github.com/d34dman/drupal-jsonapi-params/issues/40</a></p>
234237

235238
<a href="#addfields" id="addfields" style="color: inherit; text-decoration: none;">
236239
<h3>addFields</h3>

‎interfaces/DrupalJsonApiParamsInterface.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎interfaces/DrupalJsonApiParamsStore.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎interfaces/GroupItem.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GroupItem | drupal-jsonapi-params</title><meta name="description" content="Documentation for drupal-jsonapi-params"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">drupal-jsonapi-params</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">drupal-jsonapi-params</a></li><li><a href="GroupItem.html">GroupItem</a></li></ul><h1>Interface GroupItem </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GroupItem</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#conjunction" class="tsd-kind-icon">conjunction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#memberOf" class="tsd-kind-icon">member<wbr/>Of</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="conjunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">conjunction<a href="#conjunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">conjunction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d34dman/drupal-jsonapi-params/blob/09f36bd/src/index.ts#L30">index.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="memberOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> member<wbr/>Of<a href="#memberOf" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">member<wbr/>Of<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d34dman/drupal-jsonapi-params/blob/09f36bd/src/index.ts#L31">index.ts:31</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="GroupItem.html" class="tsd-kind-icon">Group<wbr/>Item</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#conjunction" class="tsd-kind-icon">conjunction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#memberOf" class="tsd-kind-icon">member<wbr/>Of</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GroupItem | drupal-jsonapi-params</title><meta name="description" content="Documentation for drupal-jsonapi-params"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">drupal-jsonapi-params</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">drupal-jsonapi-params</a></li><li><a href="GroupItem.html">GroupItem</a></li></ul><h1>Interface GroupItem </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GroupItem</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#conjunction" class="tsd-kind-icon">conjunction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#memberOf" class="tsd-kind-icon">member<wbr/>Of</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="conjunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">conjunction<a href="#conjunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">conjunction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d34dman/drupal-jsonapi-params/blob/f9700fb/src/index.ts#L30">index.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="memberOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> member<wbr/>Of<a href="#memberOf" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">member<wbr/>Of<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/d34dman/drupal-jsonapi-params/blob/f9700fb/src/index.ts#L31">index.ts:31</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="GroupItem.html" class="tsd-kind-icon">Group<wbr/>Item</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#conjunction" class="tsd-kind-icon">conjunction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GroupItem.html#memberOf" class="tsd-kind-icon">member<wbr/>Of</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)