Feature/#25 types definitions

.eslintrc.json

@@ -1,6 +1,7 @@
 {
  "extends": ["@adobe/eslint-config-aio-lib-config"],
  "rules": {
+ "jsdoc/no-undefined-types": 0,
  "jsdoc/check-tag-names": [
  "error",
  {

README.md

@@ -105,6 +105,77 @@ aemHeadlessClient.runPersistedQuery('wknd/persist-query-name-with-variables', {
 })() 
 ```
 
+#### Pagination:
+```javascript
+(async () => {
+ const model = 'article'
+ const fields = `{
+ title
+ _path
+ authorFragment {
+ firstName
+ profilePicture {
+ ...on ImageRef {
+ _authorUrl
+ }
+ }
+ }
+ }`
+
+ // Cursor based: Loop all pages
+ try {
+ const cursorQueryAll = await aemHeadlessClient.runPaginatedQuery(model, fields, { first: 4 })
+ for await (let value of cursorQueryAll) {
+ console.log('cursorQueryAll', value)
+ }
+ } catch (e) {
+ console.warn(e)
+ }
+ // Cursor based: Manually get next page
+ try {
+ const cursorQuery = await aemHeadlessClient.runPaginatedQuery(model, fields, { first: 4 })
+ let isDone = false
+ while (!isDone) {
+ const { done, value } = await cursorQuery.next();
+ isDone = done
+ console.log('cursorQuery', value)
+ }
+ } catch (e) {
+ console.warn(e)
+ }
+ // Offset based: Loop all pages
+ try {
+ const offsetQueryAll = await aemHeadlessClient.runPaginatedQuery(model, fields, { limit: 3 })
+ for await (let value of offsetQueryAll) {
+ console.log('offsetQueryAll', value)
+ }
+ } catch (e) {
+ console.warn(e)
+ }
+ // Offset based: Manually get next page
+ try {
+ const offsetQuery = await aemHeadlessClient.runPaginatedQuery(model, fields, { limit: 3 })
+
+ let isDone = false
+ while (!isDone) {
+ const { done, value } = await offsetQuery.next();
+ isDone = done
+ console.log('offsetQuery', value)
+ }
+ } catch (e) {
+ console.warn(e)
+ }
+ // By path
+ try {
+ const pathQuery = await aemHeadlessClient.runPaginatedQuery(model, fields, { _path: '/content/dam/wknd-shared/en/magazine/alaska-adventure/alaskan-adventures' })
+ const result = pathQuery.next()
+ console.log('pathQuery', result)
+ } catch (e) {
+ console.warn(e)
+ }
+})()
+```
+
 ## Authorization
 
 If `auth` param is a string, it's treated as a Bearer token