From fbb6d698cbf15bbadcc5d634cfd01b6b816fe149 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9as=20HANSS?= Date: Fri, 19 Jan 2024 16:42:07 +0100 Subject: [PATCH 01/29] Update Notification interface to match correct API https://docs.kuzzle.io/core/2/api/payloads/notifications/#document-notification --- src/types/Notification.ts | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/src/types/Notification.ts b/src/types/Notification.ts index 7b942f9aa..e926a926d 100644 --- a/src/types/Notification.ts +++ b/src/types/Notification.ts @@ -1,5 +1,5 @@ import { JSONObject } from "./JSONObject"; -import { KDocument, KDocumentContentGeneric } from "."; +import { KDocumentContentGeneric } from "."; /** * Enum for notification types @@ -62,7 +62,21 @@ export interface DocumentNotification< /** * Updated document that triggered the notification */ - result: KDocument; + result: { + /** + * The message or full document content. + */ + _source: TDocContent; + /** + * Document unique ID. + * `null` if the notification is from a real-time message. + */ + _id: string | null; + /** + * List of fields that have been updated (only available on document partial updates). + */ + _updatedFields?: string[]; + }; /** * State of the document regarding the scope (`in` or `out`) */ @@ -95,7 +109,7 @@ export interface UserNotification extends BaseNotification { export interface ServerNotification extends BaseNotification { /** - * Server message explaining why this notifications has been triggered + * Server message explaining why this notifications has been triggered. */ message: string; From b845ef46d5b43a4fd4a10c9684069ac8ce373082 Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:21:32 +0200 Subject: [PATCH 02/29] chore: use an other Docker image to run web and webpack snippets --- .ci/doc/docker-compose.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index ad5801721..dfdda6d29 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -69,14 +69,14 @@ services: - snippets:/var/snippets doc-runner-web: - image: buildkite/puppeteer:latest + image: ghcr.io/puppeteer/puppeteer:23.5.1 command: > bash -c ' mkdir -p /var/snippets/web; apt-get update; apt-get install -y curl; npm install -g \ - eslint@6.8.0; + eslint; cd /mnt; npm install; cd /var/snippets/web; @@ -98,14 +98,14 @@ services: - snippets:/var/snippets doc-runner-webpack: - image: buildkite/puppeteer:latest + image: ghcr.io/puppeteer/puppeteer:23.5.1 command: > bash -c ' mkdir -p /var/snippets/webpack; apt-get update; apt-get install -y curl; npm install -g \ - eslint@6.8.0; + eslint; cd /var/snippets/webpack; cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/; cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/; From ad000ba4f86a0c0f61e3e213173cbcc8cc06c6ba Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:22:20 +0200 Subject: [PATCH 03/29] chore: upgrade the doc snippet node.js runner Docker image --- .ci/doc/docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index dfdda6d29..48e94fb38 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -44,7 +44,7 @@ services: - CONFIG_FILE=/mnt/.ci/doc/config.yml doc-runner-node: - image: node:18-alpine + image: node:20-alpine command: > ash -c ' mkdir -p /var/snippets/node; From 088bee6b734cd4323ba5d20ab489caca768d856e Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:24:21 +0200 Subject: [PATCH 04/29] ci: add Node.js 20 job in testing matrix --- .github/workflows/pull_request.workflow.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index 0c1fce7eb..b5190436a 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - node-version: ["16", "18"] + node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 - name: Cache node modules @@ -33,7 +33,7 @@ jobs: needs: [lint] strategy: matrix: - node-version: ["16", "18"] + node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 - name: Cache node modules @@ -58,7 +58,7 @@ jobs: needs: [unit-tests] strategy: matrix: - node-version: ["16", "18"] + node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 with: @@ -100,7 +100,7 @@ jobs: ${{ runner.os }}- - uses: actions/setup-node@v3 with: - node-version: '18' + node-version: '20' - uses: ./.github/actions/snippet-tests with: CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }} From 96306fa77bcc80c6fc2e364501c63a5b55720e06 Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:29:26 +0200 Subject: [PATCH 05/29] fix: use root user in the new puppeteer images --- .ci/doc/docker-compose.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index 48e94fb38..696de3c2a 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -70,6 +70,7 @@ services: doc-runner-web: image: ghcr.io/puppeteer/puppeteer:23.5.1 + user: root command: > bash -c ' mkdir -p /var/snippets/web; @@ -99,6 +100,7 @@ services: doc-runner-webpack: image: ghcr.io/puppeteer/puppeteer:23.5.1 + user: root command: > bash -c ' mkdir -p /var/snippets/webpack; From f1e27d29488aa9b704935eb1fec045f5832d4851 Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:51:40 +0200 Subject: [PATCH 06/29] fix: ignore external library linting --- .ci/doc/config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml index 59d9f91d1..2386c0109 100644 --- a/.ci/doc/config.yml +++ b/.ci/doc/config.yml @@ -12,7 +12,7 @@ runners: path: /var/snippets/node lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} + cmd: eslint -c /mnt/.ci/doc/eslint.json --skipLibCheck {{ snippet.dir }} before: timeout 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' run: cmd: node {{ snippet.source }} @@ -23,7 +23,7 @@ runners: path: /var/snippets/web lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 {{ snippet.dir }}/*.html + cmd: eslint -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 --skipLibCheck {{ snippet.dir }}/*.html before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' run: cmd: node puppeteer.js {{ snippet.dir }}/{{ snippet.source }} @@ -34,7 +34,7 @@ runners: path: /var/snippets/webpack lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} + cmd: eslint -c /mnt/.ci/doc/eslint.json --skipLibCheck {{ snippet.dir }} before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' build: cmd: node webpackBuild.js {{ snippet.dir }}/{{ snippet.source }} From fb9f59959d1304ce18af5a9c177f8cd3bd4d7084 Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 16:57:27 +0200 Subject: [PATCH 07/29] revert: revert skipLibCheck and use a fixed eslint version instead --- .ci/doc/config.yml | 6 +++--- .ci/doc/docker-compose.yml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml index 2386c0109..59d9f91d1 100644 --- a/.ci/doc/config.yml +++ b/.ci/doc/config.yml @@ -12,7 +12,7 @@ runners: path: /var/snippets/node lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json --skipLibCheck {{ snippet.dir }} + cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} before: timeout 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' run: cmd: node {{ snippet.source }} @@ -23,7 +23,7 @@ runners: path: /var/snippets/web lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 --skipLibCheck {{ snippet.dir }}/*.html + cmd: eslint -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 {{ snippet.dir }}/*.html before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' run: cmd: node puppeteer.js {{ snippet.dir }}/{{ snippet.source }} @@ -34,7 +34,7 @@ runners: path: /var/snippets/webpack lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json --skipLibCheck {{ snippet.dir }} + cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' build: cmd: node webpackBuild.js {{ snippet.dir }}/{{ snippet.source }} diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index 696de3c2a..db3ca83be 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -49,7 +49,7 @@ services: ash -c ' mkdir -p /var/snippets/node; apk add --no-cache curl; - npm install -g eslint@6.8.0; + npm install -g eslint@8.38.0; cd /var/snippets/node; npm install \ bluebird \ @@ -77,7 +77,7 @@ services: apt-get update; apt-get install -y curl; npm install -g \ - eslint; + eslint@8.38.0; cd /mnt; npm install; cd /var/snippets/web; @@ -107,7 +107,7 @@ services: apt-get update; apt-get install -y curl; npm install -g \ - eslint; + eslint@8.38.0; cd /var/snippets/webpack; cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/; cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/; From 11d9d65bd7ea6c6c7d3b54a9059266f1f6f92f9d Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 17:04:55 +0200 Subject: [PATCH 08/29] chore: try something with global install on eslint plugins --- .ci/doc/docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index db3ca83be..5f0428c42 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -82,7 +82,7 @@ services: npm install; cd /var/snippets/web; cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/; - npm install \ + npm install -g \ /mnt/ \ eslint \ eslint-plugin-html \ From b44ff921cb454061ba6700547e4b899f7384e4d7 Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Wed, 9 Oct 2024 17:10:11 +0200 Subject: [PATCH 09/29] chore: install the eslint plugins in the right directory --- .ci/doc/docker-compose.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index 5f0428c42..7c9b09c5f 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -82,8 +82,8 @@ services: npm install; cd /var/snippets/web; cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/; - npm install -g \ - /mnt/ \ + npm install \ + /mnt/.ci/doc \ eslint \ eslint-plugin-html \ eslint-plugin-import \ From afcf3ac2d993d8c132a9b09a1e8f9fdcd99617cf Mon Sep 17 00:00:00 2001 From: afondard Date: Thu, 10 Oct 2024 17:46:28 +0200 Subject: [PATCH 10/29] fix: ws vulnerability --- package-lock.json | 9 +++++---- package.json | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6fae67b87..45fa876ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "Apache-2.0", "dependencies": { "min-req-promise": "^1.0.1", - "ws": "^8.13.0" + "ws": "^8.17.1" }, "devDependencies": { "@babel/core": "^7.21.4", @@ -17359,9 +17359,10 @@ } }, "node_modules/ws": { - "version": "8.13.0", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.13.0.tgz", - "integrity": "sha512-x9vcZYTrFPC7aSIbj7sRCYo7L/Xb8Iy+pW0ng0wt2vCJv7M9HOMy0UoN3rr+IFC7hb7vXoqS+P9ktyLLLhO+LA==", + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz", + "integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==", + "license": "MIT", "engines": { "node": ">=10.0.0" }, diff --git a/package.json b/package.json index d1e83fcb9..b78efb773 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "license": "Apache-2.0", "dependencies": { "min-req-promise": "^1.0.1", - "ws": "^8.13.0" + "ws": "^8.17.1" }, "devDependencies": { "@babel/core": "^7.21.4", From 883052a5eb14f3fc846f4ed5843e6591423ac204 Mon Sep 17 00:00:00 2001 From: Juiced66 Date: Tue, 17 Sep 2024 15:49:47 +0200 Subject: [PATCH 11/29] docs: Add triggerEvents flag to all api actions and reduces missing options doc --- doc/7/controllers/auth/check-rights/index.md | 12 +++++++++--- doc/7/controllers/auth/check-token/index.md | 6 ++++-- doc/7/controllers/auth/create-api-key/index.md | 2 ++ .../controllers/auth/create-my-credentials/index.md | 5 +++-- doc/7/controllers/auth/credentials-exist/index.md | 5 +++-- doc/7/controllers/auth/delete-api-key/index.md | 2 ++ .../controllers/auth/delete-my-credentials/index.md | 5 +++-- doc/7/controllers/auth/get-current-user/index.md | 5 +++-- doc/7/controllers/auth/get-my-credentials/index.md | 5 +++-- doc/7/controllers/auth/get-my-rights/index.md | 3 ++- doc/7/controllers/auth/get-strategies/index.md | 3 ++- doc/7/controllers/auth/refresh-token/index.md | 3 ++- doc/7/controllers/auth/search-api-keys/index.md | 2 ++ .../controllers/auth/update-my-credentials/index.md | 5 +++-- doc/7/controllers/auth/update-self/index.md | 5 +++-- .../auth/validate-my-credentials/index.md | 5 +++-- doc/7/controllers/bulk/delete-by-query/index.md | 5 +++-- doc/7/controllers/bulk/import/index.md | 5 +++-- doc/7/controllers/bulk/mWrite/index.md | 5 +++-- doc/7/controllers/bulk/update-by-query/index.md | 4 +++- doc/7/controllers/bulk/write/index.md | 5 +++-- doc/7/controllers/collection/create/index.md | 5 +++-- .../collection/delete-specifications/index.md | 5 +++-- doc/7/controllers/collection/delete/index.md | 3 +++ doc/7/controllers/collection/exists/index.md | 5 +++-- doc/7/controllers/collection/get-mapping/index.md | 5 +++-- .../collection/get-specifications/index.md | 5 +++-- doc/7/controllers/collection/list/index.md | 3 ++- doc/7/controllers/collection/refresh/index.md | 5 +++-- .../collection/search-specifications/index.md | 3 ++- doc/7/controllers/collection/truncate/index.md | 5 +++-- doc/7/controllers/collection/update-mapping/index.md | 5 +++-- .../collection/update-specifications/index.md | 5 +++-- doc/7/controllers/collection/update/index.md | 12 +++++++----- .../collection/validate-specifications/index.md | 5 +++-- doc/7/controllers/document/count/index.md | 5 +++-- .../controllers/document/create-or-replace/index.md | 3 ++- doc/7/controllers/document/create/index.md | 3 ++- doc/7/controllers/document/delete-by-query/index.md | 3 ++- doc/7/controllers/document/delete-fields/index.md | 3 ++- doc/7/controllers/document/delete/index.md | 3 ++- doc/7/controllers/document/exists/index.md | 3 ++- doc/7/controllers/document/get/index.md | 5 +++-- .../document/m-create-or-replace/index.md | 3 ++- doc/7/controllers/document/m-create/index.md | 3 ++- doc/7/controllers/document/m-delete/index.md | 3 ++- doc/7/controllers/document/m-get/index.md | 5 +++-- doc/7/controllers/document/m-replace/index.md | 3 ++- doc/7/controllers/document/m-update/index.md | 3 ++- doc/7/controllers/document/m-upsert/index.md | 4 +++- doc/7/controllers/document/replace/index.md | 3 ++- doc/7/controllers/document/search/index.md | 3 ++- doc/7/controllers/document/update-by-query/index.md | 7 +++++-- doc/7/controllers/document/update/index.md | 5 +++-- doc/7/controllers/document/upsert/index.md | 4 +++- doc/7/controllers/document/validate/index.md | 7 ++++--- doc/7/controllers/index/create/index.md | 5 +++-- doc/7/controllers/index/delete/index.md | 5 +++-- doc/7/controllers/index/exists/index.md | 5 +++-- doc/7/controllers/index/list/index.md | 5 +++-- doc/7/controllers/index/m-delete/index.md | 5 +++-- doc/7/controllers/index/stats/index.md | 5 +++-- doc/7/controllers/ms/append/index.md | 4 +++- doc/7/controllers/ms/bitcount/index.md | 4 +++- doc/7/controllers/ms/bitop/index.md | 4 +++- doc/7/controllers/ms/bitpos/index.md | 4 +++- doc/7/controllers/ms/dbsize/index.md | 4 +++- doc/7/controllers/ms/decr/index.md | 3 ++- doc/7/controllers/ms/decrby/index.md | 4 +++- doc/7/controllers/ms/del/index.md | 4 +++- doc/7/controllers/ms/exists/index.md | 4 +++- doc/7/controllers/ms/expire/index.md | 4 +++- doc/7/controllers/ms/expireat/index.md | 4 +++- doc/7/controllers/ms/flushdb/index.md | 4 +++- doc/7/controllers/ms/geoadd/index.md | 4 +++- doc/7/controllers/ms/geodist/index.md | 4 +++- doc/7/controllers/ms/geohash/index.md | 4 +++- doc/7/controllers/ms/geopos/index.md | 4 +++- doc/7/controllers/ms/georadius/index.md | 8 +++++--- doc/7/controllers/ms/georadiusbymember/index.md | 5 +++-- doc/7/controllers/ms/get/index.md | 5 +++-- doc/7/controllers/ms/getbit/index.md | 5 +++-- doc/7/controllers/ms/getrange/index.md | 5 +++-- doc/7/controllers/ms/getset/index.md | 5 +++-- doc/7/controllers/ms/hdel/index.md | 5 +++-- doc/7/controllers/ms/hexists/index.md | 5 +++-- doc/7/controllers/ms/hget/index.md | 5 +++-- doc/7/controllers/ms/hgetall/index.md | 4 +++- doc/7/controllers/ms/hincrby/index.md | 4 +++- doc/7/controllers/ms/hincrbyfloat/index.md | 4 +++- doc/7/controllers/ms/hkeys/index.md | 4 +++- doc/7/controllers/ms/hlen/index.md | 4 +++- doc/7/controllers/ms/hmget/index.md | 4 +++- doc/7/controllers/ms/hmset/index.md | 3 ++- doc/7/controllers/ms/hscan/index.md | 4 +++- doc/7/controllers/ms/hset/index.md | 4 +++- doc/7/controllers/ms/hsetnx/index.md | 4 +++- doc/7/controllers/ms/hstrlen/index.md | 4 +++- doc/7/controllers/ms/hvals/index.md | 4 +++- doc/7/controllers/ms/incr/index.md | 4 +++- doc/7/controllers/ms/incrby/index.md | 4 +++- doc/7/controllers/ms/incrbyfloat/index.md | 4 +++- doc/7/controllers/ms/keys/index.md | 4 +++- doc/7/controllers/ms/lindex/index.md | 4 +++- doc/7/controllers/ms/linsert/index.md | 4 +++- doc/7/controllers/ms/llen/index.md | 4 +++- doc/7/controllers/ms/lpop/index.md | 4 +++- doc/7/controllers/ms/lpush/index.md | 4 +++- doc/7/controllers/ms/lpushx/index.md | 4 +++- doc/7/controllers/ms/lrange/index.md | 4 +++- doc/7/controllers/ms/lrem/index.md | 4 +++- doc/7/controllers/ms/lset/index.md | 4 +++- doc/7/controllers/ms/ltrim/index.md | 4 +++- doc/7/controllers/ms/mexecute/index.md | 10 ++++++++++ doc/7/controllers/ms/mget/index.md | 4 +++- doc/7/controllers/ms/mset/index.md | 4 +++- doc/7/controllers/ms/msetnx/index.md | 4 +++- doc/7/controllers/ms/object/index.md | 4 +++- doc/7/controllers/ms/persist/index.md | 4 +++- doc/7/controllers/ms/pexpire/index.md | 4 +++- doc/7/controllers/ms/pexpireat/index.md | 4 +++- doc/7/controllers/ms/pfadd/index.md | 4 +++- doc/7/controllers/ms/pfcount/index.md | 4 +++- doc/7/controllers/ms/pfmerge/index.md | 4 +++- doc/7/controllers/ms/ping/index.md | 4 +++- doc/7/controllers/ms/psetex/index.md | 4 +++- doc/7/controllers/ms/pttl/index.md | 4 +++- doc/7/controllers/ms/randomkey/index.md | 4 +++- doc/7/controllers/ms/rename/index.md | 4 +++- doc/7/controllers/ms/renamenx/index.md | 4 +++- doc/7/controllers/ms/rpop/index.md | 4 +++- doc/7/controllers/ms/rpoplpush/index.md | 4 +++- doc/7/controllers/ms/rpush/index.md | 4 +++- doc/7/controllers/ms/rpushx/index.md | 4 +++- doc/7/controllers/ms/sadd/index.md | 4 +++- doc/7/controllers/ms/scan/index.md | 4 +++- doc/7/controllers/ms/scard/index.md | 4 +++- doc/7/controllers/ms/sdiff/index.md | 4 +++- doc/7/controllers/ms/sdiffstore/index.md | 4 +++- doc/7/controllers/ms/set/index.md | 8 +++++--- doc/7/controllers/ms/setex/index.md | 4 +++- doc/7/controllers/ms/setnx/index.md | 4 +++- doc/7/controllers/ms/sinter/index.md | 4 +++- doc/7/controllers/ms/sinterstore/index.md | 4 +++- doc/7/controllers/ms/sismember/index.md | 4 +++- doc/7/controllers/ms/smembers/index.md | 4 +++- doc/7/controllers/ms/smove/index.md | 4 +++- doc/7/controllers/ms/sort/index.md | 4 +++- doc/7/controllers/ms/spop/index.md | 4 +++- doc/7/controllers/ms/srandmember/index.md | 4 +++- doc/7/controllers/ms/srem/index.md | 4 +++- doc/7/controllers/ms/sscan/index.md | 4 +++- doc/7/controllers/ms/strlen/index.md | 4 +++- doc/7/controllers/ms/sunion/index.md | 4 +++- doc/7/controllers/ms/sunionstore/index.md | 4 +++- doc/7/controllers/ms/time/index.md | 4 +++- doc/7/controllers/ms/touch/index.md | 4 +++- doc/7/controllers/ms/ttl/index.md | 4 +++- doc/7/controllers/ms/type/index.md | 4 +++- doc/7/controllers/ms/zadd/index.md | 12 +++++++----- doc/7/controllers/ms/zcard/index.md | 4 +++- doc/7/controllers/ms/zcount/index.md | 4 +++- doc/7/controllers/ms/zincrby/index.md | 4 +++- doc/7/controllers/ms/zinterstore/index.md | 5 ++++- doc/7/controllers/ms/zlexcount/index.md | 4 +++- doc/7/controllers/ms/zrange/index.md | 4 +++- doc/7/controllers/ms/zrangebylex/index.md | 5 ++++- doc/7/controllers/ms/zrangebyscore/index.md | 5 ++++- doc/7/controllers/ms/zrank/index.md | 4 +++- doc/7/controllers/ms/zrem/index.md | 4 +++- doc/7/controllers/ms/zremrangebylex/index.md | 4 +++- doc/7/controllers/ms/zremrangebyrank/index.md | 4 +++- doc/7/controllers/ms/zremrangebyscore/index.md | 4 +++- doc/7/controllers/ms/zrevrange/index.md | 4 +++- doc/7/controllers/ms/zrevrangebylex/index.md | 5 ++++- doc/7/controllers/ms/zrevrangebyscore/index.md | 4 +++- doc/7/controllers/ms/zrevrank/index.md | 4 +++- doc/7/controllers/ms/zscan/index.md | 4 +++- doc/7/controllers/ms/zscore/index.md | 4 +++- doc/7/controllers/ms/zunionstore/index.md | 4 +++- doc/7/controllers/realtime/count/index.md | 3 ++- doc/7/controllers/realtime/publish/index.md | 3 ++- doc/7/controllers/realtime/subscribe/index.md | 3 ++- doc/7/controllers/realtime/unsubscribe/index.md | 3 ++- doc/7/controllers/security/check-rights/index.md | 11 ++++++++++- doc/7/controllers/security/create-api-key/index.md | 3 +++ .../controllers/security/create-credentials/index.md | 4 +++- .../controllers/security/create-first-admin/index.md | 6 ++++-- .../security/create-or-replace-profile/index.md | 4 +++- .../security/create-or-replace-role/index.md | 4 +++- doc/7/controllers/security/create-profile/index.md | 4 +++- .../security/create-restricted-user/index.md | 5 +++-- doc/7/controllers/security/create-role/index.md | 5 +++-- doc/7/controllers/security/create-user/index.md | 4 +++- doc/7/controllers/security/delete-api-key/index.md | 4 +++- .../controllers/security/delete-credentials/index.md | 4 +++- doc/7/controllers/security/delete-profile/index.md | 4 +++- doc/7/controllers/security/delete-role/index.md | 4 +++- doc/7/controllers/security/delete-user/index.md | 4 +++- .../security/get-all-credential-fields/index.md | 4 +++- .../security/get-credential-fields/index.md | 4 +++- .../security/get-credentials-by-id/index.md | 4 +++- doc/7/controllers/security/get-credentials/index.md | 4 +++- .../security/get-profile-mapping/index.md | 4 +++- .../controllers/security/get-profile-rights/index.md | 4 +++- doc/7/controllers/security/get-profile/index.md | 4 +++- doc/7/controllers/security/get-role-mapping/index.md | 4 +++- doc/7/controllers/security/get-role/index.md | 4 +++- doc/7/controllers/security/get-user-mapping/index.md | 4 +++- doc/7/controllers/security/get-user-rights/index.md | 4 +++- .../security/get-user-strategies/index.md | 4 +++- doc/7/controllers/security/get-user/index.md | 4 +++- doc/7/controllers/security/has-credentials/index.md | 4 +++- .../controllers/security/m-delete-profiles/index.md | 4 +++- doc/7/controllers/security/m-delete-roles/index.md | 4 +++- doc/7/controllers/security/m-delete-users/index.md | 4 +++- doc/7/controllers/security/m-get-profiles/index.md | 4 +++- doc/7/controllers/security/m-get-roles/index.md | 4 +++- doc/7/controllers/security/m-get-users/index.md | 4 +++- doc/7/controllers/security/replace-user/index.md | 4 +++- doc/7/controllers/security/search-api-keys/index.md | 2 ++ doc/7/controllers/security/search-profiles/index.md | 4 +++- doc/7/controllers/security/search-roles/index.md | 4 +++- doc/7/controllers/security/search-users/index.md | 4 +++- .../controllers/security/update-credentials/index.md | 4 +++- .../security/update-profile-mapping/index.md | 4 +++- doc/7/controllers/security/update-profile/index.md | 4 +++- .../security/update-role-mapping/index.md | 4 +++- doc/7/controllers/security/update-role/index.md | 4 +++- .../security/update-user-mapping/index.md | 4 +++- doc/7/controllers/security/update-user/index.md | 4 +++- .../security/validate-credentials/index.md | 4 +++- doc/7/controllers/server/admin-exists/index.md | 4 +++- doc/7/controllers/server/get-all-stats/index.md | 4 +++- doc/7/controllers/server/get-config/index.md | 4 +++- doc/7/controllers/server/get-last-stats/index.md | 4 +++- doc/7/controllers/server/get-stats/index.md | 4 +++- doc/7/controllers/server/info/index.md | 4 +++- doc/7/controllers/server/now/index.md | 4 +++- doc/7/core-classes/base-controller/query/index.md | 2 +- doc/7/core-classes/kuzzle/query/index.md | 8 +++++++- 241 files changed, 738 insertions(+), 295 deletions(-) diff --git a/doc/7/controllers/auth/check-rights/index.md b/doc/7/controllers/auth/check-rights/index.md index 12e90a6e1..78e62b4c4 100644 --- a/doc/7/controllers/auth/check-rights/index.md +++ b/doc/7/controllers/auth/check-rights/index.md @@ -15,13 +15,13 @@ Checks if the provided API request can be executed by the current logged user. --- ```js -checkRights(requestPayload) +checkRights(requestPayload, [options]) ``` | Property | Type | Description | | ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `requestPayload` | 
object
| Contains a [RequestPayload](/core/2/api/payloads/request) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `requestPayload` | 
object
| Contains a [RequestPayload](/core/2/api/payloads/request) +| `options` | 
object
| Query options | ## `requestPayload` @@ -31,7 +31,13 @@ The [RequestPayload](/core/2/api/payloads/request) must contains at least the fo - `action`: API action --- +### options +| Property | Type
(default) | Description | +| --- | --- | --- | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves A boolean telling whether the provided request would have been allowed or not. diff --git a/doc/7/controllers/auth/check-token/index.md b/doc/7/controllers/auth/check-token/index.md index 66d46550a..62bd151c2 100644 --- a/doc/7/controllers/auth/check-token/index.md +++ b/doc/7/controllers/auth/check-token/index.md @@ -22,14 +22,16 @@ checkToken([token]); | Property | Type | Description | | -------- | ----------------- | ----------- | | `token` | 
string
| Optional authentication token | - +| `options` | 
object
| Query options | ### options Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/create-api-key/index.md b/doc/7/controllers/auth/create-api-key/index.md index 1a747800a..ddc9398b9 100644 --- a/doc/7/controllers/auth/create-api-key/index.md +++ b/doc/7/controllers/auth/create-api-key/index.md @@ -35,7 +35,9 @@ Additional query options | `expiresIn` | 
string/number

(`-1`) | Expiration duration | | `_id` | 
string

(`null`) | API key unique ID | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | **Notes**: - `expiresIn`: diff --git a/doc/7/controllers/auth/create-my-credentials/index.md b/doc/7/controllers/auth/create-my-credentials/index.md index f55097eac..1b19600ae 100644 --- a/doc/7/controllers/auth/create-my-credentials/index.md +++ b/doc/7/controllers/auth/create-my-credentials/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/credentials-exist/index.md b/doc/7/controllers/auth/credentials-exist/index.md index fcfcbfb40..05cd7b436 100644 --- a/doc/7/controllers/auth/credentials-exist/index.md +++ b/doc/7/controllers/auth/credentials-exist/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/delete-api-key/index.md b/doc/7/controllers/auth/delete-api-key/index.md index 570b7ba0f..6a108aa7d 100644 --- a/doc/7/controllers/auth/delete-api-key/index.md +++ b/doc/7/controllers/auth/delete-api-key/index.md @@ -33,7 +33,9 @@ Additional query options | Property | Type
(default) | Description | | --------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/delete-my-credentials/index.md b/doc/7/controllers/auth/delete-my-credentials/index.md index 2860ff00e..d2c6fe4a8 100644 --- a/doc/7/controllers/auth/delete-my-credentials/index.md +++ b/doc/7/controllers/auth/delete-my-credentials/index.md @@ -32,8 +32,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-current-user/index.md b/doc/7/controllers/auth/get-current-user/index.md index 6e822fe86..ce2ee35a9 100644 --- a/doc/7/controllers/auth/get-current-user/index.md +++ b/doc/7/controllers/auth/get-current-user/index.md @@ -27,8 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-my-credentials/index.md b/doc/7/controllers/auth/get-my-credentials/index.md index 3c3f768cf..77c582b29 100644 --- a/doc/7/controllers/auth/get-my-credentials/index.md +++ b/doc/7/controllers/auth/get-my-credentials/index.md @@ -32,8 +32,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-my-rights/index.md b/doc/7/controllers/auth/get-my-rights/index.md index 67fd097c2..592e0dfcb 100644 --- a/doc/7/controllers/auth/get-my-rights/index.md +++ b/doc/7/controllers/auth/get-my-rights/index.md @@ -28,7 +28,8 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-strategies/index.md b/doc/7/controllers/auth/get-strategies/index.md index d1ee9f2d5..ce9e727ba 100644 --- a/doc/7/controllers/auth/get-strategies/index.md +++ b/doc/7/controllers/auth/get-strategies/index.md @@ -28,7 +28,8 @@ Additional query options | Property | Type | Description | Default | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/refresh-token/index.md b/doc/7/controllers/auth/refresh-token/index.md index a74718431..6423ec02a 100644 --- a/doc/7/controllers/auth/refresh-token/index.md +++ b/doc/7/controllers/auth/refresh-token/index.md @@ -36,8 +36,9 @@ Additional query options | Property | Type
(default) | Description | | ----------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `expiresIn` | 
string
| Expiration time in [ms library](https://www.npmjs.com/package/ms) format. (e.g. `2h`) | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ### expiresIn diff --git a/doc/7/controllers/auth/search-api-keys/index.md b/doc/7/controllers/auth/search-api-keys/index.md index 6197e44fd..5f08984c9 100644 --- a/doc/7/controllers/auth/search-api-keys/index.md +++ b/doc/7/controllers/auth/search-api-keys/index.md @@ -50,7 +50,9 @@ Additional query options | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/update-my-credentials/index.md b/doc/7/controllers/auth/update-my-credentials/index.md index 4f2106384..135baff74 100644 --- a/doc/7/controllers/auth/update-my-credentials/index.md +++ b/doc/7/controllers/auth/update-my-credentials/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/update-self/index.md b/doc/7/controllers/auth/update-self/index.md index f18e6120b..cf353daf3 100644 --- a/doc/7/controllers/auth/update-self/index.md +++ b/doc/7/controllers/auth/update-self/index.md @@ -30,8 +30,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/validate-my-credentials/index.md b/doc/7/controllers/auth/validate-my-credentials/index.md index 3f1f57521..ea463edb5 100644 --- a/doc/7/controllers/auth/validate-my-credentials/index.md +++ b/doc/7/controllers/auth/validate-my-credentials/index.md @@ -31,8 +31,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/delete-by-query/index.md b/doc/7/controllers/bulk/delete-by-query/index.md index b8ce33c50..c8054451b 100644 --- a/doc/7/controllers/bulk/delete-by-query/index.md +++ b/doc/7/controllers/bulk/delete-by-query/index.md @@ -31,9 +31,10 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/import/index.md b/doc/7/controllers/bulk/import/index.md index 211dd692d..a5c644d64 100644 --- a/doc/7/controllers/bulk/import/index.md +++ b/doc/7/controllers/bulk/import/index.md @@ -60,8 +60,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/bulk/mWrite/index.md b/doc/7/controllers/bulk/mWrite/index.md index 8dc11820b..c5fb56746 100644 --- a/doc/7/controllers/bulk/mWrite/index.md +++ b/doc/7/controllers/bulk/mWrite/index.md @@ -45,10 +45,11 @@ Additional query options | Property | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `notify` | 
boolean

(`false`) | if set to true, Kuzzle will trigger realtime notifications | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `notify` | 
boolean

(`false`) | if set to `true`, Kuzzle will trigger realtime notifications | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/bulk/update-by-query/index.md b/doc/7/controllers/bulk/update-by-query/index.md index 79c4fe43e..84adea0fb 100644 --- a/doc/7/controllers/bulk/update-by-query/index.md +++ b/doc/7/controllers/bulk/update-by-query/index.md @@ -39,7 +39,9 @@ Additional query options. | Options | Type
(default) | Description | |-----------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------| | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/write/index.md b/doc/7/controllers/bulk/write/index.md index 3b311bff9..4df7431a2 100644 --- a/doc/7/controllers/bulk/write/index.md +++ b/doc/7/controllers/bulk/write/index.md @@ -40,10 +40,11 @@ Additional query options | Property | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `notify` | 
boolean

(`false`) | if set to true, Kuzzle will trigger realtime notifications | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `notify` | 
boolean

(`false`) | if set to `true`, Kuzzle will trigger realtime notifications | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/collection/create/index.md b/doc/7/controllers/collection/create/index.md index 1c6c32ba2..5da48a0cc 100644 --- a/doc/7/controllers/collection/create/index.md +++ b/doc/7/controllers/collection/create/index.md @@ -94,8 +94,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/delete-specifications/index.md b/doc/7/controllers/collection/delete-specifications/index.md index aa110bd2c..090b70159 100644 --- a/doc/7/controllers/collection/delete-specifications/index.md +++ b/doc/7/controllers/collection/delete-specifications/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/delete/index.md b/doc/7/controllers/collection/delete/index.md index dbc16ed11..eba74ee94 100644 --- a/doc/7/controllers/collection/delete/index.md +++ b/doc/7/controllers/collection/delete/index.md @@ -29,7 +29,10 @@ Additional query options | Options | Type
(default) | Description | | --------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolves Resolves if the collection is successfully deleted. diff --git a/doc/7/controllers/collection/exists/index.md b/doc/7/controllers/collection/exists/index.md index 4245f78a3..ca40394c3 100644 --- a/doc/7/controllers/collection/exists/index.md +++ b/doc/7/controllers/collection/exists/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/get-mapping/index.md b/doc/7/controllers/collection/get-mapping/index.md index e6addbd9d..e708c8723 100644 --- a/doc/7/controllers/collection/get-mapping/index.md +++ b/doc/7/controllers/collection/get-mapping/index.md @@ -29,9 +29,10 @@ Additional query options | Property | Type
(default) | Description | | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `includeKuzzleMeta` | 
boolean

(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `includeKuzzleMeta` | 
boolean

(`true`) | If `true`, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/get-specifications/index.md b/doc/7/controllers/collection/get-specifications/index.md index 036331e05..f54c9c1bd 100644 --- a/doc/7/controllers/collection/get-specifications/index.md +++ b/doc/7/controllers/collection/get-specifications/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/list/index.md b/doc/7/controllers/collection/list/index.md index 945095b56..754c201cb 100644 --- a/doc/7/controllers/collection/list/index.md +++ b/doc/7/controllers/collection/list/index.md @@ -29,10 +29,11 @@ Additional query options | Property | Type
(default) | Description | |------------|---------------------------------|------------------------------------------------------------------------------| -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first result | | `size` | 
number

(`10`) | Maximum number of returned results | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/refresh/index.md b/doc/7/controllers/collection/refresh/index.md index 306f68252..ffaf90ccc 100644 --- a/doc/7/controllers/collection/refresh/index.md +++ b/doc/7/controllers/collection/refresh/index.md @@ -35,8 +35,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/search-specifications/index.md b/doc/7/controllers/collection/search-specifications/index.md index b1dfbe297..eb2b765a6 100644 --- a/doc/7/controllers/collection/search-specifications/index.md +++ b/doc/7/controllers/collection/search-specifications/index.md @@ -56,11 +56,12 @@ const body = { | `from` | 
number

(`0`) | Offset of the first document | | `size` | 
number

(`10`) | Maximum number of documents returned | | `scroll` | 
string

| Maximum duration for scroll session | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | - `size` controls the maximum number of documents returned in the response - `from` is usually used with the `size` argument, and defines the offset from the first result you want to fetch - `scroll` is used to fetch large result sets, and it must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units). If set, a forward-only cursor will be created (and automatically destroyed at the end of the set duration), and its identifier will be returned in the `scrollId` property, along with the first page of the results. +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/truncate/index.md b/doc/7/controllers/collection/truncate/index.md index f5bc2fabf..59ab722d0 100644 --- a/doc/7/controllers/collection/truncate/index.md +++ b/doc/7/controllers/collection/truncate/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update-mapping/index.md b/doc/7/controllers/collection/update-mapping/index.md index f70b74dc7..3f164da33 100644 --- a/doc/7/controllers/collection/update-mapping/index.md +++ b/doc/7/controllers/collection/update-mapping/index.md @@ -58,8 +58,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update-specifications/index.md b/doc/7/controllers/collection/update-specifications/index.md index 60e023dc4..fe10ada70 100644 --- a/doc/7/controllers/collection/update-specifications/index.md +++ b/doc/7/controllers/collection/update-specifications/index.md @@ -47,8 +47,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update/index.md b/doc/7/controllers/collection/update/index.md index 5057fd819..f543fa918 100644 --- a/doc/7/controllers/collection/update/index.md +++ b/doc/7/controllers/collection/update/index.md @@ -37,11 +37,13 @@ update(index, collection, definition); Additional query options -| Options | Type
(default) | Description | -| ----------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| Options | Type
(default) | Description | +| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + diff --git a/doc/7/controllers/collection/validate-specifications/index.md b/doc/7/controllers/collection/validate-specifications/index.md index 8d5330fba..f3992c957 100644 --- a/doc/7/controllers/collection/validate-specifications/index.md +++ b/doc/7/controllers/collection/validate-specifications/index.md @@ -47,8 +47,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/count/index.md b/doc/7/controllers/document/count/index.md index 6009911f4..a354b220e 100644 --- a/doc/7/controllers/document/count/index.md +++ b/doc/7/controllers/document/count/index.md @@ -32,8 +32,9 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/create-or-replace/index.md b/doc/7/controllers/document/create-or-replace/index.md index a3993e601..644676059 100644 --- a/doc/7/controllers/document/create-or-replace/index.md +++ b/doc/7/controllers/document/create-or-replace/index.md @@ -31,10 +31,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/create/index.md b/doc/7/controllers/document/create/index.md index 12ab163b7..7cf6e09c4 100644 --- a/doc/7/controllers/document/create/index.md +++ b/doc/7/controllers/document/create/index.md @@ -33,10 +33,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete-by-query/index.md b/doc/7/controllers/document/delete-by-query/index.md index 33deb4c08..d498df11f 100644 --- a/doc/7/controllers/document/delete-by-query/index.md +++ b/doc/7/controllers/document/delete-by-query/index.md @@ -42,11 +42,12 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | `source` | 
boolean
| if set to `true` Kuzzle will return each deleted document body in the response | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete-fields/index.md b/doc/7/controllers/document/delete-fields/index.md index 3d513d3a8..2e9c12bdc 100644 --- a/doc/7/controllers/document/delete-fields/index.md +++ b/doc/7/controllers/document/delete-fields/index.md @@ -31,11 +31,12 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | `source` | 
boolean

(`false`) | If `true`, then the response will contain the updated document | | `timeout` | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete/index.md b/doc/7/controllers/document/delete/index.md index c568a8980..81a425615 100644 --- a/doc/7/controllers/document/delete/index.md +++ b/doc/7/controllers/document/delete/index.md @@ -30,10 +30,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/exists/index.md b/doc/7/controllers/document/exists/index.md index a14bd21b8..e22331363 100644 --- a/doc/7/controllers/document/exists/index.md +++ b/doc/7/controllers/document/exists/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/get/index.md b/doc/7/controllers/document/get/index.md index 4d852ef88..5f961bf0d 100644 --- a/doc/7/controllers/document/get/index.md +++ b/doc/7/controllers/document/get/index.md @@ -28,8 +28,9 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-create-or-replace/index.md b/doc/7/controllers/document/m-create-or-replace/index.md index ba2402e6f..802db10c2 100644 --- a/doc/7/controllers/document/m-create-or-replace/index.md +++ b/doc/7/controllers/document/m-create-or-replace/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-create/index.md b/doc/7/controllers/document/m-create/index.md index b9868ada8..5597ae0a8 100644 --- a/doc/7/controllers/document/m-create/index.md +++ b/doc/7/controllers/document/m-create/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-delete/index.md b/doc/7/controllers/document/m-delete/index.md index 198a7973b..f2a48e5a6 100644 --- a/doc/7/controllers/document/m-delete/index.md +++ b/doc/7/controllers/document/m-delete/index.md @@ -30,10 +30,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-get/index.md b/doc/7/controllers/document/m-get/index.md index 93ccc8334..5ada625a1 100644 --- a/doc/7/controllers/document/m-get/index.md +++ b/doc/7/controllers/document/m-get/index.md @@ -29,9 +29,10 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `verb` | 
string
| (HTTP only) Forces the verb of the route | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### verb diff --git a/doc/7/controllers/document/m-replace/index.md b/doc/7/controllers/document/m-replace/index.md index cd8448f01..24c7eec21 100644 --- a/doc/7/controllers/document/m-replace/index.md +++ b/doc/7/controllers/document/m-replace/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-update/index.md b/doc/7/controllers/document/m-update/index.md index 7b026a6d1..af5fe3179 100644 --- a/doc/7/controllers/document/m-update/index.md +++ b/doc/7/controllers/document/m-update/index.md @@ -32,11 +32,12 @@ Additional query options | Options | Type
(default) | Description | | ----------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-upsert/index.md b/doc/7/controllers/document/m-upsert/index.md index 3c5b36c6e..f8e2bbb19 100644 --- a/doc/7/controllers/document/m-upsert/index.md +++ b/doc/7/controllers/document/m-upsert/index.md @@ -60,10 +60,12 @@ Additional query options | Options | Type
(default) | Description | |-------------------|----------------------------------|------------------------------------------------------------------------------------------| -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/replace/index.md b/doc/7/controllers/document/replace/index.md index e8105ace2..16ce7afa9 100644 --- a/doc/7/controllers/document/replace/index.md +++ b/doc/7/controllers/document/replace/index.md @@ -29,10 +29,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/search/index.md b/doc/7/controllers/document/search/index.md index 6e2a0860c..27271947e 100644 --- a/doc/7/controllers/document/search/index.md +++ b/doc/7/controllers/document/search/index.md @@ -47,13 +47,14 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `verb` | 
string
| (HTTP only) Forces the verb of the route | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### verb diff --git a/doc/7/controllers/document/update-by-query/index.md b/doc/7/controllers/document/update-by-query/index.md index 4d8d5ccd1..b495bab37 100644 --- a/doc/7/controllers/document/update-by-query/index.md +++ b/doc/7/controllers/document/update-by-query/index.md @@ -47,8 +47,11 @@ Additional query options. | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolves Returns an object containing 2 arrays: `successes` and `errors` @@ -57,7 +60,7 @@ Each updated document is an object of the `successes` array with the following p | Property | Type | Description | | ---------- | --------------------------------- | ------------------------------------------------------ | -| `_source` | 
object
| Updated document (if `source` option set to true) | +| `_source` | 
object
| Updated document (if `source` option set to `true`) | | `_id` | 
string
| ID of the udated document | | `_version` | 
number
| Version of the document in the persistent data storage | | `status` | 
number
| HTTP status code | diff --git a/doc/7/controllers/document/update/index.md b/doc/7/controllers/document/update/index.md index 68aa416fe..450774a5d 100644 --- a/doc/7/controllers/document/update/index.md +++ b/doc/7/controllers/document/update/index.md @@ -32,12 +32,13 @@ Additional query options | Options | Type
(default) | Description | | ----------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/upsert/index.md b/doc/7/controllers/document/upsert/index.md index 468414465..50102e376 100644 --- a/doc/7/controllers/document/upsert/index.md +++ b/doc/7/controllers/document/upsert/index.md @@ -34,8 +34,10 @@ Additional query options | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`10`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/validate/index.md b/doc/7/controllers/document/validate/index.md index a6a8d4f9f..192e79ead 100644 --- a/doc/7/controllers/document/validate/index.md +++ b/doc/7/controllers/document/validate/index.md @@ -32,12 +32,13 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves -Resolves to a boolean value set to true if the document is valid and false otherwise. +Resolves to a boolean value set to `true` if the document is valid and false otherwise. ## Usage diff --git a/doc/7/controllers/index/create/index.md b/doc/7/controllers/index/create/index.md index c96860cf4..db31aabe4 100644 --- a/doc/7/controllers/index/create/index.md +++ b/doc/7/controllers/index/create/index.md @@ -34,8 +34,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/delete/index.md b/doc/7/controllers/index/delete/index.md index 0afc22970..bf6cd3baa 100644 --- a/doc/7/controllers/index/delete/index.md +++ b/doc/7/controllers/index/delete/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/exists/index.md b/doc/7/controllers/index/exists/index.md index 571177c78..89e34823d 100644 --- a/doc/7/controllers/index/exists/index.md +++ b/doc/7/controllers/index/exists/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/list/index.md b/doc/7/controllers/index/list/index.md index 8f41681bf..b19907a2c 100644 --- a/doc/7/controllers/index/list/index.md +++ b/doc/7/controllers/index/list/index.md @@ -27,8 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/m-delete/index.md b/doc/7/controllers/index/m-delete/index.md index ff7c4a1f3..464819224 100644 --- a/doc/7/controllers/index/m-delete/index.md +++ b/doc/7/controllers/index/m-delete/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/stats/index.md b/doc/7/controllers/index/stats/index.md index eef6c7b58..cc1892122 100644 --- a/doc/7/controllers/index/stats/index.md +++ b/doc/7/controllers/index/stats/index.md @@ -30,8 +30,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/ms/append/index.md b/doc/7/controllers/ms/append/index.md index bf8994f93..a0071a913 100644 --- a/doc/7/controllers/ms/append/index.md +++ b/doc/7/controllers/ms/append/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitcount/index.md b/doc/7/controllers/ms/bitcount/index.md index db719f134..96e26a903 100644 --- a/doc/7/controllers/ms/bitcount/index.md +++ b/doc/7/controllers/ms/bitcount/index.md @@ -30,8 +30,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `end` | 
integer
| Count ends at the provided offset | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `start` | 
integer
| Count starts at the provided offset | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitop/index.md b/doc/7/controllers/ms/bitop/index.md index 60a5eb03f..ea5df22f1 100644 --- a/doc/7/controllers/ms/bitop/index.md +++ b/doc/7/controllers/ms/bitop/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitpos/index.md b/doc/7/controllers/ms/bitpos/index.md index 1c3ba80db..be25bd4a7 100644 --- a/doc/7/controllers/ms/bitpos/index.md +++ b/doc/7/controllers/ms/bitpos/index.md @@ -31,8 +31,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `end` | 
integer
| Search ends at the provided offset | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `start` | 
integer
| Search starts at the provided offset | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/dbsize/index.md b/doc/7/controllers/ms/dbsize/index.md index 24d1c804d..ee8883699 100644 --- a/doc/7/controllers/ms/dbsize/index.md +++ b/doc/7/controllers/ms/dbsize/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/decr/index.md b/doc/7/controllers/ms/decr/index.md index 9492718e1..a6903b5c5 100644 --- a/doc/7/controllers/ms/decr/index.md +++ b/doc/7/controllers/ms/decr/index.md @@ -29,7 +29,8 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again || [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/decrby/index.md b/doc/7/controllers/ms/decrby/index.md index 1a5301d88..891d07049 100644 --- a/doc/7/controllers/ms/decrby/index.md +++ b/doc/7/controllers/ms/decrby/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/del/index.md b/doc/7/controllers/ms/del/index.md index ce4ad6873..cfeaa8c9b 100644 --- a/doc/7/controllers/ms/del/index.md +++ b/doc/7/controllers/ms/del/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/exists/index.md b/doc/7/controllers/ms/exists/index.md index ce8355dc8..e91266d6c 100644 --- a/doc/7/controllers/ms/exists/index.md +++ b/doc/7/controllers/ms/exists/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/expire/index.md b/doc/7/controllers/ms/expire/index.md index 0c34e8d80..168190a43 100644 --- a/doc/7/controllers/ms/expire/index.md +++ b/doc/7/controllers/ms/expire/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/expireat/index.md b/doc/7/controllers/ms/expireat/index.md index 0995e3b00..d0705eb7c 100644 --- a/doc/7/controllers/ms/expireat/index.md +++ b/doc/7/controllers/ms/expireat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/flushdb/index.md b/doc/7/controllers/ms/flushdb/index.md index f0c7cd774..5e3ab3022 100644 --- a/doc/7/controllers/ms/flushdb/index.md +++ b/doc/7/controllers/ms/flushdb/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geoadd/index.md b/doc/7/controllers/ms/geoadd/index.md index 85899b4f0..dca6ec9a5 100644 --- a/doc/7/controllers/ms/geoadd/index.md +++ b/doc/7/controllers/ms/geoadd/index.md @@ -40,7 +40,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geodist/index.md b/doc/7/controllers/ms/geodist/index.md index 6b07a0ead..6fc1c8897 100644 --- a/doc/7/controllers/ms/geodist/index.md +++ b/doc/7/controllers/ms/geodist/index.md @@ -33,8 +33,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `unit` | 
string ('m')
| The unit used for the returned calculated distance.
Accepted values: `m`, `km`, `mi`, `ft` | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geohash/index.md b/doc/7/controllers/ms/geohash/index.md index 21db80a23..6c0dd9a67 100644 --- a/doc/7/controllers/ms/geohash/index.md +++ b/doc/7/controllers/ms/geohash/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geopos/index.md b/doc/7/controllers/ms/geopos/index.md index b61345f58..1513f5274 100644 --- a/doc/7/controllers/ms/geopos/index.md +++ b/doc/7/controllers/ms/geopos/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/georadius/index.md b/doc/7/controllers/ms/georadius/index.md index 01b20afa7..676abfbcb 100644 --- a/doc/7/controllers/ms/georadius/index.md +++ b/doc/7/controllers/ms/georadius/index.md @@ -34,10 +34,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | -------------------------- | -------------------------------------------------------------------------------------- | | `count` | 
integer
| Limit the number of returned geopoints to the provided value | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`false`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `sort` | 
string
| Sort the result by distance, relative to the center.
Allowed values: `ASC`, `DESC` | -| `withcoord` | 
boolean (false)
| Include the position of the matched geopoint in the result | -| `withdist` | 
boolean (false)
| Include the calculated distance from the matched geopoint to center | +| `withcoord` | 
boolean (`false`)
| Include the position of the matched geopoint in the result | +| `withdist` | 
boolean (`false`)
| Include the calculated distance from the matched geopoint to center | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/georadiusbymember/index.md b/doc/7/controllers/ms/georadiusbymember/index.md index e93eb5d57..971eb4f78 100644 --- a/doc/7/controllers/ms/georadiusbymember/index.md +++ b/doc/7/controllers/ms/georadiusbymember/index.md @@ -33,11 +33,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | -------------------------- | -------------------------------------------------------------------------------------- | | `count` | 
integer
| Limit the number of returned geopoints to the provided value | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `sort` | 
string
| Sort the result by distance, relative to the center.
Allowed values: `ASC`, `DESC` | | `withcoord` | 
boolean (false)
| Include the position of the matched geopoint in the result | | `withdist` | 
boolean (false)
| Include the calculated distance from the matched geopoint to center | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to an array of matched geopoints. diff --git a/doc/7/controllers/ms/get/index.md b/doc/7/controllers/ms/get/index.md index c128a9317..c08aaedc2 100644 --- a/doc/7/controllers/ms/get/index.md +++ b/doc/7/controllers/ms/get/index.md @@ -29,8 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the key's value. diff --git a/doc/7/controllers/ms/getbit/index.md b/doc/7/controllers/ms/getbit/index.md index 7a2da9a1d..38ad51c1c 100644 --- a/doc/7/controllers/ms/getbit/index.md +++ b/doc/7/controllers/ms/getbit/index.md @@ -31,8 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the bit at the provided offset (`0` or `1`). diff --git a/doc/7/controllers/ms/getrange/index.md b/doc/7/controllers/ms/getrange/index.md index 735bbe6e3..54b395c44 100644 --- a/doc/7/controllers/ms/getrange/index.md +++ b/doc/7/controllers/ms/getrange/index.md @@ -33,8 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the extracted substring. diff --git a/doc/7/controllers/ms/getset/index.md b/doc/7/controllers/ms/getset/index.md index 2db4e8667..5857e3c26 100644 --- a/doc/7/controllers/ms/getset/index.md +++ b/doc/7/controllers/ms/getset/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the previously set value, or `null` if the key didn't exist prior to this operation. diff --git a/doc/7/controllers/ms/hdel/index.md b/doc/7/controllers/ms/hdel/index.md index 38c1f83ca..09fdb0695 100644 --- a/doc/7/controllers/ms/hdel/index.md +++ b/doc/7/controllers/ms/hdel/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the number of deleted fields. diff --git a/doc/7/controllers/ms/hexists/index.md b/doc/7/controllers/ms/hexists/index.md index fd1473b39..869c7986f 100644 --- a/doc/7/controllers/ms/hexists/index.md +++ b/doc/7/controllers/ms/hexists/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to a boolean telling whether the checked field exists or not. diff --git a/doc/7/controllers/ms/hget/index.md b/doc/7/controllers/ms/hget/index.md index 141228e71..9782956db 100644 --- a/doc/7/controllers/ms/hget/index.md +++ b/doc/7/controllers/ms/hget/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Returns the field's value. diff --git a/doc/7/controllers/ms/hgetall/index.md b/doc/7/controllers/ms/hgetall/index.md index 99de3f6bd..0db03def0 100644 --- a/doc/7/controllers/ms/hgetall/index.md +++ b/doc/7/controllers/ms/hgetall/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hincrby/index.md b/doc/7/controllers/ms/hincrby/index.md index d280835d7..075305042 100644 --- a/doc/7/controllers/ms/hincrby/index.md +++ b/doc/7/controllers/ms/hincrby/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hincrbyfloat/index.md b/doc/7/controllers/ms/hincrbyfloat/index.md index f72b5f865..b3b3aaf15 100644 --- a/doc/7/controllers/ms/hincrbyfloat/index.md +++ b/doc/7/controllers/ms/hincrbyfloat/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hkeys/index.md b/doc/7/controllers/ms/hkeys/index.md index 11d1e5063..c12197dd6 100644 --- a/doc/7/controllers/ms/hkeys/index.md +++ b/doc/7/controllers/ms/hkeys/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hlen/index.md b/doc/7/controllers/ms/hlen/index.md index 06421b8f7..d80e602d0 100644 --- a/doc/7/controllers/ms/hlen/index.md +++ b/doc/7/controllers/ms/hlen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hmget/index.md b/doc/7/controllers/ms/hmget/index.md index 756ad89bd..59e3e443d 100644 --- a/doc/7/controllers/ms/hmget/index.md +++ b/doc/7/controllers/ms/hmget/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hmset/index.md b/doc/7/controllers/ms/hmset/index.md index 757f061b1..5df53b656 100644 --- a/doc/7/controllers/ms/hmset/index.md +++ b/doc/7/controllers/ms/hmset/index.md @@ -39,7 +39,8 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`triggerEvents`](/sdk/7/core-classe| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |s/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hscan/index.md b/doc/7/controllers/ms/hscan/index.md index 5112e513e..e0e98f688 100644 --- a/doc/7/controllers/ms/hscan/index.md +++ b/doc/7/controllers/ms/hscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hset/index.md b/doc/7/controllers/ms/hset/index.md index d45888150..d5d96f4c6 100644 --- a/doc/7/controllers/ms/hset/index.md +++ b/doc/7/controllers/ms/hset/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hsetnx/index.md b/doc/7/controllers/ms/hsetnx/index.md index f49525e41..c8f47194d 100644 --- a/doc/7/controllers/ms/hsetnx/index.md +++ b/doc/7/controllers/ms/hsetnx/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hstrlen/index.md b/doc/7/controllers/ms/hstrlen/index.md index 23f2ce826..51e973ee9 100644 --- a/doc/7/controllers/ms/hstrlen/index.md +++ b/doc/7/controllers/ms/hstrlen/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hvals/index.md b/doc/7/controllers/ms/hvals/index.md index 7efa03a56..5b9643f33 100644 --- a/doc/7/controllers/ms/hvals/index.md +++ b/doc/7/controllers/ms/hvals/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incr/index.md b/doc/7/controllers/ms/incr/index.md index 81ac08daa..a9c47b61a 100644 --- a/doc/7/controllers/ms/incr/index.md +++ b/doc/7/controllers/ms/incr/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incrby/index.md b/doc/7/controllers/ms/incrby/index.md index fc17f6264..20df8e38a 100644 --- a/doc/7/controllers/ms/incrby/index.md +++ b/doc/7/controllers/ms/incrby/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incrbyfloat/index.md b/doc/7/controllers/ms/incrbyfloat/index.md index fca7286f8..456ffd853 100644 --- a/doc/7/controllers/ms/incrbyfloat/index.md +++ b/doc/7/controllers/ms/incrbyfloat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/keys/index.md b/doc/7/controllers/ms/keys/index.md index 53433d409..ecfc35aa1 100644 --- a/doc/7/controllers/ms/keys/index.md +++ b/doc/7/controllers/ms/keys/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lindex/index.md b/doc/7/controllers/ms/lindex/index.md index 2841425a3..742279a05 100644 --- a/doc/7/controllers/ms/lindex/index.md +++ b/doc/7/controllers/ms/lindex/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/linsert/index.md b/doc/7/controllers/ms/linsert/index.md index 5bba89e36..fc638594b 100644 --- a/doc/7/controllers/ms/linsert/index.md +++ b/doc/7/controllers/ms/linsert/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/llen/index.md b/doc/7/controllers/ms/llen/index.md index be28549f7..aee94b8ca 100644 --- a/doc/7/controllers/ms/llen/index.md +++ b/doc/7/controllers/ms/llen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpop/index.md b/doc/7/controllers/ms/lpop/index.md index dc2533a33..447e164e7 100644 --- a/doc/7/controllers/ms/lpop/index.md +++ b/doc/7/controllers/ms/lpop/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpush/index.md b/doc/7/controllers/ms/lpush/index.md index abe0e6fc1..d58e6d213 100644 --- a/doc/7/controllers/ms/lpush/index.md +++ b/doc/7/controllers/ms/lpush/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpushx/index.md b/doc/7/controllers/ms/lpushx/index.md index 37606192d..390b3e3fd 100644 --- a/doc/7/controllers/ms/lpushx/index.md +++ b/doc/7/controllers/ms/lpushx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lrange/index.md b/doc/7/controllers/ms/lrange/index.md index 1997c0299..b56fc094f 100644 --- a/doc/7/controllers/ms/lrange/index.md +++ b/doc/7/controllers/ms/lrange/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lrem/index.md b/doc/7/controllers/ms/lrem/index.md index 87f7c3bc1..ed9bd65b6 100644 --- a/doc/7/controllers/ms/lrem/index.md +++ b/doc/7/controllers/ms/lrem/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lset/index.md b/doc/7/controllers/ms/lset/index.md index 004a8281c..127f059bc 100644 --- a/doc/7/controllers/ms/lset/index.md +++ b/doc/7/controllers/ms/lset/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ltrim/index.md b/doc/7/controllers/ms/ltrim/index.md index daee7ddb7..04edfa737 100644 --- a/doc/7/controllers/ms/ltrim/index.md +++ b/doc/7/controllers/ms/ltrim/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/mexecute/index.md b/doc/7/controllers/ms/mexecute/index.md index 06aa9afd6..b0c08603b 100644 --- a/doc/7/controllers/ms/mexecute/index.md +++ b/doc/7/controllers/ms/mexecute/index.md @@ -38,6 +38,16 @@ The `actions` argument is an array of objects. Each object describes an action t | `action` | 
string
| Action name | | `args` | 
object
| Arguments | +### options + +The `options` arguments can contain the following option properties: + +| Property | Type (default) | Description | +| ---------- | ------------------------- | ---------------------------------------------------------------------------- | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve Returns an array of error & result pairs for each executed action, in order. diff --git a/doc/7/controllers/ms/mget/index.md b/doc/7/controllers/ms/mget/index.md index 99488fafa..b9170cae6 100644 --- a/doc/7/controllers/ms/mget/index.md +++ b/doc/7/controllers/ms/mget/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/mset/index.md b/doc/7/controllers/ms/mset/index.md index ddd5cf64f..e00398fdb 100644 --- a/doc/7/controllers/ms/mset/index.md +++ b/doc/7/controllers/ms/mset/index.md @@ -38,7 +38,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/msetnx/index.md b/doc/7/controllers/ms/msetnx/index.md index 64cc99b2a..9eca0ce51 100644 --- a/doc/7/controllers/ms/msetnx/index.md +++ b/doc/7/controllers/ms/msetnx/index.md @@ -38,7 +38,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/object/index.md b/doc/7/controllers/ms/object/index.md index 9c87e3bcc..cca004105 100644 --- a/doc/7/controllers/ms/object/index.md +++ b/doc/7/controllers/ms/object/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/persist/index.md b/doc/7/controllers/ms/persist/index.md index 19963bcc9..6d9b5d4a3 100644 --- a/doc/7/controllers/ms/persist/index.md +++ b/doc/7/controllers/ms/persist/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pexpire/index.md b/doc/7/controllers/ms/pexpire/index.md index 92a540532..ee5408cee 100644 --- a/doc/7/controllers/ms/pexpire/index.md +++ b/doc/7/controllers/ms/pexpire/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pexpireat/index.md b/doc/7/controllers/ms/pexpireat/index.md index ff31c6941..b8b214337 100644 --- a/doc/7/controllers/ms/pexpireat/index.md +++ b/doc/7/controllers/ms/pexpireat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfadd/index.md b/doc/7/controllers/ms/pfadd/index.md index 32bc0b613..41fe1d89a 100644 --- a/doc/7/controllers/ms/pfadd/index.md +++ b/doc/7/controllers/ms/pfadd/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfcount/index.md b/doc/7/controllers/ms/pfcount/index.md index 214dea781..64f1b8747 100644 --- a/doc/7/controllers/ms/pfcount/index.md +++ b/doc/7/controllers/ms/pfcount/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfmerge/index.md b/doc/7/controllers/ms/pfmerge/index.md index ed883f3f0..2c2c8cc41 100644 --- a/doc/7/controllers/ms/pfmerge/index.md +++ b/doc/7/controllers/ms/pfmerge/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ping/index.md b/doc/7/controllers/ms/ping/index.md index fb757401c..117a51f0b 100644 --- a/doc/7/controllers/ms/ping/index.md +++ b/doc/7/controllers/ms/ping/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/psetex/index.md b/doc/7/controllers/ms/psetex/index.md index 587999708..154fdfd1c 100644 --- a/doc/7/controllers/ms/psetex/index.md +++ b/doc/7/controllers/ms/psetex/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pttl/index.md b/doc/7/controllers/ms/pttl/index.md index 477790477..28f19dd8b 100644 --- a/doc/7/controllers/ms/pttl/index.md +++ b/doc/7/controllers/ms/pttl/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/randomkey/index.md b/doc/7/controllers/ms/randomkey/index.md index b3eea2ef2..b5f016e0f 100644 --- a/doc/7/controllers/ms/randomkey/index.md +++ b/doc/7/controllers/ms/randomkey/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rename/index.md b/doc/7/controllers/ms/rename/index.md index abff9ad35..49dbdf253 100644 --- a/doc/7/controllers/ms/rename/index.md +++ b/doc/7/controllers/ms/rename/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/renamenx/index.md b/doc/7/controllers/ms/renamenx/index.md index 48edab3a6..aea448878 100644 --- a/doc/7/controllers/ms/renamenx/index.md +++ b/doc/7/controllers/ms/renamenx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpop/index.md b/doc/7/controllers/ms/rpop/index.md index fb8f554ad..bdd8f34aa 100644 --- a/doc/7/controllers/ms/rpop/index.md +++ b/doc/7/controllers/ms/rpop/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpoplpush/index.md b/doc/7/controllers/ms/rpoplpush/index.md index a46882b6e..172ec566d 100644 --- a/doc/7/controllers/ms/rpoplpush/index.md +++ b/doc/7/controllers/ms/rpoplpush/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpush/index.md b/doc/7/controllers/ms/rpush/index.md index becc1860e..c46c8f09e 100644 --- a/doc/7/controllers/ms/rpush/index.md +++ b/doc/7/controllers/ms/rpush/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpushx/index.md b/doc/7/controllers/ms/rpushx/index.md index f9604b8c1..cd937f916 100644 --- a/doc/7/controllers/ms/rpushx/index.md +++ b/doc/7/controllers/ms/rpushx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sadd/index.md b/doc/7/controllers/ms/sadd/index.md index cf3f528d0..86b248c8a 100644 --- a/doc/7/controllers/ms/sadd/index.md +++ b/doc/7/controllers/ms/sadd/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/scan/index.md b/doc/7/controllers/ms/scan/index.md index 9ba928872..c506c5e80 100644 --- a/doc/7/controllers/ms/scan/index.md +++ b/doc/7/controllers/ms/scan/index.md @@ -36,7 +36,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/scard/index.md b/doc/7/controllers/ms/scard/index.md index f7b7aca95..86db50546 100644 --- a/doc/7/controllers/ms/scard/index.md +++ b/doc/7/controllers/ms/scard/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sdiff/index.md b/doc/7/controllers/ms/sdiff/index.md index 06f361efe..03010a21b 100644 --- a/doc/7/controllers/ms/sdiff/index.md +++ b/doc/7/controllers/ms/sdiff/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sdiffstore/index.md b/doc/7/controllers/ms/sdiffstore/index.md index 5fb7807b3..1e722744f 100644 --- a/doc/7/controllers/ms/sdiffstore/index.md +++ b/doc/7/controllers/ms/sdiffstore/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/set/index.md b/doc/7/controllers/ms/set/index.md index 35300d86b..8365402eb 100644 --- a/doc/7/controllers/ms/set/index.md +++ b/doc/7/controllers/ms/set/index.md @@ -31,10 +31,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | -------------------------- | ---------------------------------------------------------------------------- | | `ex` | 
integer
| Adds an expiration delay to the key, in seconds | -| `nx` | 
boolean (false)
| If true, do not set the key if it already exists | +| `nx` | 
boolean (false)
| If `true`, do not set the key if it already exists | | `px` | 
integer
| Adds an expiration delay to the key, in milliseconds | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | -| `xx` | 
boolean (false)
| If true, sets the key only if it already exists | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| `xx` | 
boolean (false)
| If `true`, sets the key only if it already exists | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | Note: the `ex` and `px` options are mutually exclusive; setting both options ends up in a `BadRequestError` error. Same thing goes for `nx` and `xx`. diff --git a/doc/7/controllers/ms/setex/index.md b/doc/7/controllers/ms/setex/index.md index 239c83543..a8a35731b 100644 --- a/doc/7/controllers/ms/setex/index.md +++ b/doc/7/controllers/ms/setex/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/setnx/index.md b/doc/7/controllers/ms/setnx/index.md index d1babbb69..fade40776 100644 --- a/doc/7/controllers/ms/setnx/index.md +++ b/doc/7/controllers/ms/setnx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sinter/index.md b/doc/7/controllers/ms/sinter/index.md index 5c439a2f1..6cebd0ded 100644 --- a/doc/7/controllers/ms/sinter/index.md +++ b/doc/7/controllers/ms/sinter/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sinterstore/index.md b/doc/7/controllers/ms/sinterstore/index.md index 1299b6d77..b4abdcf26 100644 --- a/doc/7/controllers/ms/sinterstore/index.md +++ b/doc/7/controllers/ms/sinterstore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sismember/index.md b/doc/7/controllers/ms/sismember/index.md index dee827912..06909e8c6 100644 --- a/doc/7/controllers/ms/sismember/index.md +++ b/doc/7/controllers/ms/sismember/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/smembers/index.md b/doc/7/controllers/ms/smembers/index.md index d1273c0d0..de559c7c7 100644 --- a/doc/7/controllers/ms/smembers/index.md +++ b/doc/7/controllers/ms/smembers/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/smove/index.md b/doc/7/controllers/ms/smove/index.md index 942d77bd6..4ac8da5de 100644 --- a/doc/7/controllers/ms/smove/index.md +++ b/doc/7/controllers/ms/smove/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sort/index.md b/doc/7/controllers/ms/sort/index.md index e3641baa8..3f8373807 100644 --- a/doc/7/controllers/ms/sort/index.md +++ b/doc/7/controllers/ms/sort/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | `direction` | 
string ('ASC')
| Sorts in ascendant or descendant order.
Allowed values: `ASC`, `DESC` | | `get` | 
string[]
| Instead of returning the sorted values directly, returns the values contained in external keys, using patterns completed by the sorted values | | `limit` | 
integer[]
| Limits the result set to a range of matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[, ]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/spop/index.md b/doc/7/controllers/ms/spop/index.md index d54920635..70ca9c420 100644 --- a/doc/7/controllers/ms/spop/index.md +++ b/doc/7/controllers/ms/spop/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (1)
| The number of elements to pop | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/srandmember/index.md b/doc/7/controllers/ms/srandmember/index.md index 60bae2c1c..e4648e403 100644 --- a/doc/7/controllers/ms/srandmember/index.md +++ b/doc/7/controllers/ms/srandmember/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `integer (1)` | If positive, returns `count` elements at random from the set, without repetition.
If negative, returns `abs(count)` elements, and the same element can be chosen multiple times | -| `queuable` | `boolean (true)` | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | `boolean (true)` | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/srem/index.md b/doc/7/controllers/ms/srem/index.md index d88c22c69..497af9517 100644 --- a/doc/7/controllers/ms/srem/index.md +++ b/doc/7/controllers/ms/srem/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sscan/index.md b/doc/7/controllers/ms/sscan/index.md index a862588a9..127e56d30 100644 --- a/doc/7/controllers/ms/sscan/index.md +++ b/doc/7/controllers/ms/sscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/strlen/index.md b/doc/7/controllers/ms/strlen/index.md index f08e8a8aa..735660163 100644 --- a/doc/7/controllers/ms/strlen/index.md +++ b/doc/7/controllers/ms/strlen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sunion/index.md b/doc/7/controllers/ms/sunion/index.md index d7e68457f..e13c53c62 100644 --- a/doc/7/controllers/ms/sunion/index.md +++ b/doc/7/controllers/ms/sunion/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sunionstore/index.md b/doc/7/controllers/ms/sunionstore/index.md index 7557d9759..08accfab0 100644 --- a/doc/7/controllers/ms/sunionstore/index.md +++ b/doc/7/controllers/ms/sunionstore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/time/index.md b/doc/7/controllers/ms/time/index.md index e3ec5552d..b7b691ec8 100644 --- a/doc/7/controllers/ms/time/index.md +++ b/doc/7/controllers/ms/time/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/touch/index.md b/doc/7/controllers/ms/touch/index.md index da004fb23..1b727e0bb 100644 --- a/doc/7/controllers/ms/touch/index.md +++ b/doc/7/controllers/ms/touch/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ttl/index.md b/doc/7/controllers/ms/ttl/index.md index d9340adeb..24ae85d6c 100644 --- a/doc/7/controllers/ms/ttl/index.md +++ b/doc/7/controllers/ms/ttl/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/type/index.md b/doc/7/controllers/ms/type/index.md index c055f6eac..e3392bd55 100644 --- a/doc/7/controllers/ms/type/index.md +++ b/doc/7/controllers/ms/type/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zadd/index.md b/doc/7/controllers/ms/zadd/index.md index 58bad292e..a66947ab7 100644 --- a/doc/7/controllers/ms/zadd/index.md +++ b/doc/7/controllers/ms/zadd/index.md @@ -45,11 +45,13 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ch` | 
boolean (false)
| If true, instead of returning the number of added elements, returns the number of changes performed | -| `incr` | 
boolean (false)
| If true, instead of adding elements, increments the existing member with the provided `score`. Only one element can be specified if this option is set | -| `nx` | 
boolean (false)
| If true, only adds new elements, without altering existing ones | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | -| `xx` | 
boolean (false)
| If true, ignores new elements, alters only existing ones | +| `ch` | 
boolean (false)
| If `true`, instead of returning the number of added elements, returns the number of changes performed | +| `incr` | 
boolean (false)
| If `true`, instead of adding elements, increments the existing member with the provided `score`. Only one element can be specified if this option is set | +| `nx` | 
boolean (false)
| If `true`, only adds new elements, without altering existing ones | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | +| `xx` | 
boolean (false)
| If `true`, ignores new elements, alters only existing ones | ## Resolve diff --git a/doc/7/controllers/ms/zcard/index.md b/doc/7/controllers/ms/zcard/index.md index ad9afa03d..96bfd374f 100644 --- a/doc/7/controllers/ms/zcard/index.md +++ b/doc/7/controllers/ms/zcard/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zcount/index.md b/doc/7/controllers/ms/zcount/index.md index 388156a2d..c450655f3 100644 --- a/doc/7/controllers/ms/zcount/index.md +++ b/doc/7/controllers/ms/zcount/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zincrby/index.md b/doc/7/controllers/ms/zincrby/index.md index 53e502d86..69c302c3b 100644 --- a/doc/7/controllers/ms/zincrby/index.md +++ b/doc/7/controllers/ms/zincrby/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zinterstore/index.md b/doc/7/controllers/ms/zinterstore/index.md index 800e26f73..98f8b87b7 100644 --- a/doc/7/controllers/ms/zinterstore/index.md +++ b/doc/7/controllers/ms/zinterstore/index.md @@ -31,7 +31,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | | `aggregate` | 
string ("sum")
| Specifies how members' scores are aggregated during the intersection.
Allowed values: `min`, `max`, `sum` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (`true`)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + | `weights` | 
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | ## Resolve diff --git a/doc/7/controllers/ms/zlexcount/index.md b/doc/7/controllers/ms/zlexcount/index.md index a3e3a8cf2..127d91be5 100644 --- a/doc/7/controllers/ms/zlexcount/index.md +++ b/doc/7/controllers/ms/zlexcount/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrange/index.md b/doc/7/controllers/ms/zrange/index.md index b0f3d3d75..f0419dbbb 100644 --- a/doc/7/controllers/ms/zrange/index.md +++ b/doc/7/controllers/ms/zrange/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrangebylex/index.md b/doc/7/controllers/ms/zrangebylex/index.md index d33aa47c7..cbc509204 100644 --- a/doc/7/controllers/ms/zrangebylex/index.md +++ b/doc/7/controllers/ms/zrangebylex/index.md @@ -34,7 +34,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrangebyscore/index.md b/doc/7/controllers/ms/zrangebyscore/index.md index 4a796e21b..6b5e16ac3 100644 --- a/doc/7/controllers/ms/zrangebyscore/index.md +++ b/doc/7/controllers/ms/zrangebyscore/index.md @@ -36,7 +36,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrank/index.md b/doc/7/controllers/ms/zrank/index.md index ae68b82de..1231fefb2 100644 --- a/doc/7/controllers/ms/zrank/index.md +++ b/doc/7/controllers/ms/zrank/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrem/index.md b/doc/7/controllers/ms/zrem/index.md index 1778ca68d..15df369ba 100644 --- a/doc/7/controllers/ms/zrem/index.md +++ b/doc/7/controllers/ms/zrem/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebylex/index.md b/doc/7/controllers/ms/zremrangebylex/index.md index e73a28459..14b9ec3e5 100644 --- a/doc/7/controllers/ms/zremrangebylex/index.md +++ b/doc/7/controllers/ms/zremrangebylex/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebyrank/index.md b/doc/7/controllers/ms/zremrangebyrank/index.md index c2b8b7dad..8e2cf1a18 100644 --- a/doc/7/controllers/ms/zremrangebyrank/index.md +++ b/doc/7/controllers/ms/zremrangebyrank/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebyscore/index.md b/doc/7/controllers/ms/zremrangebyscore/index.md index 51f0ef8fd..bb3a78113 100644 --- a/doc/7/controllers/ms/zremrangebyscore/index.md +++ b/doc/7/controllers/ms/zremrangebyscore/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrange/index.md b/doc/7/controllers/ms/zrevrange/index.md index 02a84c22a..ab1e58536 100644 --- a/doc/7/controllers/ms/zrevrange/index.md +++ b/doc/7/controllers/ms/zrevrange/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrangebylex/index.md b/doc/7/controllers/ms/zrevrangebylex/index.md index c8917508f..aa7a1f74b 100644 --- a/doc/7/controllers/ms/zrevrangebylex/index.md +++ b/doc/7/controllers/ms/zrevrangebylex/index.md @@ -34,7 +34,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrevrangebyscore/index.md b/doc/7/controllers/ms/zrevrangebyscore/index.md index fbf095f38..5d5ecaa27 100644 --- a/doc/7/controllers/ms/zrevrangebyscore/index.md +++ b/doc/7/controllers/ms/zrevrangebyscore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrank/index.md b/doc/7/controllers/ms/zrevrank/index.md index 312aa3a41..33903fdcf 100644 --- a/doc/7/controllers/ms/zrevrank/index.md +++ b/doc/7/controllers/ms/zrevrank/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zscan/index.md b/doc/7/controllers/ms/zscan/index.md index 78be305d6..b59d4a7fb 100644 --- a/doc/7/controllers/ms/zscan/index.md +++ b/doc/7/controllers/ms/zscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zscore/index.md b/doc/7/controllers/ms/zscore/index.md index 707d9535f..fa74f48a6 100644 --- a/doc/7/controllers/ms/zscore/index.md +++ b/doc/7/controllers/ms/zscore/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zunionstore/index.md b/doc/7/controllers/ms/zunionstore/index.md index fb5e5693c..0f8f83676 100644 --- a/doc/7/controllers/ms/zunionstore/index.md +++ b/doc/7/controllers/ms/zunionstore/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | | `aggregate` | 
string ("sum")
| Specifies how members' scores are aggregated during the intersection.
Allowed values: `min`, `max`, `sum` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (`true`)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `weights` | 
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | ## Resolve diff --git a/doc/7/controllers/realtime/count/index.md b/doc/7/controllers/realtime/count/index.md index e86d81681..e9802ead6 100644 --- a/doc/7/controllers/realtime/count/index.md +++ b/doc/7/controllers/realtime/count/index.md @@ -29,7 +29,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/publish/index.md b/doc/7/controllers/realtime/publish/index.md index 68d864673..85d1f32ac 100644 --- a/doc/7/controllers/realtime/publish/index.md +++ b/doc/7/controllers/realtime/publish/index.md @@ -35,7 +35,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/subscribe/index.md b/doc/7/controllers/realtime/subscribe/index.md index 69ebdc5fb..c98997aae 100644 --- a/doc/7/controllers/realtime/subscribe/index.md +++ b/doc/7/controllers/realtime/subscribe/index.md @@ -40,7 +40,8 @@ Additional subscription options. | `users` | 
string

(`none`) | Subscribe to users entering or leaving the room
Possible values: `all`, `in`, `out`, `none` | | `subscribeToSelf` | 
boolean

(`true`) | Subscribe to notifications fired by our own queries | | `volatile` | 
object

(`null`) | subscription information, used in [user join/leave notifications](/core/2/guides/main-concepts/api#volatile-data) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/unsubscribe/index.md b/doc/7/controllers/realtime/unsubscribe/index.md index b5bd12f57..3c2897838 100644 --- a/doc/7/controllers/realtime/unsubscribe/index.md +++ b/doc/7/controllers/realtime/unsubscribe/index.md @@ -29,7 +29,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
bool

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/check-rights/index.md b/doc/7/controllers/security/check-rights/index.md index 9aa6c0a2d..531c48646 100644 --- a/doc/7/controllers/security/check-rights/index.md +++ b/doc/7/controllers/security/check-rights/index.md @@ -14,7 +14,7 @@ Checks if the provided API request can be executed by a user. --- ```js -checkRights(kuid, requestPayload) +checkRights(kuid, requestPayload, [options]) ``` | Property | Type | Description | @@ -30,6 +30,15 @@ The [RequestPayload](/core/2/api/payloads/request) must contains at least the fo - `action`: API action --- +### options + +Additional query options + +| Option | Type
(default) | Description | +| ---------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `queuable` | 
bool

(`true`) | Make this request queuable or not | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-api-key/index.md b/doc/7/controllers/security/create-api-key/index.md index 75060c716..0bf23a65d 100644 --- a/doc/7/controllers/security/create-api-key/index.md +++ b/doc/7/controllers/security/create-api-key/index.md @@ -36,6 +36,9 @@ Additional query options | `expiresIn` | 
string/number

(`-1`) | Expiration duration | | `_id` | 
string

(`null`) | API key unique ID | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
bool

(`true`) | Make this request queuable or not | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | **Notes**: - `expiresIn`: diff --git a/doc/7/controllers/security/create-credentials/index.md b/doc/7/controllers/security/create-credentials/index.md index 05bcbf901..de79643a9 100644 --- a/doc/7/controllers/security/create-credentials/index.md +++ b/doc/7/controllers/security/create-credentials/index.md @@ -43,8 +43,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials are indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-first-admin/index.md b/doc/7/controllers/security/create-first-admin/index.md index 9bca3637d..2274935f6 100644 --- a/doc/7/controllers/security/create-first-admin/index.md +++ b/doc/7/controllers/security/create-first-admin/index.md @@ -54,8 +54,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `reset` | 
boolean

(`false`) | If true, restricted permissions are applied to `anonymous` and `default` roles | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `reset` | 
boolean

(`false`) | If `true`, restricted permissions are applied to `anonymous` and `default` roles | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-or-replace-profile/index.md b/doc/7/controllers/security/create-or-replace-profile/index.md index 4fbcf1cd3..02c501c2a 100644 --- a/doc/7/controllers/security/create-or-replace-profile/index.md +++ b/doc/7/controllers/security/create-or-replace-profile/index.md @@ -33,8 +33,10 @@ createOrReplaceProfile(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created/replaced profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-or-replace-role/index.md b/doc/7/controllers/security/create-or-replace-role/index.md index 037a5709e..d458944a3 100644 --- a/doc/7/controllers/security/create-or-replace-role/index.md +++ b/doc/7/controllers/security/create-or-replace-role/index.md @@ -33,7 +33,9 @@ createOrReplaceRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created/replaced role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, creates or replaces the role even if it gives access to non-existent plugins API routes. | diff --git a/doc/7/controllers/security/create-profile/index.md b/doc/7/controllers/security/create-profile/index.md index 2129ae5e2..96800ad55 100644 --- a/doc/7/controllers/security/create-profile/index.md +++ b/doc/7/controllers/security/create-profile/index.md @@ -27,8 +27,10 @@ createProfile(id, profile, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-restricted-user/index.md b/doc/7/controllers/security/create-restricted-user/index.md index 05a500627..6c1ab018a 100644 --- a/doc/7/controllers/security/create-restricted-user/index.md +++ b/doc/7/controllers/security/create-restricted-user/index.md @@ -58,9 +58,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the user is indexed | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-role/index.md b/doc/7/controllers/security/create-role/index.md index 93c99c35a..9ea716314 100644 --- a/doc/7/controllers/security/create-role/index.md +++ b/doc/7/controllers/security/create-role/index.md @@ -33,10 +33,11 @@ createRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, creates the role even if it gives access to non-existent plugins API routes | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-user/index.md b/doc/7/controllers/security/create-user/index.md index 185d8548c..650c0a7d4 100644 --- a/doc/7/controllers/security/create-user/index.md +++ b/doc/7/controllers/security/create-user/index.md @@ -61,8 +61,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-api-key/index.md b/doc/7/controllers/security/delete-api-key/index.md index 9664e2b2e..eaa7f6b24 100644 --- a/doc/7/controllers/security/delete-api-key/index.md +++ b/doc/7/controllers/security/delete-api-key/index.md @@ -34,7 +34,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | - +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves Resolves if the API key is successfully deleted. diff --git a/doc/7/controllers/security/delete-credentials/index.md b/doc/7/controllers/security/delete-credentials/index.md index ffac9f9d1..d2512c2ce 100644 --- a/doc/7/controllers/security/delete-credentials/index.md +++ b/doc/7/controllers/security/delete-credentials/index.md @@ -29,8 +29,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-profile/index.md b/doc/7/controllers/security/delete-profile/index.md index 6a1536d8e..db3574835 100644 --- a/doc/7/controllers/security/delete-profile/index.md +++ b/doc/7/controllers/security/delete-profile/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the profile deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-role/index.md b/doc/7/controllers/security/delete-role/index.md index 8e8ca35e9..f9e8d0a83 100644 --- a/doc/7/controllers/security/delete-role/index.md +++ b/doc/7/controllers/security/delete-role/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the role deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-user/index.md b/doc/7/controllers/security/delete-user/index.md index a1bf0a4f1..f0f25511c 100644 --- a/doc/7/controllers/security/delete-user/index.md +++ b/doc/7/controllers/security/delete-user/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the user deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-all-credential-fields/index.md b/doc/7/controllers/security/get-all-credential-fields/index.md index cfcb427e2..3e84b3a0b 100644 --- a/doc/7/controllers/security/get-all-credential-fields/index.md +++ b/doc/7/controllers/security/get-all-credential-fields/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credential-fields/index.md b/doc/7/controllers/security/get-credential-fields/index.md index a91223303..fae52852f 100644 --- a/doc/7/controllers/security/get-credential-fields/index.md +++ b/doc/7/controllers/security/get-credential-fields/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credentials-by-id/index.md b/doc/7/controllers/security/get-credentials-by-id/index.md index cc10ce88a..4fd30afff 100644 --- a/doc/7/controllers/security/get-credentials-by-id/index.md +++ b/doc/7/controllers/security/get-credentials-by-id/index.md @@ -34,7 +34,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credentials/index.md b/doc/7/controllers/security/get-credentials/index.md index 54c5b2fd4..73e056fea 100644 --- a/doc/7/controllers/security/get-credentials/index.md +++ b/doc/7/controllers/security/get-credentials/index.md @@ -29,7 +29,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile-mapping/index.md b/doc/7/controllers/security/get-profile-mapping/index.md index 41d88029e..20d1d3e4b 100644 --- a/doc/7/controllers/security/get-profile-mapping/index.md +++ b/doc/7/controllers/security/get-profile-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile-rights/index.md b/doc/7/controllers/security/get-profile-rights/index.md index e28c3c6e8..5170575c1 100644 --- a/doc/7/controllers/security/get-profile-rights/index.md +++ b/doc/7/controllers/security/get-profile-rights/index.md @@ -26,7 +26,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile/index.md b/doc/7/controllers/security/get-profile/index.md index 684967633..b9c383c0c 100644 --- a/doc/7/controllers/security/get-profile/index.md +++ b/doc/7/controllers/security/get-profile/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-role-mapping/index.md b/doc/7/controllers/security/get-role-mapping/index.md index a7153991b..8b77af997 100644 --- a/doc/7/controllers/security/get-role-mapping/index.md +++ b/doc/7/controllers/security/get-role-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-role/index.md b/doc/7/controllers/security/get-role/index.md index 1a83680cd..7ba64f541 100644 --- a/doc/7/controllers/security/get-role/index.md +++ b/doc/7/controllers/security/get-role/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-mapping/index.md b/doc/7/controllers/security/get-user-mapping/index.md index 786ccdf90..d69ca2a89 100644 --- a/doc/7/controllers/security/get-user-mapping/index.md +++ b/doc/7/controllers/security/get-user-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-rights/index.md b/doc/7/controllers/security/get-user-rights/index.md index 052f294b6..b58b32547 100644 --- a/doc/7/controllers/security/get-user-rights/index.md +++ b/doc/7/controllers/security/get-user-rights/index.md @@ -26,7 +26,9 @@ getUserRights(kui, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-strategies/index.md b/doc/7/controllers/security/get-user-strategies/index.md index 7d26ff02e..b3bdf6596 100644 --- a/doc/7/controllers/security/get-user-strategies/index.md +++ b/doc/7/controllers/security/get-user-strategies/index.md @@ -29,7 +29,9 @@ getUserStrategies(kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user/index.md b/doc/7/controllers/security/get-user/index.md index 1c5a0988c..cf711d82c 100644 --- a/doc/7/controllers/security/get-user/index.md +++ b/doc/7/controllers/security/get-user/index.md @@ -26,7 +26,9 @@ getUser(kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/has-credentials/index.md b/doc/7/controllers/security/has-credentials/index.md index 72cb74532..616f7ed48 100644 --- a/doc/7/controllers/security/has-credentials/index.md +++ b/doc/7/controllers/security/has-credentials/index.md @@ -27,7 +27,9 @@ hasCredentials(strategy, kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-profiles/index.md b/doc/7/controllers/security/m-delete-profiles/index.md index 1a91f61e1..70e9127f9 100644 --- a/doc/7/controllers/security/m-delete-profiles/index.md +++ b/doc/7/controllers/security/m-delete-profiles/index.md @@ -28,8 +28,10 @@ mDeleteProfiles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the profiles deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-roles/index.md b/doc/7/controllers/security/m-delete-roles/index.md index 77dd59675..a61be11ed 100644 --- a/doc/7/controllers/security/m-delete-roles/index.md +++ b/doc/7/controllers/security/m-delete-roles/index.md @@ -28,8 +28,10 @@ mDeleteRoles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the roles deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-users/index.md b/doc/7/controllers/security/m-delete-users/index.md index a584780e9..d781ee91c 100644 --- a/doc/7/controllers/security/m-delete-users/index.md +++ b/doc/7/controllers/security/m-delete-users/index.md @@ -28,8 +28,10 @@ mDeleteUsers(kuids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the users deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-profiles/index.md b/doc/7/controllers/security/m-get-profiles/index.md index d67c76954..b1673ced2 100644 --- a/doc/7/controllers/security/m-get-profiles/index.md +++ b/doc/7/controllers/security/m-get-profiles/index.md @@ -26,7 +26,9 @@ mGetProfiles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-roles/index.md b/doc/7/controllers/security/m-get-roles/index.md index d29c19c94..b255ce6f7 100644 --- a/doc/7/controllers/security/m-get-roles/index.md +++ b/doc/7/controllers/security/m-get-roles/index.md @@ -26,7 +26,9 @@ mGetRoles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-users/index.md b/doc/7/controllers/security/m-get-users/index.md index 6a64c2989..f173b7b02 100644 --- a/doc/7/controllers/security/m-get-users/index.md +++ b/doc/7/controllers/security/m-get-users/index.md @@ -26,7 +26,9 @@ mGetUsers(kuids, [options]); | Property | Type | Description | | --- | --- | --- | -| `queuable` | 
boolean
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `verb` | 
string
| (HTTP only) Forces the verb of the API route | #### verb diff --git a/doc/7/controllers/security/replace-user/index.md b/doc/7/controllers/security/replace-user/index.md index 67b138571..01e099d40 100644 --- a/doc/7/controllers/security/replace-user/index.md +++ b/doc/7/controllers/security/replace-user/index.md @@ -50,8 +50,10 @@ example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-api-keys/index.md b/doc/7/controllers/security/search-api-keys/index.md index 15e78e685..ee61129d4 100644 --- a/doc/7/controllers/security/search-api-keys/index.md +++ b/doc/7/controllers/security/search-api-keys/index.md @@ -51,6 +51,8 @@ Additional query options | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-profiles/index.md b/doc/7/controllers/security/search-profiles/index.md index 07c614c99..22459c038 100644 --- a/doc/7/controllers/security/search-profiles/index.md +++ b/doc/7/controllers/security/search-profiles/index.md @@ -42,11 +42,13 @@ If the body is left empty, the result will return all available profiles. | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-roles/index.md b/doc/7/controllers/security/search-roles/index.md index a737bd203..6bba15109 100644 --- a/doc/7/controllers/security/search-roles/index.md +++ b/doc/7/controllers/security/search-roles/index.md @@ -32,9 +32,11 @@ searchRoles([body], [options]); | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-users/index.md b/doc/7/controllers/security/search-users/index.md index 40ef7ae74..e89ee124a 100644 --- a/doc/7/controllers/security/search-users/index.md +++ b/doc/7/controllers/security/search-users/index.md @@ -41,11 +41,13 @@ If left empty, the result will return all available users. | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-credentials/index.md b/doc/7/controllers/security/update-credentials/index.md index ceb56cef7..10aa31fdf 100644 --- a/doc/7/controllers/security/update-credentials/index.md +++ b/doc/7/controllers/security/update-credentials/index.md @@ -43,8 +43,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials are indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-profile-mapping/index.md b/doc/7/controllers/security/update-profile-mapping/index.md index 290080f0c..76a7a9caa 100644 --- a/doc/7/controllers/security/update-profile-mapping/index.md +++ b/doc/7/controllers/security/update-profile-mapping/index.md @@ -26,7 +26,9 @@ updateProfileMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-profile/index.md b/doc/7/controllers/security/update-profile/index.md index a314cd334..bcd769ac5 100644 --- a/doc/7/controllers/security/update-profile/index.md +++ b/doc/7/controllers/security/update-profile/index.md @@ -27,8 +27,10 @@ updateProfile(id, profile, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-role-mapping/index.md b/doc/7/controllers/security/update-role-mapping/index.md index 1ba7e49e0..1b9068771 100644 --- a/doc/7/controllers/security/update-role-mapping/index.md +++ b/doc/7/controllers/security/update-role-mapping/index.md @@ -26,7 +26,9 @@ updateRoleMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-role/index.md b/doc/7/controllers/security/update-role/index.md index d13ffcb2e..549fd7cf7 100644 --- a/doc/7/controllers/security/update-role/index.md +++ b/doc/7/controllers/security/update-role/index.md @@ -35,9 +35,11 @@ updateRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the updated role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, updates the role even if it gives access to non-existent plugins API routes | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-user-mapping/index.md b/doc/7/controllers/security/update-user-mapping/index.md index 5504daff5..7199a2de2 100644 --- a/doc/7/controllers/security/update-user-mapping/index.md +++ b/doc/7/controllers/security/update-user-mapping/index.md @@ -26,7 +26,9 @@ updateUserMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-user/index.md b/doc/7/controllers/security/update-user/index.md index 1c5d3753b..83d0351b8 100644 --- a/doc/7/controllers/security/update-user/index.md +++ b/doc/7/controllers/security/update-user/index.md @@ -45,8 +45,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the updated user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/validate-credentials/index.md b/doc/7/controllers/security/validate-credentials/index.md index d677e8a3b..4b93a772a 100644 --- a/doc/7/controllers/security/validate-credentials/index.md +++ b/doc/7/controllers/security/validate-credentials/index.md @@ -43,7 +43,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/server/admin-exists/index.md b/doc/7/controllers/server/admin-exists/index.md index 4f3c814f9..8f046d400 100644 --- a/doc/7/controllers/server/admin-exists/index.md +++ b/doc/7/controllers/server/admin-exists/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-all-stats/index.md b/doc/7/controllers/server/get-all-stats/index.md index a808d44d5..b7998624d 100644 --- a/doc/7/controllers/server/get-all-stats/index.md +++ b/doc/7/controllers/server/get-all-stats/index.md @@ -35,7 +35,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-config/index.md b/doc/7/controllers/server/get-config/index.md index f1820d340..e3917ae8c 100644 --- a/doc/7/controllers/server/get-config/index.md +++ b/doc/7/controllers/server/get-config/index.md @@ -31,7 +31,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-last-stats/index.md b/doc/7/controllers/server/get-last-stats/index.md index 4b2343fc9..bbf7c68ca 100644 --- a/doc/7/controllers/server/get-last-stats/index.md +++ b/doc/7/controllers/server/get-last-stats/index.md @@ -36,7 +36,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-stats/index.md b/doc/7/controllers/server/get-stats/index.md index d30996d00..3ddb73c11 100644 --- a/doc/7/controllers/server/get-stats/index.md +++ b/doc/7/controllers/server/get-stats/index.md @@ -37,7 +37,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/info/index.md b/doc/7/controllers/server/info/index.md index 182f32649..9a204a648 100644 --- a/doc/7/controllers/server/info/index.md +++ b/doc/7/controllers/server/info/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/now/index.md b/doc/7/controllers/server/now/index.md index 9a2ad4777..1ee758b65 100644 --- a/doc/7/controllers/server/now/index.md +++ b/doc/7/controllers/server/now/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/core-classes/base-controller/query/index.md b/doc/7/core-classes/base-controller/query/index.md index 97f2924fd..436664c27 100644 --- a/doc/7/core-classes/base-controller/query/index.md +++ b/doc/7/core-classes/base-controller/query/index.md @@ -50,7 +50,7 @@ Additional query options | Property | Type
(default) | Description | | -------------- | --------- | ------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | ## Resolves diff --git a/doc/7/core-classes/kuzzle/query/index.md b/doc/7/core-classes/kuzzle/query/index.md index ca5830f55..708122ceb 100644 --- a/doc/7/core-classes/kuzzle/query/index.md +++ b/doc/7/core-classes/kuzzle/query/index.md @@ -48,13 +48,19 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### timeout ::: warn The **timeout** option can only be used to prevent the SDK from being frozen if Kuzzle take too long to resolve a request, this will not prevent the request from being executed and Kuzzle will still resolve it at some point. +#### triggerEvents + +::: warn + The **triggerEvents** option can only be used to prevent the EmbededSDK from escaping events such as a pipe or a hook. Use it can lead to infinite loop if used wrongly. (ex: a pipe on document creation that create a document that triggers same pipe again and again) + ## Resolves Resolve to the raw Kuzzle API response. See the [API Documentation](/core/2/api). From adaf4e962671faac2c252d1169a6c332205dc7aa Mon Sep 17 00:00:00 2001 From: Thomas Mauran Date: Tue, 15 Oct 2024 15:41:48 +0200 Subject: [PATCH 12/29] fix: eslint --- package-lock.json | 1724 ++++++++++++++++++++++++++++++++++++++++++--- package.json | 5 + 2 files changed, 1642 insertions(+), 87 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6fae67b87..3fedbf3f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,7 +26,12 @@ "buffer": "^6.0.3", "cucumber": "^6.0.5", "cz-conventional-changelog": "^3.3.0", + "eslint-plugin-html": "^8.1.2", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-kuzzle": "^0.0.6", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^7.1.0", + "eslint-plugin-standard": "^5.0.0", "https-browserify": "^1.0.0", "lodash": "^4.17.21", "lolex": "^6.0.0", @@ -3029,6 +3034,13 @@ "node": ">=12" } }, + "node_modules/@rtsao/scc": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz", + "integrity": "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==", + "dev": true, + "license": "MIT" + }, "node_modules/@semantic-release/changelog": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/@semantic-release/changelog/-/changelog-6.0.3.tgz", @@ -3674,6 +3686,13 @@ "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==", "dev": true }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/mdast": { "version": "3.0.12", "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-3.0.12.tgz", @@ -4394,12 +4413,50 @@ "dev": true, "peer": true }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/array-ify": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/array-ify/-/array-ify-1.0.0.tgz", "integrity": "sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng==", "dev": true }, + "node_modules/array-includes": { + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/array-union": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", @@ -4409,6 +4466,88 @@ "node": ">=8" } }, + "node_modules/array.prototype.findlastindex": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/arrify": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", @@ -4456,6 +4595,22 @@ "node": ">= 4.0.0" } }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/babel-loader": { "version": "8.3.0", "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-8.3.0.tgz", @@ -4745,6 +4900,26 @@ "node": ">=8" } }, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -5512,6 +5687,60 @@ "node": ">=8" } }, + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/dateformat": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz", @@ -5621,6 +5850,42 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/deprecation": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", @@ -5679,6 +5944,65 @@ "node": ">=6.0.0" } }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "dev": true, + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "BSD-2-Clause" + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.1.0.tgz", + "integrity": "sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, "node_modules/dot-prop": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.3.0.tgz", @@ -5797,6 +6121,19 @@ "node": ">=8.6" } }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/env-ci": { "version": "9.1.1", "resolved": "https://registry.npmjs.org/env-ci/-/env-ci-9.1.1.tgz", @@ -5917,44 +6254,184 @@ "stackframe": "^1.3.4" } }, + "node_modules/es-abstract": { + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", + "es-to-primitive": "^1.2.1", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.3", + "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", + "is-weakref": "^1.0.2", + "object-inspect": "^1.13.1", + "object-keys": "^1.1.1", + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/es-module-lexer": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.2.1.tgz", "integrity": "sha512-9978wrXM50Y4rTMmW5kXIC09ZdXQZqkE4mxhwkd8VbzsGkXGPgV4zWuqQJgCEzYngdo2dYDa0l8xhX4fkSwJSg==", "dev": true }, - "node_modules/es5-ext": { - "version": "0.10.62", - "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.62.tgz", - "integrity": "sha512-BHLqn0klhEpnOKSrzn/Xsz2UIW8j+cGmo9JLzr8BiUapV8hPL9+FliFqjwr9ngW7jWdnxv6eO+/LqyhJVqgrjA==", + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", "dev": true, - "hasInstallScript": true, + "license": "MIT", "dependencies": { - "es6-iterator": "^2.0.3", - "es6-symbol": "^3.1.3", - "next-tick": "^1.1.0" + "es-errors": "^1.3.0" }, "engines": { - "node": ">=0.10" + "node": ">= 0.4" } }, - "node_modules/es6-error": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/es6-error/-/es6-error-4.1.1.tgz", - "integrity": "sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg==", - "dev": true - }, - "node_modules/es6-iterator": { + "node_modules/es-set-tostringtag": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/es6-iterator/-/es6-iterator-2.0.3.tgz", - "integrity": "sha512-zw4SRzoUkd+cl+ZoE15A9o1oQd920Bb0iOJMQkQhl3jNc03YqVjAhG7scf9C5KWRU/R13Orf588uCC6525o02g==", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", "dev": true, + "license": "MIT", "dependencies": { - "d": "1", - "es5-ext": "^0.10.35", - "es6-symbol": "^3.1.1" - } - }, + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.0" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es5-ext": { + "version": "0.10.62", + "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.62.tgz", + "integrity": "sha512-BHLqn0klhEpnOKSrzn/Xsz2UIW8j+cGmo9JLzr8BiUapV8hPL9+FliFqjwr9ngW7jWdnxv6eO+/LqyhJVqgrjA==", + "dev": true, + "hasInstallScript": true, + "dependencies": { + "es6-iterator": "^2.0.3", + "es6-symbol": "^3.1.3", + "next-tick": "^1.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/es6-error": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/es6-error/-/es6-error-4.1.1.tgz", + "integrity": "sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg==", + "dev": true + }, + "node_modules/es6-iterator": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es6-iterator/-/es6-iterator-2.0.3.tgz", + "integrity": "sha512-zw4SRzoUkd+cl+ZoE15A9o1oQd920Bb0iOJMQkQhl3jNc03YqVjAhG7scf9C5KWRU/R13Orf588uCC6525o02g==", + "dev": true, + "dependencies": { + "d": "1", + "es5-ext": "^0.10.35", + "es6-symbol": "^3.1.1" + } + }, "node_modules/es6-symbol": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/es6-symbol/-/es6-symbol-3.1.3.tgz", @@ -6040,6 +6517,146 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", + "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7", + "is-core-module": "^2.13.0", + "resolve": "^1.22.4" + } + }, + "node_modules/eslint-import-resolver-node/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.12.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz", + "integrity": "sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7" + }, + "engines": { + "node": ">=4" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + } + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-html": { + "version": "8.1.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-html/-/eslint-plugin-html-8.1.2.tgz", + "integrity": "sha512-pbRchDV2SmqbCi/Ev/q3aAikzG9BcFe0IjjqjtMn8eTLq71ZUggyJB6CDmuwGAXmYZHrXI12XTfCqvgcnPRqGw==", + "dev": true, + "license": "ISC", + "dependencies": { + "htmlparser2": "^9.1.0" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/eslint-plugin-import": { + "version": "2.31.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz", + "integrity": "sha512-ixmkI62Rbc2/w8Vfxyh1jQRTdRTF52VxwRVHl/ykPAmqG+Nb7/kNn+byLP0LxPgI7zWA16Jt82SybJInmMia3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rtsao/scc": "^1.1.0", + "array-includes": "^3.1.8", + "array.prototype.findlastindex": "^1.2.5", + "array.prototype.flat": "^1.3.2", + "array.prototype.flatmap": "^1.3.2", + "debug": "^3.2.7", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.9", + "eslint-module-utils": "^2.12.0", + "hasown": "^2.0.2", + "is-core-module": "^2.15.1", + "is-glob": "^4.0.3", + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.8", + "object.groupby": "^1.0.3", + "object.values": "^1.2.0", + "semver": "^6.3.1", + "string.prototype.trimend": "^1.0.8", + "tsconfig-paths": "^3.15.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9" + } + }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/eslint-plugin-kuzzle": { "version": "0.0.6", "resolved": "https://registry.npmjs.org/eslint-plugin-kuzzle/-/eslint-plugin-kuzzle-0.0.6.tgz", @@ -6053,6 +6670,27 @@ "prettier": "^2.7.1" } }, + "node_modules/eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "peerDependencies": { + "eslint": ">=5.16.0" + } + }, "node_modules/eslint-plugin-prettier": { "version": "4.2.1", "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-4.2.1.tgz", @@ -6074,6 +6712,47 @@ } } }, + "node_modules/eslint-plugin-promise": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-7.1.0.tgz", + "integrity": "sha512-8trNmPxdAy3W620WKDpaS65NlM5yAumod6XeC4LOb+jxlkG4IVcp68c6dXY2ev+uT4U1PtG57YDV6EGAXN0GbQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/eslint-plugin-standard": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-standard/-/eslint-plugin-standard-5.0.0.tgz", + "integrity": "sha512-eSIXPc9wBM4BrniMzJRBm2uoVuXz2EPa+NXPk2+itrVt+r5SbKFERx/IgrK/HmfjddyKVz2f+j+7gBRvu19xLg==", + "deprecated": "standard 16.0.0 and eslint-config-standard 16.0.0 no longer require the eslint-plugin-standard package. You can remove it from your dependencies with 'npm rm eslint-plugin-standard'. More info here: https://github.com/standard/standard/issues/1316", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "peerDependencies": { + "eslint": ">=5.0.0" + } + }, "node_modules/eslint-scope": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", @@ -6749,6 +7428,16 @@ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", "dev": true }, + "node_modules/for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.3" + } + }, "node_modules/foreground-child": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-2.0.0.tgz", @@ -6864,10 +7553,33 @@ } }, "node_modules/function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/functional-red-black-tree": { "version": "1.0.1", @@ -6875,6 +7587,16 @@ "integrity": "sha512-dsKNQNdj6xA3T+QlADDA7mOSlX0qiMINjn0cgr+eGHGsbSHzTabcIogz2+p/iqP1Xs6EP/sS2SbqH+brGTbq0g==", "dev": true }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -6890,6 +7612,26 @@ "integrity": "sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==", "dev": true }, + "node_modules/get-intrinsic": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/get-package-type": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", @@ -6911,6 +7653,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/get-symbol-description": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/gherkin": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/gherkin/-/gherkin-5.0.0.tgz", @@ -7084,6 +7844,23 @@ "node": ">=4" } }, + "node_modules/globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -7104,6 +7881,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", @@ -7146,16 +7936,14 @@ "node": ">=6" } }, - "node_modules/has": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", - "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "node_modules/has-bigints": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", "dev": true, - "dependencies": { - "function-bind": "^1.1.1" - }, - "engines": { - "node": ">= 0.4.0" + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/has-flag": { @@ -7167,6 +7955,61 @@ "node": ">=4" } }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/hasha": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/hasha/-/hasha-5.2.2.tgz", @@ -7183,6 +8026,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/he": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", @@ -7238,12 +8094,32 @@ "node": "14 || >=16.14" } }, - "node_modules/html-escaper": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "dev": true - }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true + }, + "node_modules/htmlparser2": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-9.1.0.tgz", + "integrity": "sha512-5zfg6mHUoaer/97TxnGpxmbR7zJtPwIYFMZ/H5ucTlPZhKvtum05yiPK3Mgai3a0DyVxv7qYqoweaEd2nrYQzQ==", + "dev": true, + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.1.0", + "entities": "^4.5.0" + } + }, "node_modules/https-browserify": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/https-browserify/-/https-browserify-1.0.0.tgz", @@ -7507,6 +8383,21 @@ "node": ">=8" } }, + "node_modules/internal-slot": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.0", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/interpret": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/interpret/-/interpret-2.2.0.tgz", @@ -7556,12 +8447,42 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-arrayish": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", "dev": true }, + "node_modules/is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-binary-path": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", @@ -7574,6 +8495,23 @@ "node": ">=8" } }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-buffer": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz", @@ -7597,13 +8535,62 @@ "node": ">=4" } }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-core-module": { - "version": "2.12.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.12.0.tgz", - "integrity": "sha512-RECHCBCd/viahWmwj6enj19sKbHfJrddi/6cBDsNTKbNq0f7VeaUkBo60BqzvPqo/W54ChS62Z5qyun7cfOMqQ==", + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", "dev": true, + "license": "MIT", "dependencies": { - "has": "^1.0.3" + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -7674,6 +8661,19 @@ "node": ">=8" } }, + "node_modules/is-negative-zero": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", @@ -7683,6 +8683,22 @@ "node": ">=0.12.0" } }, + "node_modules/is-number-object": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-obj": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", @@ -7731,6 +8747,39 @@ "node": ">=0.10.0" } }, + "node_modules/is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-stream": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", @@ -7743,6 +8792,38 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-text-path": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-text-path/-/is-text-path-2.0.0.tgz", @@ -7755,6 +8836,22 @@ "node": ">=8" } }, + "node_modules/is-typed-array": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "which-typed-array": "^1.1.14" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-typedarray": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", @@ -7779,6 +8876,19 @@ "integrity": "sha512-rMYPYvCzsXywIsldgLaSoPlw5PfoB/ssr7hY4pLfcodrA5M/eArza1a9VmTiNIBNMjOGr1Ow9mTyU2o69U6U9Q==", "dev": true }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", @@ -13247,54 +14357,148 @@ "node": ">=8" } }, - "node_modules/nyc/node_modules/y18n": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", - "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", - "dev": true - }, - "node_modules/nyc/node_modules/yargs": { - "version": "15.4.1", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-15.4.1.tgz", - "integrity": "sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A==", + "node_modules/nyc/node_modules/y18n": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", + "dev": true + }, + "node_modules/nyc/node_modules/yargs": { + "version": "15.4.1", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-15.4.1.tgz", + "integrity": "sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A==", + "dev": true, + "dependencies": { + "cliui": "^6.0.0", + "decamelize": "^1.2.0", + "find-up": "^4.1.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^4.2.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^18.1.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nyc/node_modules/yargs-parser": { + "version": "18.1.3", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-18.1.3.tgz", + "integrity": "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==", + "dev": true, + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz", + "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, + "license": "MIT", "dependencies": { - "cliui": "^6.0.0", - "decamelize": "^1.2.0", - "find-up": "^4.1.0", - "get-caller-file": "^2.0.1", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^4.2.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^18.1.2" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" }, "engines": { - "node": ">=8" + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/nyc/node_modules/yargs-parser": { - "version": "18.1.3", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-18.1.3.tgz", - "integrity": "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==", + "node_modules/object.groupby": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", "dev": true, + "license": "MIT", "dependencies": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" }, "engines": { - "node": ">=6" + "node": ">= 0.4" } }, - "node_modules/object-assign": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "node_modules/object.values": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, "engines": { - "node": ">=0.10.0" + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/once": { @@ -13937,6 +15141,16 @@ "node": ">=8" } }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -14433,6 +15647,25 @@ "@babel/runtime": "^7.8.4" } }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.3", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.3.tgz", + "integrity": "sha512-vqlC04+RQoFalODCbCumG2xIOvapzVMHwsyIGM/SIE8fRhFFsXeH8/QQ+s0T0kDAhKc4k30s73/0ydkHQz6HlQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/regexpp": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", @@ -14588,12 +15821,13 @@ "dev": true }, "node_modules/resolve": { - "version": "1.22.2", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.2.tgz", - "integrity": "sha512-Sb+mjNHOULsBv818T40qSPeRiuWLyaGMa5ewydRLFimneixmVy2zdivRl+AF6jaYPC8ERxGDmFSiqui6SfPd+g==", + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", "dev": true, + "license": "MIT", "dependencies": { - "is-core-module": "^2.11.0", + "is-core-module": "^2.13.0", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -15069,6 +16303,32 @@ "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", "dev": true }, + "node_modules/safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "engines": { + "node": ">=0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-array-concat/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", @@ -15089,6 +16349,24 @@ } ] }, + "node_modules/safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -15420,10 +16698,11 @@ } }, "node_modules/semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", "dev": true, + "license": "ISC", "bin": { "semver": "bin/semver.js" } @@ -15529,6 +16808,40 @@ "integrity": "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw==", "dev": true }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/shallow-clone": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", @@ -15625,6 +16938,25 @@ "integrity": "sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g==", "dev": true }, + "node_modules/side-channel": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -16067,6 +17399,58 @@ "node": ">=4" } }, + "node_modules/string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", @@ -16637,6 +18021,42 @@ } } }, + "node_modules/tsconfig-paths": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", + "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.2", + "minimist": "^1.2.6", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tsconfig-paths/node_modules/json5": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/tsconfig-paths/node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, "node_modules/tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", @@ -16694,6 +18114,83 @@ "node": ">=8" } }, + "node_modules/typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/typedarray-to-buffer": { "version": "3.1.5", "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", @@ -16729,6 +18226,22 @@ "node": ">=0.8.0" } }, + "node_modules/unbox-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/unicode-canonical-property-names-ecmascript": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", @@ -17234,12 +18747,49 @@ "node": ">= 8" } }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", "integrity": "sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q==", "dev": true }, + "node_modules/which-typed-array": { + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/wildcard": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.0.tgz", diff --git a/package.json b/package.json index d1e83fcb9..818225d05 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,12 @@ "buffer": "^6.0.3", "cucumber": "^6.0.5", "cz-conventional-changelog": "^3.3.0", + "eslint-plugin-html": "^8.1.2", + "eslint-plugin-import": "^2.31.0", "eslint-plugin-kuzzle": "^0.0.6", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^7.1.0", + "eslint-plugin-standard": "^5.0.0", "https-browserify": "^1.0.0", "lodash": "^4.17.21", "lolex": "^6.0.0", From 0aa42224e0684bed46c14b4810d0e210b3df1ec2 Mon Sep 17 00:00:00 2001 From: Cyril Nguyen Date: Wed, 16 Oct 2024 09:43:36 +0200 Subject: [PATCH 13/29] feat: add options parameter to controller functions containing a query --- src/controllers/Auth.ts | 12 +++++++++--- src/controllers/Security.ts | 6 ++++-- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/src/controllers/Auth.ts b/src/controllers/Auth.ts index 8aedf6c2b..b2053c710 100644 --- a/src/controllers/Auth.ts +++ b/src/controllers/Auth.ts @@ -437,7 +437,8 @@ export class AuthController extends BaseController { login( strategy: string, credentials: JSONObject, - expiresIn?: string | number + expiresIn?: string | number, + options: ArgsAuthControllerLogin = {} ): Promise { const request = { action: "login", @@ -448,7 +449,7 @@ export class AuthController extends BaseController { }; this.kuzzle.emit("beforeLogin"); - return this.query(request, { queuable: false, timeout: -1, verb: "POST" }) + return this.query(request, { queuable: false, timeout: -1, verb: "POST", ...options }) .then((response) => { if (this.kuzzle.cookieAuthentication) { if (response.result.jwt) { @@ -497,13 +498,14 @@ export class AuthController extends BaseController { * * @see https://docs.kuzzle.io/sdk/js/7/controllers/auth/logout */ - async logout(): Promise { + async logout(options: ArgsAuthControllerLogin = {}): Promise { this.kuzzle.emit("beforeLogout"); try { await this.query( { action: "logout", cookieAuth: this.kuzzle.cookieAuthentication, + ...options }, { queuable: false, timeout: -1 } ); @@ -700,6 +702,10 @@ export type ArgsAuthControllerUpdateSelf = ArgsDefault; export type ArgsAuthControllerValidateMyCredentials = ArgsDefault; +export type ArgsAuthControllerLogin = ArgsDefault; + +export type ArgsAuthControllerLogout = ArgsDefault; + export interface ArgsAuthControllerRefreshToken extends ArgsDefault { expiresIn?: number | string; } diff --git a/src/controllers/Security.ts b/src/controllers/Security.ts index b2d63c8b2..9bc836145 100644 --- a/src/controllers/Security.ts +++ b/src/controllers/Security.ts @@ -515,11 +515,11 @@ export class SecurityController extends BaseController { ); } - refresh(collection) { + refresh(collection, options: ArgsSecurityControllerRefresh = {}) { return this.query({ action: "refresh", collection, - }); + }, options); } replaceUser(_id, body, options: ArgsSecurityControllerReplaceUser = {}) { @@ -809,3 +809,5 @@ export type ArgsSecurityControllerUpdateUser = ArgsDefault; export type ArgsSecurityControllerUpdateUserMapping = ArgsDefault; export type ArgsSecurityControllerValidateCredentials = ArgsDefault; + +export type ArgsSecurityControllerRefresh = ArgsDefault; From 4acefe8bef54d92d4417bbfd7618fe02dbf04a89 Mon Sep 17 00:00:00 2001 From: Cyril Nguyen Date: Wed, 16 Oct 2024 09:48:35 +0200 Subject: [PATCH 14/29] style: format document to pass linter --- src/controllers/Auth.ts | 9 +++++++-- src/controllers/Security.ts | 11 +++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/controllers/Auth.ts b/src/controllers/Auth.ts index b2053c710..01033d175 100644 --- a/src/controllers/Auth.ts +++ b/src/controllers/Auth.ts @@ -449,7 +449,12 @@ export class AuthController extends BaseController { }; this.kuzzle.emit("beforeLogin"); - return this.query(request, { queuable: false, timeout: -1, verb: "POST", ...options }) + return this.query(request, { + queuable: false, + timeout: -1, + verb: "POST", + ...options, + }) .then((response) => { if (this.kuzzle.cookieAuthentication) { if (response.result.jwt) { @@ -505,7 +510,7 @@ export class AuthController extends BaseController { { action: "logout", cookieAuth: this.kuzzle.cookieAuthentication, - ...options + ...options, }, { queuable: false, timeout: -1 } ); diff --git a/src/controllers/Security.ts b/src/controllers/Security.ts index 9bc836145..6a8323378 100644 --- a/src/controllers/Security.ts +++ b/src/controllers/Security.ts @@ -516,10 +516,13 @@ export class SecurityController extends BaseController { } refresh(collection, options: ArgsSecurityControllerRefresh = {}) { - return this.query({ - action: "refresh", - collection, - }, options); + return this.query( + { + action: "refresh", + collection, + }, + options + ); } replaceUser(_id, body, options: ArgsSecurityControllerReplaceUser = {}) { From d193eda82f7ccc8ef155f32a872fa0a27057dc49 Mon Sep 17 00:00:00 2001 From: Cyril Nguyen Date: Wed, 16 Oct 2024 16:56:16 +0200 Subject: [PATCH 15/29] fix: change options in the right object --- src/controllers/Auth.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/controllers/Auth.ts b/src/controllers/Auth.ts index 01033d175..47581faf4 100644 --- a/src/controllers/Auth.ts +++ b/src/controllers/Auth.ts @@ -510,9 +510,8 @@ export class AuthController extends BaseController { { action: "logout", cookieAuth: this.kuzzle.cookieAuthentication, - ...options, }, - { queuable: false, timeout: -1 } + { queuable: false, timeout: -1, ...options } ); this._authenticationToken = null; /** From 83d7ba90056cae304106a70540bf549715d07c24 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 15:15:46 +0100 Subject: [PATCH 16/29] ci(ci): update version inside tests files --- .ci/doc/docker-compose.yml | 2 - .ci/docker-compose.yml | 2 - .github/workflows/pull_request.workflow.yml | 102 ++++++------------ .../check-token/snippets/check-token.test.yml | 2 +- .../snippets/create-my-credentials.test.yml | 2 +- .../snippets/credentials-exist.test.yml | 2 +- .../snippets/delete-my-credentials.test.yml | 2 +- .../snippets/get-current-user.test.yml | 2 +- .../snippets/get-my-credentials.test.yml | 2 +- .../snippets/get-my-rights.test.yml | 2 +- .../snippets/get-strategies.test.yml | 2 +- .../auth/login/snippets/login.test.yml | 2 +- .../auth/logout/snippets/logout.test.yml | 2 +- .../snippets/refreshToken.test.yml | 2 +- .../snippets/update-my-credentials.test.yml | 2 +- .../update-self/snippets/update-self.test.yml | 2 +- .../snippets/validate-my-credentials.test.yml | 2 +- .../create/snippets/create.test.yml | 2 +- .../snippets/delete-specifications.test.yml | 2 +- .../exists/snippets/exists.test.yml | 2 +- .../collection/list/snippets/list.test.yml | 2 +- .../snippets/search-specifications.test.yml | 2 +- .../truncate/snippets/truncate.test.yml | 2 +- .../snippets/update-mapping.test.yml | 2 +- .../snippets/validate-specifications.test.yml | 2 +- .../index/delete/snippets/delete.test.yml | 2 +- .../index/m-delete/snippets/mDelete.test.yml | 2 +- .../ms/append/snippets/append.test.yml | 2 +- .../ms/bitcount/snippets/bitcount.test.yml | 2 +- .../ms/bitop/snippets/bitop.test.yml | 2 +- .../ms/bitpos/snippets/bitpos.test.yml | 2 +- .../ms/dbsize/snippets/dbsize.test.yml | 2 +- .../ms/decr/snippets/decr.test.yml | 2 +- .../ms/decrby/snippets/decrby.test.yml | 2 +- .../controllers/ms/del/snippets/del.test.yml | 2 +- .../ms/exists/snippets/exists.test.yml | 2 +- .../ms/expire/snippets/expire.test.yml | 2 +- .../ms/expireat/snippets/expireat.test.yml | 2 +- .../ms/flushdb/snippets/flushdb.test.yml | 2 +- .../ms/geoadd/snippets/geoadd.test.yml | 2 +- .../ms/geodist/snippets/geodist.test.yml | 2 +- .../ms/geohash/snippets/geohash.test.yml | 2 +- .../ms/geopos/snippets/geopos.test.yml | 2 +- .../ms/georadius/snippets/georadius.test.yml | 2 +- .../snippets/georadiusbymember.test.yml | 2 +- .../controllers/ms/get/snippets/get.test.yml | 2 +- .../ms/getbit/snippets/getbit.test.yml | 2 +- .../ms/getrange/snippets/getrange.test.yml | 2 +- .../ms/getset/snippets/getset.test.yml | 2 +- .../ms/hdel/snippets/hdel.test.yml | 2 +- .../ms/hexists/snippets/hexists.test.yml | 2 +- .../ms/hget/snippets/hget.test.yml | 2 +- .../ms/hgetall/snippets/hgetall.test.yml | 2 +- .../ms/hincrby/snippets/hincrby.test.yml | 2 +- .../snippets/hincrbyfloat.test.yml | 2 +- .../ms/hkeys/snippets/hkeys.test.yml | 2 +- .../ms/hlen/snippets/hlen.test.yml | 2 +- .../ms/hmget/snippets/hmget.test.yml | 2 +- .../ms/hmset/snippets/hmset.test.yml | 2 +- .../ms/hscan/snippets/hscan.test.yml | 2 +- .../ms/hset/snippets/hset.test.yml | 2 +- .../ms/hsetnx/snippets/hsetnx.test.yml | 2 +- .../ms/hstrlen/snippets/hstrlen.test.yml | 2 +- .../ms/hvals/snippets/hvals.test.yml | 2 +- .../ms/incr/snippets/incr.test.yml | 2 +- .../ms/incrby/snippets/incrby.test.yml | 2 +- .../incrbyfloat/snippets/incrbyfloat.test.yml | 2 +- .../ms/keys/snippets/keys.test.yml | 2 +- .../ms/lindex/snippets/lindex.test.yml | 2 +- .../ms/linsert/snippets/linsert.test.yml | 2 +- .../ms/llen/snippets/llen.test.yml | 2 +- .../ms/lpop/snippets/lpop.test.yml | 2 +- .../ms/lpush/snippets/lpush.test.yml | 2 +- .../ms/lpushx/snippets/lpushx.test.yml | 2 +- .../ms/lrange/snippets/lrange.test.yml | 2 +- .../ms/lrem/snippets/lrem.test.yml | 2 +- .../ms/lset/snippets/lset.test.yml | 2 +- .../ms/ltrim/snippets/ltrim.test.yml | 2 +- .../ms/mget/snippets/mget.test.yml | 2 +- .../ms/mset/snippets/mset.test.yml | 2 +- .../ms/msetnx/snippets/msetnx.test.yml | 2 +- .../ms/object/snippets/object.test.yml | 2 +- .../ms/persist/snippets/persist.test.yml | 2 +- .../ms/pexpire/snippets/pexpire.test.yml | 2 +- .../ms/pexpireat/snippets/pexpireat.test.yml | 2 +- .../ms/pfadd/snippets/pfadd.test.yml | 2 +- .../ms/pfcount/snippets/pfcount.test.yml | 2 +- .../ms/pfmerge/snippets/pfmerge.test.yml | 2 +- .../ms/ping/snippets/ping.test.yml | 2 +- .../ms/psetex/snippets/psetex.test.yml | 2 +- .../ms/pttl/snippets/pttl.test.yml | 2 +- .../ms/randomkey/snippets/randomkey.test.yml | 2 +- .../ms/rename/snippets/rename.test.yml | 2 +- .../ms/renamenx/snippets/renamenx.test.yml | 2 +- .../ms/rpop/snippets/rpop.test.yml | 2 +- .../ms/rpoplpush/snippets/rpoplpush.test.yml | 2 +- .../ms/rpush/snippets/rpush.test.yml | 2 +- .../ms/rpushx/snippets/rpushx.test.yml | 2 +- .../ms/sadd/snippets/sadd.test.yml | 2 +- .../ms/scan/snippets/scan.test.yml | 2 +- .../ms/scard/snippets/scard.test.yml | 2 +- .../ms/sdiff/snippets/sdiff.test.yml | 2 +- .../sdiffstore/snippets/sdiffstore.test.yml | 2 +- .../controllers/ms/set/snippets/set.test.yml | 2 +- .../ms/setex/snippets/setex.test.yml | 2 +- .../ms/setnx/snippets/setnx.test.yml | 2 +- .../ms/sinter/snippets/sinter.test.yml | 2 +- .../sinterstore/snippets/sinterstore.test.yml | 2 +- .../ms/sismember/snippets/sismember.test.yml | 2 +- .../ms/smembers/snippets/smembers.test.yml | 2 +- .../ms/smove/snippets/smove.test.yml | 2 +- .../ms/sort/snippets/sort.test.yml | 2 +- .../ms/spop/snippets/spop.test.yml | 2 +- .../srandmember/snippets/srandmember.test.yml | 2 +- .../ms/srem/snippets/srem.test.yml | 2 +- .../ms/sscan/snippets/sscan.test.yml | 2 +- .../ms/strlen/snippets/strlen.test.yml | 2 +- .../ms/sunion/snippets/sunion.test.yml | 2 +- .../sunionstore/snippets/sunionstore.test.yml | 2 +- .../ms/time/snippets/time.test.yml | 2 +- .../ms/touch/snippets/touch.test.yml | 2 +- .../controllers/ms/ttl/snippets/ttl.test.yml | 2 +- .../ms/type/snippets/type.test.yml | 2 +- .../ms/zadd/snippets/zadd.test.yml | 2 +- .../ms/zcard/snippets/zcard.test.yml | 2 +- .../ms/zcount/snippets/zcount.test.yml | 2 +- .../ms/zincrby/snippets/zincrby.test.yml | 2 +- .../zinterstore/snippets/zinterstore.test.yml | 2 +- .../ms/zlexcount/snippets/zlexcount.test.yml | 2 +- .../ms/zrange/snippets/zrange.test.yml | 2 +- .../zrangebylex/snippets/zrangebylex.test.yml | 2 +- .../snippets/zrangebyscore.test.yml | 2 +- .../ms/zrank/snippets/zrank.test.yml | 2 +- .../ms/zrem/snippets/zrem.test.yml | 2 +- .../snippets/zremrangebylex.test.yml | 2 +- .../snippets/zremrangebyrank.test.yml | 2 +- .../snippets/zremrangebyscore.test.yml | 2 +- .../ms/zrevrange/snippets/zrevrange.test.yml | 2 +- .../snippets/zrevrangebylex.test.yml | 2 +- .../snippets/zrevrangebyscore.test.yml | 2 +- .../ms/zrevrank/snippets/zrevrank.test.yml | 2 +- .../ms/zscan/snippets/zscan.test.yml | 2 +- .../ms/zscore/snippets/zscore.test.yml | 2 +- .../zunionstore/snippets/zunionstore.test.yml | 2 +- .../realtime/count/snippets/count.test.yml | 2 +- .../publish/snippets/publish.test.yml | 2 +- ...ocument-notifications-leave-scope.test.yml | 2 +- .../snippets/document-notifications.test.yml | 2 +- .../snippets/message-notifications.test.yml | 2 +- .../snippets/user-notifications.test.yml | 2 +- .../unsubscribe/snippets/unsubscribe.test.yml | 2 +- .../snippets/admin-exists.test.yml | 2 +- .../snippets/add-listener.test.yml | 2 +- .../snippets/add-once-listener.test.yml | 2 +- .../emit/snippets/emit.test.yml | 2 +- .../listeners/snippets/listeners.test.yml | 2 +- .../snippets/prepend-listener.test.yml | 2 +- .../snippets/prepend-once-listener.test.yml | 2 +- .../snippets/remove-all-listeners.test.yml | 2 +- .../snippets/remove-listener.test.yml | 2 +- .../kuzzle/connect/snippets/connect.test.yml | 2 +- .../constructor/snippets/constructor.test.yml | 2 +- .../disconnect/snippets/disconnect.test.yml | 2 +- .../flush-queue/snippets/flush-queue.test.yml | 2 +- .../play-queue/snippets/play-queue.test.yml | 2 +- .../kuzzle/query/snippets/query.test.yml | 2 +- .../snippets/start-queuing.test.yml | 2 +- .../snippets/stop-queuing.test.yml | 2 +- .../snippets/use-controller.test.yml | 2 +- .../getRoles/snippets/getRoles.test.yml | 2 +- .../next/snippets/fromsize.test.yml | 2 +- .../next/snippets/scroll.test.yml | 2 +- .../getProfiles/snippets/getProfiles.test.yml | 2 +- .../snippets/error-handling.test.yml | 2 +- .../node-js/snippets/create.test.yml | 2 +- .../node-js/snippets/init.test.yml | 2 +- .../node-js/snippets/load-sdk.test.yml | 2 +- .../node-js/snippets/prepare-db.test.yml | 2 +- .../node-js/snippets/subscribe.test.yml | 2 +- .../raw-web/snippets/create.test.yml | 2 +- .../raw-web/snippets/load-sdk.test.yml | 2 +- .../raw-web/snippets/prepare-db.test.yml | 2 +- .../raw-web/snippets/subscribe.test.yml | 2 +- .../webpack/snippets.disabled/create.test.yml | 2 +- .../snippets.disabled/init-kuzzle.test.yml | 2 +- .../snippets.disabled/subscribe.test.yml | 2 +- .../constructor/snippets/constructor.test.yml | 2 +- .../constructor/snippets/constructor.test.yml | 2 +- 188 files changed, 220 insertions(+), 256 deletions(-) diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index 7c9b09c5f..a0c7da7f2 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -1,5 +1,3 @@ -version: '3' - services: kuzzle: image: kuzzleio/kuzzle:2 diff --git a/.ci/docker-compose.yml b/.ci/docker-compose.yml index 745fc6f4e..e5bdca5e3 100644 --- a/.ci/docker-compose.yml +++ b/.ci/docker-compose.yml @@ -1,5 +1,3 @@ -version: '3' - services: kuzzle: image: kuzzleio/kuzzle:2 diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index b5190436a..4c14ecece 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -22,85 +22,53 @@ jobs: ${{ runner.os }}-build-${{ env.cache-name }}- ${{ runner.os }}-build- ${{ runner.os }}- - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - uses: ./.github/actions/es-lint unit-tests: - name: Unit Tests - runs-on: ubuntu-20.04 - needs: [lint] - strategy: + name: Unit Tests + runs-on: ubuntu-20.04 + needs: [lint] + strategy: matrix: node-version: ["16", "18", "20"] - steps: - - uses: actions/checkout@v3 - - name: Cache node modules - uses: actions/cache@v3 - env: - cache-name: cache-node-modules - with: - path: ~/.npm - key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-build-${{ env.cache-name }}- - ${{ runner.os }}-build- - ${{ runner.os }}- - - uses: actions/setup-node@v3 - with: - node-version: ${{ matrix.node-version }} - - uses: ./.github/actions/unit-tests + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - uses: ./.github/actions/unit-tests functional-tests: - name: Functional Tests - runs-on: ubuntu-20.04 - needs: [unit-tests] - strategy: + name: Functional Tests + runs-on: ubuntu-20.04 + needs: [unit-tests] + strategy: matrix: node-version: ["16", "18", "20"] - steps: - - uses: actions/checkout@v3 - with: - submodules: 'recursive' - - name: Cache node modules - uses: actions/cache@v3 - env: - cache-name: cache-node-modules - with: - path: ~/.npm - key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-build-${{ env.cache-name }}- - ${{ runner.os }}-build- - ${{ runner.os }}- - - uses: actions/setup-node@v3 - with: - node-version: ${{ matrix.node-version }} - - uses: ./.github/actions/functional-tests - with: + steps: + - uses: actions/checkout@v3 + with: + submodules: "recursive" + - uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - uses: ./.github/actions/functional-tests + with: CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }} documentation-snippet-tests: - name: Documentation Snippet Tests - needs: [unit-tests] - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v3 - - name: Cache node modules - uses: actions/cache@v3 - env: - cache-name: cache-node-modules - with: - path: ~/.npm - key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-build-${{ env.cache-name }}- - ${{ runner.os }}-build- - ${{ runner.os }}- - - uses: actions/setup-node@v3 - with: - node-version: '20' - - uses: ./.github/actions/snippet-tests - with: + name: Documentation Snippet Tests + needs: [unit-tests] + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v3 + - name: Cache node modules + - uses: actions/setup-node@v4 + with: + node-version: "20" + - uses: ./.github/actions/snippet-tests + with: CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }} diff --git a/doc/7/controllers/auth/check-token/snippets/check-token.test.yml b/doc/7/controllers/auth/check-token/snippets/check-token.test.yml index 1e603a0d7..5211c7b29 100644 --- a/doc/7/controllers/auth/check-token/snippets/check-token.test.yml +++ b/doc/7/controllers/auth/check-token/snippets/check-token.test.yml @@ -8,4 +8,4 @@ template: default expected: Token is valid sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml b/doc/7/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml index fe731bd48..1ad92feb8 100644 --- a/doc/7/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml +++ b/doc/7/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml @@ -7,4 +7,4 @@ template: catch expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml b/doc/7/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml index a1e62d66d..4a327f498 100644 --- a/doc/7/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml +++ b/doc/7/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml @@ -7,4 +7,4 @@ template: default expected: Credentials exist sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml b/doc/7/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml index 2b5b741ae..082e9cde7 100644 --- a/doc/7/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml +++ b/doc/7/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml @@ -7,4 +7,4 @@ template: default expected: Credentials successfully deleted sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/get-current-user/snippets/get-current-user.test.yml b/doc/7/controllers/auth/get-current-user/snippets/get-current-user.test.yml index dc3dcf93f..1d7d8ffd0 100644 --- a/doc/7/controllers/auth/get-current-user/snippets/get-current-user.test.yml +++ b/doc/7/controllers/auth/get-current-user/snippets/get-current-user.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml b/doc/7/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml index e43b7ca38..f5183886a 100644 --- a/doc/7/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml +++ b/doc/7/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml b/doc/7/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml index 059f24813..d5dc36148 100644 --- a/doc/7/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml +++ b/doc/7/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/get-strategies/snippets/get-strategies.test.yml b/doc/7/controllers/auth/get-strategies/snippets/get-strategies.test.yml index 993d67742..a8e5ff520 100644 --- a/doc/7/controllers/auth/get-strategies/snippets/get-strategies.test.yml +++ b/doc/7/controllers/auth/get-strategies/snippets/get-strategies.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/login/snippets/login.test.yml b/doc/7/controllers/auth/login/snippets/login.test.yml index 8c986543f..971dc2481 100644 --- a/doc/7/controllers/auth/login/snippets/login.test.yml +++ b/doc/7/controllers/auth/login/snippets/login.test.yml @@ -8,4 +8,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/logout/snippets/logout.test.yml b/doc/7/controllers/auth/logout/snippets/logout.test.yml index cf6a09c0e..f87ff1fb1 100644 --- a/doc/7/controllers/auth/logout/snippets/logout.test.yml +++ b/doc/7/controllers/auth/logout/snippets/logout.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/refresh-token/snippets/refreshToken.test.yml b/doc/7/controllers/auth/refresh-token/snippets/refreshToken.test.yml index be2ec825c..4e746a804 100644 --- a/doc/7/controllers/auth/refresh-token/snippets/refreshToken.test.yml +++ b/doc/7/controllers/auth/refresh-token/snippets/refreshToken.test.yml @@ -12,4 +12,4 @@ expected: - ^\s*expiresAt: \d+ - ^\s*ttl: \d+ } sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml b/doc/7/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml index 43f5545c9..b1d6a27ef 100644 --- a/doc/7/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml +++ b/doc/7/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/update-self/snippets/update-self.test.yml b/doc/7/controllers/auth/update-self/snippets/update-self.test.yml index ac9007638..ebacfc008 100644 --- a/doc/7/controllers/auth/update-self/snippets/update-self.test.yml +++ b/doc/7/controllers/auth/update-self/snippets/update-self.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml b/doc/7/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml index 0f62e9367..a20cee546 100644 --- a/doc/7/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml +++ b/doc/7/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml @@ -7,4 +7,4 @@ template: default expected: Credentials are valid sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/create/snippets/create.test.yml b/doc/7/controllers/collection/create/snippets/create.test.yml index 15793fcf0..64b363db4 100644 --- a/doc/7/controllers/collection/create/snippets/create.test.yml +++ b/doc/7/controllers/collection/create/snippets/create.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml b/doc/7/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml index 5542ecfe0..eedf0893c 100644 --- a/doc/7/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml +++ b/doc/7/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/exists/snippets/exists.test.yml b/doc/7/controllers/collection/exists/snippets/exists.test.yml index 3c3c4e32d..0314005be 100644 --- a/doc/7/controllers/collection/exists/snippets/exists.test.yml +++ b/doc/7/controllers/collection/exists/snippets/exists.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/list/snippets/list.test.yml b/doc/7/controllers/collection/list/snippets/list.test.yml index 39641aa7b..25d434d83 100644 --- a/doc/7/controllers/collection/list/snippets/list.test.yml +++ b/doc/7/controllers/collection/list/snippets/list.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/search-specifications/snippets/search-specifications.test.yml b/doc/7/controllers/collection/search-specifications/snippets/search-specifications.test.yml index f32b7aa16..cfa6b06cc 100644 --- a/doc/7/controllers/collection/search-specifications/snippets/search-specifications.test.yml +++ b/doc/7/controllers/collection/search-specifications/snippets/search-specifications.test.yml @@ -20,4 +20,4 @@ hooks: template: default expected: 'fetched: 1' sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/truncate/snippets/truncate.test.yml b/doc/7/controllers/collection/truncate/snippets/truncate.test.yml index f34edd066..0a246a470 100644 --- a/doc/7/controllers/collection/truncate/snippets/truncate.test.yml +++ b/doc/7/controllers/collection/truncate/snippets/truncate.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/update-mapping/snippets/update-mapping.test.yml b/doc/7/controllers/collection/update-mapping/snippets/update-mapping.test.yml index 272e5e002..927a13589 100644 --- a/doc/7/controllers/collection/update-mapping/snippets/update-mapping.test.yml +++ b/doc/7/controllers/collection/update-mapping/snippets/update-mapping.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/collection/validate-specifications/snippets/validate-specifications.test.yml b/doc/7/controllers/collection/validate-specifications/snippets/validate-specifications.test.yml index 9f7b8a750..a1ab0d388 100644 --- a/doc/7/controllers/collection/validate-specifications/snippets/validate-specifications.test.yml +++ b/doc/7/controllers/collection/validate-specifications/snippets/validate-specifications.test.yml @@ -7,4 +7,4 @@ template: default expected: Some errors with provided specifications. sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/index/delete/snippets/delete.test.yml b/doc/7/controllers/index/delete/snippets/delete.test.yml index 75385676a..bd2e608a8 100644 --- a/doc/7/controllers/index/delete/snippets/delete.test.yml +++ b/doc/7/controllers/index/delete/snippets/delete.test.yml @@ -8,4 +8,4 @@ template: default expected: Index deleted sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/index/m-delete/snippets/mDelete.test.yml b/doc/7/controllers/index/m-delete/snippets/mDelete.test.yml index 8f9334ad1..36dcbeecf 100644 --- a/doc/7/controllers/index/m-delete/snippets/mDelete.test.yml +++ b/doc/7/controllers/index/m-delete/snippets/mDelete.test.yml @@ -10,4 +10,4 @@ template: default expected: Successfully deleted 2 indexes sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/append/snippets/append.test.yml b/doc/7/controllers/ms/append/snippets/append.test.yml index 1b778932d..f91d970fc 100644 --- a/doc/7/controllers/ms/append/snippets/append.test.yml +++ b/doc/7/controllers/ms/append/snippets/append.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: Hello World sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/bitcount/snippets/bitcount.test.yml b/doc/7/controllers/ms/bitcount/snippets/bitcount.test.yml index 887b5762e..6ef685cde 100644 --- a/doc/7/controllers/ms/bitcount/snippets/bitcount.test.yml +++ b/doc/7/controllers/ms/bitcount/snippets/bitcount.test.yml @@ -8,4 +8,4 @@ expected: - 26 - 4 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/bitop/snippets/bitop.test.yml b/doc/7/controllers/ms/bitop/snippets/bitop.test.yml index 34f2b6513..0ebafc444 100644 --- a/doc/7/controllers/ms/bitop/snippets/bitop.test.yml +++ b/doc/7/controllers/ms/bitop/snippets/bitop.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "`bc`ab" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/bitpos/snippets/bitpos.test.yml b/doc/7/controllers/ms/bitpos/snippets/bitpos.test.yml index 42aa3d157..2c18a9273 100644 --- a/doc/7/controllers/ms/bitpos/snippets/bitpos.test.yml +++ b/doc/7/controllers/ms/bitpos/snippets/bitpos.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: 23 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/dbsize/snippets/dbsize.test.yml b/doc/7/controllers/ms/dbsize/snippets/dbsize.test.yml index 21811fa67..9fa426728 100644 --- a/doc/7/controllers/ms/dbsize/snippets/dbsize.test.yml +++ b/doc/7/controllers/ms/dbsize/snippets/dbsize.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/decr/snippets/decr.test.yml b/doc/7/controllers/ms/decr/snippets/decr.test.yml index f515ac10c..c26ebd180 100644 --- a/doc/7/controllers/ms/decr/snippets/decr.test.yml +++ b/doc/7/controllers/ms/decr/snippets/decr.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: 42 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/decrby/snippets/decrby.test.yml b/doc/7/controllers/ms/decrby/snippets/decrby.test.yml index 63ce294a4..ec212db25 100644 --- a/doc/7/controllers/ms/decrby/snippets/decrby.test.yml +++ b/doc/7/controllers/ms/decrby/snippets/decrby.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: 42 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/del/snippets/del.test.yml b/doc/7/controllers/ms/del/snippets/del.test.yml index fc4ff56b2..ea769247c 100644 --- a/doc/7/controllers/ms/del/snippets/del.test.yml +++ b/doc/7/controllers/ms/del/snippets/del.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: 0 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/exists/snippets/exists.test.yml b/doc/7/controllers/ms/exists/snippets/exists.test.yml index 8c0752b08..4b3bf9793 100644 --- a/doc/7/controllers/ms/exists/snippets/exists.test.yml +++ b/doc/7/controllers/ms/exists/snippets/exists.test.yml @@ -8,4 +8,4 @@ expected: - ^0$ - ^1$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/expire/snippets/expire.test.yml b/doc/7/controllers/ms/expire/snippets/expire.test.yml index fac040455..d37047170 100644 --- a/doc/7/controllers/ms/expire/snippets/expire.test.yml +++ b/doc/7/controllers/ms/expire/snippets/expire.test.yml @@ -8,4 +8,4 @@ expected: - -1 - ^[1-9]+ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/expireat/snippets/expireat.test.yml b/doc/7/controllers/ms/expireat/snippets/expireat.test.yml index 735ea84da..042b8875f 100644 --- a/doc/7/controllers/ms/expireat/snippets/expireat.test.yml +++ b/doc/7/controllers/ms/expireat/snippets/expireat.test.yml @@ -8,4 +8,4 @@ expected: - ^1$ - ^0$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/flushdb/snippets/flushdb.test.yml b/doc/7/controllers/ms/flushdb/snippets/flushdb.test.yml index ae2331836..e0cdd82d7 100644 --- a/doc/7/controllers/ms/flushdb/snippets/flushdb.test.yml +++ b/doc/7/controllers/ms/flushdb/snippets/flushdb.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/geoadd/snippets/geoadd.test.yml b/doc/7/controllers/ms/geoadd/snippets/geoadd.test.yml index ab30f799c..e9d5cffd4 100644 --- a/doc/7/controllers/ms/geoadd/snippets/geoadd.test.yml +++ b/doc/7/controllers/ms/geoadd/snippets/geoadd.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: 2 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/geodist/snippets/geodist.test.yml b/doc/7/controllers/ms/geodist/snippets/geodist.test.yml index 8b97f33bb..4399eec57 100644 --- a/doc/7/controllers/ms/geodist/snippets/geodist.test.yml +++ b/doc/7/controllers/ms/geodist/snippets/geodist.test.yml @@ -8,4 +8,4 @@ expected: - 1367.8521 - 4487.7038 sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/geohash/snippets/geohash.test.yml b/doc/7/controllers/ms/geohash/snippets/geohash.test.yml index a7c97b3d6..8e1a21a46 100644 --- a/doc/7/controllers/ms/geohash/snippets/geohash.test.yml +++ b/doc/7/controllers/ms/geohash/snippets/geohash.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "[ 'spfb0frz6x0', 'spfb09jv9n0' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/geopos/snippets/geopos.test.yml b/doc/7/controllers/ms/geopos/snippets/geopos.test.yml index 08d931fad..16c3f6247 100644 --- a/doc/7/controllers/ms/geopos/snippets/geopos.test.yml +++ b/doc/7/controllers/ms/geopos/snippets/geopos.test.yml @@ -8,4 +8,4 @@ expected: - "\\[ 3.910904824733734, 43.607392252329916 ]," - "\\[ 3.8971075415611267, 43.600221526170145 ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/georadius/snippets/georadius.test.yml b/doc/7/controllers/ms/georadius/snippets/georadius.test.yml index c225d10ae..ca566f463 100644 --- a/doc/7/controllers/ms/georadius/snippets/georadius.test.yml +++ b/doc/7/controllers/ms/georadius/snippets/georadius.test.yml @@ -23,4 +23,4 @@ expected: - "}" - "\\]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml b/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml index aa39d516e..df41ec610 100644 --- a/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml +++ b/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml @@ -23,4 +23,4 @@ expected: - "}" - "\\]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/get/snippets/get.test.yml b/doc/7/controllers/ms/get/snippets/get.test.yml index ede9c73c5..5ed9267b3 100644 --- a/doc/7/controllers/ms/get/snippets/get.test.yml +++ b/doc/7/controllers/ms/get/snippets/get.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: bar sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/getbit/snippets/getbit.test.yml b/doc/7/controllers/ms/getbit/snippets/getbit.test.yml index ea8ca01aa..f8b2495de 100644 --- a/doc/7/controllers/ms/getbit/snippets/getbit.test.yml +++ b/doc/7/controllers/ms/getbit/snippets/getbit.test.yml @@ -8,4 +8,4 @@ expected: - ^0$ - ^1$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/getrange/snippets/getrange.test.yml b/doc/7/controllers/ms/getrange/snippets/getrange.test.yml index 052d7892c..e7ad84f28 100644 --- a/doc/7/controllers/ms/getrange/snippets/getrange.test.yml +++ b/doc/7/controllers/ms/getrange/snippets/getrange.test.yml @@ -8,4 +8,4 @@ expected: - ^oba$ - ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/getset/snippets/getset.test.yml b/doc/7/controllers/ms/getset/snippets/getset.test.yml index 1ae03ae64..4e177063b 100644 --- a/doc/7/controllers/ms/getset/snippets/getset.test.yml +++ b/doc/7/controllers/ms/getset/snippets/getset.test.yml @@ -8,4 +8,4 @@ expected: - ^bar$ - ^qux$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hdel/snippets/hdel.test.yml b/doc/7/controllers/ms/hdel/snippets/hdel.test.yml index b460b4995..148b4e98b 100644 --- a/doc/7/controllers/ms/hdel/snippets/hdel.test.yml +++ b/doc/7/controllers/ms/hdel/snippets/hdel.test.yml @@ -8,4 +8,4 @@ expected: - ^2$ - ^1$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hexists/snippets/hexists.test.yml b/doc/7/controllers/ms/hexists/snippets/hexists.test.yml index 7d599a8f7..9472f8dcd 100644 --- a/doc/7/controllers/ms/hexists/snippets/hexists.test.yml +++ b/doc/7/controllers/ms/hexists/snippets/hexists.test.yml @@ -8,4 +8,4 @@ expected: - ^false$ - ^true$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hget/snippets/hget.test.yml b/doc/7/controllers/ms/hget/snippets/hget.test.yml index d020ee976..836d6ed6b 100644 --- a/doc/7/controllers/ms/hget/snippets/hget.test.yml +++ b/doc/7/controllers/ms/hget/snippets/hget.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hgetall/snippets/hgetall.test.yml b/doc/7/controllers/ms/hgetall/snippets/hgetall.test.yml index 372468a4e..ddd4ede22 100644 --- a/doc/7/controllers/ms/hgetall/snippets/hgetall.test.yml +++ b/doc/7/controllers/ms/hgetall/snippets/hgetall.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "{ field1: 'val1', field2: 'val2' }" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hincrby/snippets/hincrby.test.yml b/doc/7/controllers/ms/hincrby/snippets/hincrby.test.yml index 3fce3c9b1..67add34a4 100644 --- a/doc/7/controllers/ms/hincrby/snippets/hincrby.test.yml +++ b/doc/7/controllers/ms/hincrby/snippets/hincrby.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^42$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hincrbyfloat/snippets/hincrbyfloat.test.yml b/doc/7/controllers/ms/hincrbyfloat/snippets/hincrbyfloat.test.yml index 9fc6064bc..fb44aa110 100644 --- a/doc/7/controllers/ms/hincrbyfloat/snippets/hincrbyfloat.test.yml +++ b/doc/7/controllers/ms/hincrbyfloat/snippets/hincrbyfloat.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3.14159$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hkeys/snippets/hkeys.test.yml b/doc/7/controllers/ms/hkeys/snippets/hkeys.test.yml index 91f00c124..a58eb6373 100644 --- a/doc/7/controllers/ms/hkeys/snippets/hkeys.test.yml +++ b/doc/7/controllers/ms/hkeys/snippets/hkeys.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: \[ 'never', 'gonna', 'give you up' ] sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hlen/snippets/hlen.test.yml b/doc/7/controllers/ms/hlen/snippets/hlen.test.yml index 48c6a46b9..310269bd1 100644 --- a/doc/7/controllers/ms/hlen/snippets/hlen.test.yml +++ b/doc/7/controllers/ms/hlen/snippets/hlen.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hmget/snippets/hmget.test.yml b/doc/7/controllers/ms/hmget/snippets/hmget.test.yml index 3a9848b28..3a9fe86e3 100644 --- a/doc/7/controllers/ms/hmget/snippets/hmget.test.yml +++ b/doc/7/controllers/ms/hmget/snippets/hmget.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: \[ 'val3', 'val1' ] sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hmset/snippets/hmset.test.yml b/doc/7/controllers/ms/hmset/snippets/hmset.test.yml index fbda2f343..db76dc3c6 100644 --- a/doc/7/controllers/ms/hmset/snippets/hmset.test.yml +++ b/doc/7/controllers/ms/hmset/snippets/hmset.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: { key1: 'val1', key2: 'val2', key3: 'val3' } sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hscan/snippets/hscan.test.yml b/doc/7/controllers/ms/hscan/snippets/hscan.test.yml index 82b6ae4fc..7a4a6350a 100644 --- a/doc/7/controllers/ms/hscan/snippets/hscan.test.yml +++ b/doc/7/controllers/ms/hscan/snippets/hscan.test.yml @@ -10,4 +10,4 @@ expected: - "values: \\[ 'key1', 'val1', 'key2', 'val2', 'key3', 'val3' ]" - "}" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hset/snippets/hset.test.yml b/doc/7/controllers/ms/hset/snippets/hset.test.yml index f8f074f45..784c0298c 100644 --- a/doc/7/controllers/ms/hset/snippets/hset.test.yml +++ b/doc/7/controllers/ms/hset/snippets/hset.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "{ foo: 'bar' }" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hsetnx/snippets/hsetnx.test.yml b/doc/7/controllers/ms/hsetnx/snippets/hsetnx.test.yml index 7742ae0c6..098dfd243 100644 --- a/doc/7/controllers/ms/hsetnx/snippets/hsetnx.test.yml +++ b/doc/7/controllers/ms/hsetnx/snippets/hsetnx.test.yml @@ -9,4 +9,4 @@ expected: - ^false$ - ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hstrlen/snippets/hstrlen.test.yml b/doc/7/controllers/ms/hstrlen/snippets/hstrlen.test.yml index ef71bdf52..d6bf484e3 100644 --- a/doc/7/controllers/ms/hstrlen/snippets/hstrlen.test.yml +++ b/doc/7/controllers/ms/hstrlen/snippets/hstrlen.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/hvals/snippets/hvals.test.yml b/doc/7/controllers/ms/hvals/snippets/hvals.test.yml index efe75d69d..1d6bff50d 100644 --- a/doc/7/controllers/ms/hvals/snippets/hvals.test.yml +++ b/doc/7/controllers/ms/hvals/snippets/hvals.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'val1', 'val2', 'val3' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/incr/snippets/incr.test.yml b/doc/7/controllers/ms/incr/snippets/incr.test.yml index 8eb956a22..f9542ffea 100644 --- a/doc/7/controllers/ms/incr/snippets/incr.test.yml +++ b/doc/7/controllers/ms/incr/snippets/incr.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^42$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/incrby/snippets/incrby.test.yml b/doc/7/controllers/ms/incrby/snippets/incrby.test.yml index 66b93f139..1a80c9c01 100644 --- a/doc/7/controllers/ms/incrby/snippets/incrby.test.yml +++ b/doc/7/controllers/ms/incrby/snippets/incrby.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^42$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/incrbyfloat/snippets/incrbyfloat.test.yml b/doc/7/controllers/ms/incrbyfloat/snippets/incrbyfloat.test.yml index f9695c2f5..11fb06e70 100644 --- a/doc/7/controllers/ms/incrbyfloat/snippets/incrbyfloat.test.yml +++ b/doc/7/controllers/ms/incrbyfloat/snippets/incrbyfloat.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3.14159$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/keys/snippets/keys.test.yml b/doc/7/controllers/ms/keys/snippets/keys.test.yml index ec079ebad..7e810e066 100644 --- a/doc/7/controllers/ms/keys/snippets/keys.test.yml +++ b/doc/7/controllers/ms/keys/snippets/keys.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ '(Hello|foo)', '(Hello|foo)' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lindex/snippets/lindex.test.yml b/doc/7/controllers/ms/lindex/snippets/lindex.test.yml index 8abf7ad84..620d61e93 100644 --- a/doc/7/controllers/ms/lindex/snippets/lindex.test.yml +++ b/doc/7/controllers/ms/lindex/snippets/lindex.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/linsert/snippets/linsert.test.yml b/doc/7/controllers/ms/linsert/snippets/linsert.test.yml index ffa21f82c..d350423cb 100644 --- a/doc/7/controllers/ms/linsert/snippets/linsert.test.yml +++ b/doc/7/controllers/ms/linsert/snippets/linsert.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'foo', 'qux', 'bar', 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/llen/snippets/llen.test.yml b/doc/7/controllers/ms/llen/snippets/llen.test.yml index 65112883a..c6c154190 100644 --- a/doc/7/controllers/ms/llen/snippets/llen.test.yml +++ b/doc/7/controllers/ms/llen/snippets/llen.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lpop/snippets/lpop.test.yml b/doc/7/controllers/ms/lpop/snippets/lpop.test.yml index c812c4378..6176d2303 100644 --- a/doc/7/controllers/ms/lpop/snippets/lpop.test.yml +++ b/doc/7/controllers/ms/lpop/snippets/lpop.test.yml @@ -8,4 +8,4 @@ expected: - ^foo$ - "\\[ 'bar', 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lpush/snippets/lpush.test.yml b/doc/7/controllers/ms/lpush/snippets/lpush.test.yml index 0d671ed18..250b73f75 100644 --- a/doc/7/controllers/ms/lpush/snippets/lpush.test.yml +++ b/doc/7/controllers/ms/lpush/snippets/lpush.test.yml @@ -8,4 +8,4 @@ expected: - ^3$ - "\\[ 'Hello', 'World', 'foobar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lpushx/snippets/lpushx.test.yml b/doc/7/controllers/ms/lpushx/snippets/lpushx.test.yml index 029a61412..d18a4feee 100644 --- a/doc/7/controllers/ms/lpushx/snippets/lpushx.test.yml +++ b/doc/7/controllers/ms/lpushx/snippets/lpushx.test.yml @@ -10,4 +10,4 @@ expected: - ^2$ - "\\[ 'foo', 'bar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lrange/snippets/lrange.test.yml b/doc/7/controllers/ms/lrange/snippets/lrange.test.yml index 0c47e421a..8be25064d 100644 --- a/doc/7/controllers/ms/lrange/snippets/lrange.test.yml +++ b/doc/7/controllers/ms/lrange/snippets/lrange.test.yml @@ -8,4 +8,4 @@ expected: - "\\[ 'b', 'c', 'd' ]" - "\\[ 'd', 'e' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lrem/snippets/lrem.test.yml b/doc/7/controllers/ms/lrem/snippets/lrem.test.yml index dd43df76d..d492c7f7b 100644 --- a/doc/7/controllers/ms/lrem/snippets/lrem.test.yml +++ b/doc/7/controllers/ms/lrem/snippets/lrem.test.yml @@ -8,4 +8,4 @@ expected: - ^2$ - "\\[ 'bar', 'baz', 'foo' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/lset/snippets/lset.test.yml b/doc/7/controllers/ms/lset/snippets/lset.test.yml index 8102ca92f..b6f389998 100644 --- a/doc/7/controllers/ms/lset/snippets/lset.test.yml +++ b/doc/7/controllers/ms/lset/snippets/lset.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'foo', 'bar', 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/ltrim/snippets/ltrim.test.yml b/doc/7/controllers/ms/ltrim/snippets/ltrim.test.yml index 96629d68e..1dde32082 100644 --- a/doc/7/controllers/ms/ltrim/snippets/ltrim.test.yml +++ b/doc/7/controllers/ms/ltrim/snippets/ltrim.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'd', 'e' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/mget/snippets/mget.test.yml b/doc/7/controllers/ms/mget/snippets/mget.test.yml index 23195d61f..516621e76 100644 --- a/doc/7/controllers/ms/mget/snippets/mget.test.yml +++ b/doc/7/controllers/ms/mget/snippets/mget.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'world', 'bar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/mset/snippets/mset.test.yml b/doc/7/controllers/ms/mset/snippets/mset.test.yml index 8effcbefc..91d0cac2c 100644 --- a/doc/7/controllers/ms/mset/snippets/mset.test.yml +++ b/doc/7/controllers/ms/mset/snippets/mset.test.yml @@ -8,4 +8,4 @@ expected: - ^0$ - ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/msetnx/snippets/msetnx.test.yml b/doc/7/controllers/ms/msetnx/snippets/msetnx.test.yml index f73ac5b14..72969f01c 100644 --- a/doc/7/controllers/ms/msetnx/snippets/msetnx.test.yml +++ b/doc/7/controllers/ms/msetnx/snippets/msetnx.test.yml @@ -8,4 +8,4 @@ expected: - ^false$ - ^true$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/object/snippets/object.test.yml b/doc/7/controllers/ms/object/snippets/object.test.yml index ec96be4b7..c3661b284 100644 --- a/doc/7/controllers/ms/object/snippets/object.test.yml +++ b/doc/7/controllers/ms/object/snippets/object.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^hashtable$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/persist/snippets/persist.test.yml b/doc/7/controllers/ms/persist/snippets/persist.test.yml index 5a3b014a3..9d12c1fb4 100644 --- a/doc/7/controllers/ms/persist/snippets/persist.test.yml +++ b/doc/7/controllers/ms/persist/snippets/persist.test.yml @@ -8,4 +8,4 @@ expected: - ^[0-9]+$ - "-1" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pexpire/snippets/pexpire.test.yml b/doc/7/controllers/ms/pexpire/snippets/pexpire.test.yml index caf2552ea..80028bff1 100644 --- a/doc/7/controllers/ms/pexpire/snippets/pexpire.test.yml +++ b/doc/7/controllers/ms/pexpire/snippets/pexpire.test.yml @@ -8,4 +8,4 @@ expected: - ^-1$ - ^[0-9]{1,2}$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pexpireat/snippets/pexpireat.test.yml b/doc/7/controllers/ms/pexpireat/snippets/pexpireat.test.yml index d2f23f5e8..382ca4879 100644 --- a/doc/7/controllers/ms/pexpireat/snippets/pexpireat.test.yml +++ b/doc/7/controllers/ms/pexpireat/snippets/pexpireat.test.yml @@ -8,4 +8,4 @@ expected: - ^1$ - ^0$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pfadd/snippets/pfadd.test.yml b/doc/7/controllers/ms/pfadd/snippets/pfadd.test.yml index a471b2507..47d72f9de 100644 --- a/doc/7/controllers/ms/pfadd/snippets/pfadd.test.yml +++ b/doc/7/controllers/ms/pfadd/snippets/pfadd.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^4$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pfcount/snippets/pfcount.test.yml b/doc/7/controllers/ms/pfcount/snippets/pfcount.test.yml index e172ba101..4f4fa8926 100644 --- a/doc/7/controllers/ms/pfcount/snippets/pfcount.test.yml +++ b/doc/7/controllers/ms/pfcount/snippets/pfcount.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^5$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pfmerge/snippets/pfmerge.test.yml b/doc/7/controllers/ms/pfmerge/snippets/pfmerge.test.yml index aa7772bda..1402c2c86 100644 --- a/doc/7/controllers/ms/pfmerge/snippets/pfmerge.test.yml +++ b/doc/7/controllers/ms/pfmerge/snippets/pfmerge.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^5$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/ping/snippets/ping.test.yml b/doc/7/controllers/ms/ping/snippets/ping.test.yml index 2de8803ee..e5e1e2d7a 100644 --- a/doc/7/controllers/ms/ping/snippets/ping.test.yml +++ b/doc/7/controllers/ms/ping/snippets/ping.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^PONG$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/psetex/snippets/psetex.test.yml b/doc/7/controllers/ms/psetex/snippets/psetex.test.yml index e18aafc99..4b237d7e3 100644 --- a/doc/7/controllers/ms/psetex/snippets/psetex.test.yml +++ b/doc/7/controllers/ms/psetex/snippets/psetex.test.yml @@ -8,4 +8,4 @@ expected: - ^[0-9]{1,2}$ - ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/pttl/snippets/pttl.test.yml b/doc/7/controllers/ms/pttl/snippets/pttl.test.yml index f7881e2fd..a780758d2 100644 --- a/doc/7/controllers/ms/pttl/snippets/pttl.test.yml +++ b/doc/7/controllers/ms/pttl/snippets/pttl.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^[0-9]+$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/randomkey/snippets/randomkey.test.yml b/doc/7/controllers/ms/randomkey/snippets/randomkey.test.yml index 93c2f889c..d26e2988d 100644 --- a/doc/7/controllers/ms/randomkey/snippets/randomkey.test.yml +++ b/doc/7/controllers/ms/randomkey/snippets/randomkey.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^(foo|bar|baz)$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/rename/snippets/rename.test.yml b/doc/7/controllers/ms/rename/snippets/rename.test.yml index e11268290..939ccdb91 100644 --- a/doc/7/controllers/ms/rename/snippets/rename.test.yml +++ b/doc/7/controllers/ms/rename/snippets/rename.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^World$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/renamenx/snippets/renamenx.test.yml b/doc/7/controllers/ms/renamenx/snippets/renamenx.test.yml index 737877950..453cfc325 100644 --- a/doc/7/controllers/ms/renamenx/snippets/renamenx.test.yml +++ b/doc/7/controllers/ms/renamenx/snippets/renamenx.test.yml @@ -8,4 +8,4 @@ expected: - ^false$ - ^true$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/rpop/snippets/rpop.test.yml b/doc/7/controllers/ms/rpop/snippets/rpop.test.yml index 77caeb66e..06ea9fa48 100644 --- a/doc/7/controllers/ms/rpop/snippets/rpop.test.yml +++ b/doc/7/controllers/ms/rpop/snippets/rpop.test.yml @@ -8,4 +8,4 @@ expected: - ^baz$ - "\\[ 'foo', 'bar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/rpoplpush/snippets/rpoplpush.test.yml b/doc/7/controllers/ms/rpoplpush/snippets/rpoplpush.test.yml index b41b74666..cc49a9424 100644 --- a/doc/7/controllers/ms/rpoplpush/snippets/rpoplpush.test.yml +++ b/doc/7/controllers/ms/rpoplpush/snippets/rpoplpush.test.yml @@ -8,4 +8,4 @@ expected: - ^never$ - "\\[ 'never', 'gonna', 'give', 'you', 'up' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/rpush/snippets/rpush.test.yml b/doc/7/controllers/ms/rpush/snippets/rpush.test.yml index d68827600..3a91d2574 100644 --- a/doc/7/controllers/ms/rpush/snippets/rpush.test.yml +++ b/doc/7/controllers/ms/rpush/snippets/rpush.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'foo', 'bar', 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/rpushx/snippets/rpushx.test.yml b/doc/7/controllers/ms/rpushx/snippets/rpushx.test.yml index af30e7bb7..f1acb8892 100644 --- a/doc/7/controllers/ms/rpushx/snippets/rpushx.test.yml +++ b/doc/7/controllers/ms/rpushx/snippets/rpushx.test.yml @@ -8,4 +8,4 @@ expected: - ^0$ - ^4$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sadd/snippets/sadd.test.yml b/doc/7/controllers/ms/sadd/snippets/sadd.test.yml index a66e0e5d4..ae7ed6e91 100644 --- a/doc/7/controllers/ms/sadd/snippets/sadd.test.yml +++ b/doc/7/controllers/ms/sadd/snippets/sadd.test.yml @@ -9,4 +9,4 @@ expected: - ^1$ - "\\[ '(foo|bar|baz)', '(foo|bar|baz)', '(foo|bar|baz)' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/scan/snippets/scan.test.yml b/doc/7/controllers/ms/scan/snippets/scan.test.yml index 94f14acf7..1a7c641c2 100644 --- a/doc/7/controllers/ms/scan/snippets/scan.test.yml +++ b/doc/7/controllers/ms/scan/snippets/scan.test.yml @@ -8,4 +8,4 @@ expected: - "{ cursor: '0', values: \\[ 'key[123]', 'key[123]', 'key[123]' ] }" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/scard/snippets/scard.test.yml b/doc/7/controllers/ms/scard/snippets/scard.test.yml index 233e97519..df639e612 100644 --- a/doc/7/controllers/ms/scard/snippets/scard.test.yml +++ b/doc/7/controllers/ms/scard/snippets/scard.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sdiff/snippets/sdiff.test.yml b/doc/7/controllers/ms/sdiff/snippets/sdiff.test.yml index f828fae8b..2f8d3d2c7 100644 --- a/doc/7/controllers/ms/sdiff/snippets/sdiff.test.yml +++ b/doc/7/controllers/ms/sdiff/snippets/sdiff.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sdiffstore/snippets/sdiffstore.test.yml b/doc/7/controllers/ms/sdiffstore/snippets/sdiffstore.test.yml index fdbc89b7f..7dfd2def7 100644 --- a/doc/7/controllers/ms/sdiffstore/snippets/sdiffstore.test.yml +++ b/doc/7/controllers/ms/sdiffstore/snippets/sdiffstore.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/set/snippets/set.test.yml b/doc/7/controllers/ms/set/snippets/set.test.yml index 48ccb56e6..c4fa7bb7b 100644 --- a/doc/7/controllers/ms/set/snippets/set.test.yml +++ b/doc/7/controllers/ms/set/snippets/set.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/setex/snippets/setex.test.yml b/doc/7/controllers/ms/setex/snippets/setex.test.yml index 2e27369b8..2d838b7cd 100644 --- a/doc/7/controllers/ms/setex/snippets/setex.test.yml +++ b/doc/7/controllers/ms/setex/snippets/setex.test.yml @@ -8,4 +8,4 @@ expected: - ^[0-9]{1,2}$ - ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/setnx/snippets/setnx.test.yml b/doc/7/controllers/ms/setnx/snippets/setnx.test.yml index 7611aab3b..775f67701 100644 --- a/doc/7/controllers/ms/setnx/snippets/setnx.test.yml +++ b/doc/7/controllers/ms/setnx/snippets/setnx.test.yml @@ -9,4 +9,4 @@ expected: - ^false$ - ^bar$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sinter/snippets/sinter.test.yml b/doc/7/controllers/ms/sinter/snippets/sinter.test.yml index f1cda41f4..a9b41b687 100644 --- a/doc/7/controllers/ms/sinter/snippets/sinter.test.yml +++ b/doc/7/controllers/ms/sinter/snippets/sinter.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'foo' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sinterstore/snippets/sinterstore.test.yml b/doc/7/controllers/ms/sinterstore/snippets/sinterstore.test.yml index 6563fb0ab..1cb8080fa 100644 --- a/doc/7/controllers/ms/sinterstore/snippets/sinterstore.test.yml +++ b/doc/7/controllers/ms/sinterstore/snippets/sinterstore.test.yml @@ -8,4 +8,4 @@ expected: - ^1$ - "\\[ 'foo' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sismember/snippets/sismember.test.yml b/doc/7/controllers/ms/sismember/snippets/sismember.test.yml index 944f3a6cc..a7f98de0e 100644 --- a/doc/7/controllers/ms/sismember/snippets/sismember.test.yml +++ b/doc/7/controllers/ms/sismember/snippets/sismember.test.yml @@ -8,4 +8,4 @@ expected: - ^true$ - ^false$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/smembers/snippets/smembers.test.yml b/doc/7/controllers/ms/smembers/snippets/smembers.test.yml index 5c4cae961..af8062666 100644 --- a/doc/7/controllers/ms/smembers/snippets/smembers.test.yml +++ b/doc/7/controllers/ms/smembers/snippets/smembers.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ '(foo|bar|baz)', '(foo|bar|baz)', '(foo|bar|baz)' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/smove/snippets/smove.test.yml b/doc/7/controllers/ms/smove/snippets/smove.test.yml index abbf09ca1..719791149 100644 --- a/doc/7/controllers/ms/smove/snippets/smove.test.yml +++ b/doc/7/controllers/ms/smove/snippets/smove.test.yml @@ -8,4 +8,4 @@ expected: - "\\[ '(bar|baz)', '(bar|baz)' ]" - "\\[ '(foo|qux)', '(foo|qux)' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sort/snippets/sort.test.yml b/doc/7/controllers/ms/sort/snippets/sort.test.yml index 44d9cefa0..dafb44336 100644 --- a/doc/7/controllers/ms/sort/snippets/sort.test.yml +++ b/doc/7/controllers/ms/sort/snippets/sort.test.yml @@ -12,4 +12,4 @@ expected: - "]" - "\\[ 'bar', 'baz', 'foo', 'qux' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/spop/snippets/spop.test.yml b/doc/7/controllers/ms/spop/snippets/spop.test.yml index 6fdcdadec..9029e0454 100644 --- a/doc/7/controllers/ms/spop/snippets/spop.test.yml +++ b/doc/7/controllers/ms/spop/snippets/spop.test.yml @@ -9,4 +9,4 @@ expected: - "^\\[ '[a-f]', '[a-f]', '[a-f]' ]" - ^2$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/srandmember/snippets/srandmember.test.yml b/doc/7/controllers/ms/srandmember/snippets/srandmember.test.yml index ff393adee..a42071648 100644 --- a/doc/7/controllers/ms/srandmember/snippets/srandmember.test.yml +++ b/doc/7/controllers/ms/srandmember/snippets/srandmember.test.yml @@ -8,4 +8,4 @@ expected: - "^\\[ '[a-f]' ]" - "^\\[ '[a-f]', '[a-f]', '[a-f]' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/srem/snippets/srem.test.yml b/doc/7/controllers/ms/srem/snippets/srem.test.yml index 788fb56b0..54e15cef8 100644 --- a/doc/7/controllers/ms/srem/snippets/srem.test.yml +++ b/doc/7/controllers/ms/srem/snippets/srem.test.yml @@ -8,4 +8,4 @@ expected: - ^2$ - "\\[ 'foo' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sscan/snippets/sscan.test.yml b/doc/7/controllers/ms/sscan/snippets/sscan.test.yml index 30984934a..c1ef31f5e 100644 --- a/doc/7/controllers/ms/sscan/snippets/sscan.test.yml +++ b/doc/7/controllers/ms/sscan/snippets/sscan.test.yml @@ -8,4 +8,4 @@ expected: - "{ cursor: '0', values: \\[ 'ba[rz]', 'ba[rz]' ] }" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/strlen/snippets/strlen.test.yml b/doc/7/controllers/ms/strlen/snippets/strlen.test.yml index de4defc7b..80fe579ba 100644 --- a/doc/7/controllers/ms/strlen/snippets/strlen.test.yml +++ b/doc/7/controllers/ms/strlen/snippets/strlen.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^6$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sunion/snippets/sunion.test.yml b/doc/7/controllers/ms/sunion/snippets/sunion.test.yml index 4089fa54b..3d2e24c42 100644 --- a/doc/7/controllers/ms/sunion/snippets/sunion.test.yml +++ b/doc/7/controllers/ms/sunion/snippets/sunion.test.yml @@ -10,4 +10,4 @@ expected: - ('[a-i]', ) - ('[a-i]', ) sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml b/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml index d21c3a8ed..109cca56d 100644 --- a/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml +++ b/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml @@ -10,4 +10,4 @@ expected: - ('[a-i]', ) - ('[a-i]', ) sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/time/snippets/time.test.yml b/doc/7/controllers/ms/time/snippets/time.test.yml index 3f1a9b33b..e8326ef50 100644 --- a/doc/7/controllers/ms/time/snippets/time.test.yml +++ b/doc/7/controllers/ms/time/snippets/time.test.yml @@ -7,4 +7,4 @@ template: default expected: - "\\[ \\d{10}, \\d+ ]$" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/touch/snippets/touch.test.yml b/doc/7/controllers/ms/touch/snippets/touch.test.yml index 8da644f65..14ea27530 100644 --- a/doc/7/controllers/ms/touch/snippets/touch.test.yml +++ b/doc/7/controllers/ms/touch/snippets/touch.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^2$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/ttl/snippets/ttl.test.yml b/doc/7/controllers/ms/ttl/snippets/ttl.test.yml index 0b6ac875b..6057d8c32 100644 --- a/doc/7/controllers/ms/ttl/snippets/ttl.test.yml +++ b/doc/7/controllers/ms/ttl/snippets/ttl.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^\d{1,2}$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/type/snippets/type.test.yml b/doc/7/controllers/ms/type/snippets/type.test.yml index cb36f7b49..1f511cc37 100644 --- a/doc/7/controllers/ms/type/snippets/type.test.yml +++ b/doc/7/controllers/ms/type/snippets/type.test.yml @@ -9,4 +9,4 @@ expected: - ^list$ - ^set$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zadd/snippets/zadd.test.yml b/doc/7/controllers/ms/zadd/snippets/zadd.test.yml index 7768f0495..c79fdc308 100644 --- a/doc/7/controllers/ms/zadd/snippets/zadd.test.yml +++ b/doc/7/controllers/ms/zadd/snippets/zadd.test.yml @@ -11,4 +11,4 @@ expected: - "{ member: 'foo', score: 42 }" - "]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zcard/snippets/zcard.test.yml b/doc/7/controllers/ms/zcard/snippets/zcard.test.yml index 3879d59ef..951876910 100644 --- a/doc/7/controllers/ms/zcard/snippets/zcard.test.yml +++ b/doc/7/controllers/ms/zcard/snippets/zcard.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^3$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zcount/snippets/zcount.test.yml b/doc/7/controllers/ms/zcount/snippets/zcount.test.yml index f0e2cc704..51c53b598 100644 --- a/doc/7/controllers/ms/zcount/snippets/zcount.test.yml +++ b/doc/7/controllers/ms/zcount/snippets/zcount.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^2$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml b/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml index 984a6bb11..85a84bd31 100644 --- a/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml +++ b/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml @@ -11,4 +11,4 @@ expected: - "{ member: 'bar', score: 1337 }" - "\\]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml b/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml index 35604b111..68b382fa5 100644 --- a/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml +++ b/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml @@ -11,4 +11,4 @@ expected: - "]" - "\\[ { member: 'baz', score: -272.15 }, { member: 'foo', score: -29 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zlexcount/snippets/zlexcount.test.yml b/doc/7/controllers/ms/zlexcount/snippets/zlexcount.test.yml index d6e40d7c6..150209bca 100644 --- a/doc/7/controllers/ms/zlexcount/snippets/zlexcount.test.yml +++ b/doc/7/controllers/ms/zlexcount/snippets/zlexcount.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: ^2$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrange/snippets/zrange.test.yml b/doc/7/controllers/ms/zrange/snippets/zrange.test.yml index 86904e46c..feeeace78 100644 --- a/doc/7/controllers/ms/zrange/snippets/zrange.test.yml +++ b/doc/7/controllers/ms/zrange/snippets/zrange.test.yml @@ -7,4 +7,4 @@ template: default expected: - "\\[ { member: 'baz', score: -272.15 }, { member: 'bar', score: 4 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrangebylex/snippets/zrangebylex.test.yml b/doc/7/controllers/ms/zrangebylex/snippets/zrangebylex.test.yml index 0877b44f6..45d00de04 100644 --- a/doc/7/controllers/ms/zrangebylex/snippets/zrangebylex.test.yml +++ b/doc/7/controllers/ms/zrangebylex/snippets/zrangebylex.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'bar', 'baz' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml b/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml index cc75d2645..39e30475a 100644 --- a/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml +++ b/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml @@ -7,4 +7,4 @@ template: default expected: - "\\[ { member: 'baz', score: -272.15 }, { member: 'bar', score: 4 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrank/snippets/zrank.test.yml b/doc/7/controllers/ms/zrank/snippets/zrank.test.yml index 7c003c8ec..2735f1ffe 100644 --- a/doc/7/controllers/ms/zrank/snippets/zrank.test.yml +++ b/doc/7/controllers/ms/zrank/snippets/zrank.test.yml @@ -8,4 +8,4 @@ expected: - ^2$ - ^null$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrem/snippets/zrem.test.yml b/doc/7/controllers/ms/zrem/snippets/zrem.test.yml index b3dc91706..173bbc82c 100644 --- a/doc/7/controllers/ms/zrem/snippets/zrem.test.yml +++ b/doc/7/controllers/ms/zrem/snippets/zrem.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ { member: 'baz', score: -272.15 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zremrangebylex/snippets/zremrangebylex.test.yml b/doc/7/controllers/ms/zremrangebylex/snippets/zremrangebylex.test.yml index a33d40996..17316355c 100644 --- a/doc/7/controllers/ms/zremrangebylex/snippets/zremrangebylex.test.yml +++ b/doc/7/controllers/ms/zremrangebylex/snippets/zremrangebylex.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'bar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zremrangebyrank/snippets/zremrangebyrank.test.yml b/doc/7/controllers/ms/zremrangebyrank/snippets/zremrangebyrank.test.yml index 3dc0390ab..0a81dfb9b 100644 --- a/doc/7/controllers/ms/zremrangebyrank/snippets/zremrangebyrank.test.yml +++ b/doc/7/controllers/ms/zremrangebyrank/snippets/zremrangebyrank.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ { member: 'baz', score: -272.15 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zremrangebyscore/snippets/zremrangebyscore.test.yml b/doc/7/controllers/ms/zremrangebyscore/snippets/zremrangebyscore.test.yml index bd0924e7e..ef951e1b6 100644 --- a/doc/7/controllers/ms/zremrangebyscore/snippets/zremrangebyscore.test.yml +++ b/doc/7/controllers/ms/zremrangebyscore/snippets/zremrangebyscore.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ { member: 'baz', score: -272.15 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrevrange/snippets/zrevrange.test.yml b/doc/7/controllers/ms/zrevrange/snippets/zrevrange.test.yml index a155183b1..f3231dc85 100644 --- a/doc/7/controllers/ms/zrevrange/snippets/zrevrange.test.yml +++ b/doc/7/controllers/ms/zrevrange/snippets/zrevrange.test.yml @@ -7,4 +7,4 @@ template: default expected: - "\\[ { member: 'foo', score: 42 }, { member: 'bar', score: 4 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrevrangebylex/snippets/zrevrangebylex.test.yml b/doc/7/controllers/ms/zrevrangebylex/snippets/zrevrangebylex.test.yml index 895a059e0..70db0bd81 100644 --- a/doc/7/controllers/ms/zrevrangebylex/snippets/zrevrangebylex.test.yml +++ b/doc/7/controllers/ms/zrevrangebylex/snippets/zrevrangebylex.test.yml @@ -6,4 +6,4 @@ hooks: template: default expected: "\\[ 'baz', 'bar' ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml b/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml index b76e8a1c0..07bfd6335 100644 --- a/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml +++ b/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml @@ -8,4 +8,4 @@ expected: - "\\[ { member: 'bar', score: 4 }, { member: 'baz', score: -272.15 } ]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zrevrank/snippets/zrevrank.test.yml b/doc/7/controllers/ms/zrevrank/snippets/zrevrank.test.yml index 7265aa01a..0d7bd6326 100644 --- a/doc/7/controllers/ms/zrevrank/snippets/zrevrank.test.yml +++ b/doc/7/controllers/ms/zrevrank/snippets/zrevrank.test.yml @@ -9,4 +9,4 @@ expected: - ^null$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zscan/snippets/zscan.test.yml b/doc/7/controllers/ms/zscan/snippets/zscan.test.yml index fae21db1d..77192f43a 100644 --- a/doc/7/controllers/ms/zscan/snippets/zscan.test.yml +++ b/doc/7/controllers/ms/zscan/snippets/zscan.test.yml @@ -10,4 +10,4 @@ expected: - "values: \\[ 'baz', '-272.1\\d{1,}', 'bar', '4', 'foo', '42' ]" - "}" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zscore/snippets/zscore.test.yml b/doc/7/controllers/ms/zscore/snippets/zscore.test.yml index 6cb2d2a1d..da5a531c9 100644 --- a/doc/7/controllers/ms/zscore/snippets/zscore.test.yml +++ b/doc/7/controllers/ms/zscore/snippets/zscore.test.yml @@ -8,4 +8,4 @@ expected: - ^42$ - ^4$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml b/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml index 03edba1d2..1dd912dfe 100644 --- a/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml +++ b/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml @@ -16,4 +16,4 @@ expected: - "{ member: 'baz', score: 300 }" - "]" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/count/snippets/count.test.yml b/doc/7/controllers/realtime/count/snippets/count.test.yml index b0ba611a2..4e2e07b52 100644 --- a/doc/7/controllers/realtime/count/snippets/count.test.yml +++ b/doc/7/controllers/realtime/count/snippets/count.test.yml @@ -7,4 +7,4 @@ template: default expected: Currently 1 active subscription sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/publish/snippets/publish.test.yml b/doc/7/controllers/realtime/publish/snippets/publish.test.yml index b95fffd27..303f87900 100644 --- a/doc/7/controllers/realtime/publish/snippets/publish.test.yml +++ b/doc/7/controllers/realtime/publish/snippets/publish.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/subscribe/snippets/document-notifications-leave-scope.test.yml b/doc/7/controllers/realtime/subscribe/snippets/document-notifications-leave-scope.test.yml index f4321c129..773890e87 100644 --- a/doc/7/controllers/realtime/subscribe/snippets/document-notifications-leave-scope.test.yml +++ b/doc/7/controllers/realtime/subscribe/snippets/document-notifications-leave-scope.test.yml @@ -7,4 +7,4 @@ template: realtime expected: Document moved out from the scope sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/subscribe/snippets/document-notifications.test.yml b/doc/7/controllers/realtime/subscribe/snippets/document-notifications.test.yml index 8dde8db25..2ed2614a4 100644 --- a/doc/7/controllers/realtime/subscribe/snippets/document-notifications.test.yml +++ b/doc/7/controllers/realtime/subscribe/snippets/document-notifications.test.yml @@ -7,4 +7,4 @@ template: realtime expected: Document nina vkote enter the scope sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/subscribe/snippets/message-notifications.test.yml b/doc/7/controllers/realtime/subscribe/snippets/message-notifications.test.yml index b97305f9c..678e52fb3 100644 --- a/doc/7/controllers/realtime/subscribe/snippets/message-notifications.test.yml +++ b/doc/7/controllers/realtime/subscribe/snippets/message-notifications.test.yml @@ -7,4 +7,4 @@ template: realtime expected: Message notification received sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/subscribe/snippets/user-notifications.test.yml b/doc/7/controllers/realtime/subscribe/snippets/user-notifications.test.yml index c0290cea0..49606aaca 100644 --- a/doc/7/controllers/realtime/subscribe/snippets/user-notifications.test.yml +++ b/doc/7/controllers/realtime/subscribe/snippets/user-notifications.test.yml @@ -6,4 +6,4 @@ hooks: template: realtime expected: "username: 'nina vkote'" sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/realtime/unsubscribe/snippets/unsubscribe.test.yml b/doc/7/controllers/realtime/unsubscribe/snippets/unsubscribe.test.yml index 72124fdf9..70db043a7 100644 --- a/doc/7/controllers/realtime/unsubscribe/snippets/unsubscribe.test.yml +++ b/doc/7/controllers/realtime/unsubscribe/snippets/unsubscribe.test.yml @@ -7,4 +7,4 @@ template: default expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/controllers/server/admin-exists/snippets/admin-exists.test.yml b/doc/7/controllers/server/admin-exists/snippets/admin-exists.test.yml index 823029ea2..2502f328f 100644 --- a/doc/7/controllers/server/admin-exists/snippets/admin-exists.test.yml +++ b/doc/7/controllers/server/admin-exists/snippets/admin-exists.test.yml @@ -7,4 +7,4 @@ template: default expected: ^(Admin exists\?) (true|false)$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/add-listener/snippets/add-listener.test.yml b/doc/7/core-classes/kuzzle-event-emitter/add-listener/snippets/add-listener.test.yml index 32d033093..261fe9cf4 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/add-listener/snippets/add-listener.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/add-listener/snippets/add-listener.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: Caught event "myEvent"! sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/add-once-listener/snippets/add-once-listener.test.yml b/doc/7/core-classes/kuzzle-event-emitter/add-once-listener/snippets/add-once-listener.test.yml index fe7b777ac..3ca6257d7 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/add-once-listener/snippets/add-once-listener.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/add-once-listener/snippets/add-once-listener.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: Caught event "myEvent"! sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/emit/snippets/emit.test.yml b/doc/7/core-classes/kuzzle-event-emitter/emit/snippets/emit.test.yml index e2dec6f61..dc23f9a35 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/emit/snippets/emit.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/emit/snippets/emit.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: Hello World sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/listeners/snippets/listeners.test.yml b/doc/7/core-classes/kuzzle-event-emitter/listeners/snippets/listeners.test.yml index fe978c60d..52a527683 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/listeners/snippets/listeners.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/listeners/snippets/listeners.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: There are 2 listeners bound to the event "myEvent" sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/prepend-listener/snippets/prepend-listener.test.yml b/doc/7/core-classes/kuzzle-event-emitter/prepend-listener/snippets/prepend-listener.test.yml index 6bb15910b..9ab3c939a 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/prepend-listener/snippets/prepend-listener.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/prepend-listener/snippets/prepend-listener.test.yml @@ -8,4 +8,4 @@ expected: - ^listener2$ - ^listener1$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/prepend-once-listener/snippets/prepend-once-listener.test.yml b/doc/7/core-classes/kuzzle-event-emitter/prepend-once-listener/snippets/prepend-once-listener.test.yml index d329f51ff..6f31d5c21 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/prepend-once-listener/snippets/prepend-once-listener.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/prepend-once-listener/snippets/prepend-once-listener.test.yml @@ -9,4 +9,4 @@ expected: - ^listener1$ - ^listener1$ sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/remove-all-listener/snippets/remove-all-listeners.test.yml b/doc/7/core-classes/kuzzle-event-emitter/remove-all-listener/snippets/remove-all-listeners.test.yml index 043d330e0..e1d5d344c 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/remove-all-listener/snippets/remove-all-listeners.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/remove-all-listener/snippets/remove-all-listeners.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: Successfully removed all listeners sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle-event-emitter/remove-listener/snippets/remove-listener.test.yml b/doc/7/core-classes/kuzzle-event-emitter/remove-listener/snippets/remove-listener.test.yml index d50965568..50d53fcf9 100644 --- a/doc/7/core-classes/kuzzle-event-emitter/remove-listener/snippets/remove-listener.test.yml +++ b/doc/7/core-classes/kuzzle-event-emitter/remove-listener/snippets/remove-listener.test.yml @@ -6,4 +6,4 @@ hooks: template: eventemitter expected: Successfully removed the listener sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/connect/snippets/connect.test.yml b/doc/7/core-classes/kuzzle/connect/snippets/connect.test.yml index e904c4c4a..86edf692a 100644 --- a/doc/7/core-classes/kuzzle/connect/snippets/connect.test.yml +++ b/doc/7/core-classes/kuzzle/connect/snippets/connect.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Successfully connected sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/constructor/snippets/constructor.test.yml b/doc/7/core-classes/kuzzle/constructor/snippets/constructor.test.yml index 2a43f0463..26b345f0b 100644 --- a/doc/7/core-classes/kuzzle/constructor/snippets/constructor.test.yml +++ b/doc/7/core-classes/kuzzle/constructor/snippets/constructor.test.yml @@ -7,4 +7,4 @@ hooks: template: empty expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/disconnect/snippets/disconnect.test.yml b/doc/7/core-classes/kuzzle/disconnect/snippets/disconnect.test.yml index 275657be6..15f23ad96 100644 --- a/doc/7/core-classes/kuzzle/disconnect/snippets/disconnect.test.yml +++ b/doc/7/core-classes/kuzzle/disconnect/snippets/disconnect.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Successfully disconnected sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/flush-queue/snippets/flush-queue.test.yml b/doc/7/core-classes/kuzzle/flush-queue/snippets/flush-queue.test.yml index 704e7e084..ada4a3aef 100644 --- a/doc/7/core-classes/kuzzle/flush-queue/snippets/flush-queue.test.yml +++ b/doc/7/core-classes/kuzzle/flush-queue/snippets/flush-queue.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Offline queue flushed sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/play-queue/snippets/play-queue.test.yml b/doc/7/core-classes/kuzzle/play-queue/snippets/play-queue.test.yml index a3507d292..8a249726b 100644 --- a/doc/7/core-classes/kuzzle/play-queue/snippets/play-queue.test.yml +++ b/doc/7/core-classes/kuzzle/play-queue/snippets/play-queue.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Start playing offline queue sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/query/snippets/query.test.yml b/doc/7/core-classes/kuzzle/query/snippets/query.test.yml index 0b5358454..490f1e010 100644 --- a/doc/7/core-classes/kuzzle/query/snippets/query.test.yml +++ b/doc/7/core-classes/kuzzle/query/snippets/query.test.yml @@ -11,4 +11,4 @@ template: default expected: Document created sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/start-queuing/snippets/start-queuing.test.yml b/doc/7/core-classes/kuzzle/start-queuing/snippets/start-queuing.test.yml index 914f4ac01..8eb3cfc20 100644 --- a/doc/7/core-classes/kuzzle/start-queuing/snippets/start-queuing.test.yml +++ b/doc/7/core-classes/kuzzle/start-queuing/snippets/start-queuing.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Start queuing requests sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/stop-queuing/snippets/stop-queuing.test.yml b/doc/7/core-classes/kuzzle/stop-queuing/snippets/stop-queuing.test.yml index d0709b139..63175a19a 100644 --- a/doc/7/core-classes/kuzzle/stop-queuing/snippets/stop-queuing.test.yml +++ b/doc/7/core-classes/kuzzle/stop-queuing/snippets/stop-queuing.test.yml @@ -8,4 +8,4 @@ template: without-connect expected: Stop queuing requests sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/kuzzle/use-controller/snippets/use-controller.test.yml b/doc/7/core-classes/kuzzle/use-controller/snippets/use-controller.test.yml index f16fbf941..976bf68ed 100644 --- a/doc/7/core-classes/kuzzle/use-controller/snippets/use-controller.test.yml +++ b/doc/7/core-classes/kuzzle/use-controller/snippets/use-controller.test.yml @@ -8,4 +8,4 @@ template: controller expected: Success sdk: js -version: 6 \ No newline at end of file +version: 7 \ No newline at end of file diff --git a/doc/7/core-classes/profile/getRoles/snippets/getRoles.test.yml b/doc/7/core-classes/profile/getRoles/snippets/getRoles.test.yml index 0ddd2c4b4..f7fa219ff 100644 --- a/doc/7/core-classes/profile/getRoles/snippets/getRoles.test.yml +++ b/doc/7/core-classes/profile/getRoles/snippets/getRoles.test.yml @@ -9,4 +9,4 @@ template: default expected: - Profile { _id: \'default\' sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/search-result/next/snippets/fromsize.test.yml b/doc/7/core-classes/search-result/next/snippets/fromsize.test.yml index 2db06a17a..135ad9c56 100644 --- a/doc/7/core-classes/search-result/next/snippets/fromsize.test.yml +++ b/doc/7/core-classes/search-result/next/snippets/fromsize.test.yml @@ -10,4 +10,4 @@ hooks: template: default expected: Successfully retrieved 100 documents sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/search-result/next/snippets/scroll.test.yml b/doc/7/core-classes/search-result/next/snippets/scroll.test.yml index bc3dc28d2..5cfbced3c 100644 --- a/doc/7/core-classes/search-result/next/snippets/scroll.test.yml +++ b/doc/7/core-classes/search-result/next/snippets/scroll.test.yml @@ -10,4 +10,4 @@ hooks: template: default expected: Successfully retrieved 100 documents sdk: js -version: 6 +version: 7 diff --git a/doc/7/core-classes/user/getProfiles/snippets/getProfiles.test.yml b/doc/7/core-classes/user/getProfiles/snippets/getProfiles.test.yml index f23afa975..c112aff5e 100644 --- a/doc/7/core-classes/user/getProfiles/snippets/getProfiles.test.yml +++ b/doc/7/core-classes/user/getProfiles/snippets/getProfiles.test.yml @@ -9,4 +9,4 @@ template: default expected: - Role { _id: \'default\' sdk: js -version: 6 +version: 7 diff --git a/doc/7/essentials/error-handling/snippets/error-handling.test.yml b/doc/7/essentials/error-handling/snippets/error-handling.test.yml index 948f43353..9caa6eee7 100644 --- a/doc/7/essentials/error-handling/snippets/error-handling.test.yml +++ b/doc/7/essentials/error-handling/snippets/error-handling.test.yml @@ -7,4 +7,4 @@ template: thencatch expected: Try with another name! sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/node-js/snippets/create.test.yml b/doc/7/getting-started/node-js/snippets/create.test.yml index 910484f25..9a19851b1 100644 --- a/doc/7/getting-started/node-js/snippets/create.test.yml +++ b/doc/7/getting-started/node-js/snippets/create.test.yml @@ -8,4 +8,4 @@ hooks: template: empty expected: New document successfully created! sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/node-js/snippets/init.test.yml b/doc/7/getting-started/node-js/snippets/init.test.yml index 0e76545bc..89ded1ac8 100644 --- a/doc/7/getting-started/node-js/snippets/init.test.yml +++ b/doc/7/getting-started/node-js/snippets/init.test.yml @@ -6,4 +6,4 @@ hooks: template: empty expected: nyc-open-data/yellow-taxi ready! sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/node-js/snippets/load-sdk.test.yml b/doc/7/getting-started/node-js/snippets/load-sdk.test.yml index 0d32da204..ae05c0dd3 100644 --- a/doc/7/getting-started/node-js/snippets/load-sdk.test.yml +++ b/doc/7/getting-started/node-js/snippets/load-sdk.test.yml @@ -6,4 +6,4 @@ hooks: template: empty expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/node-js/snippets/prepare-db.test.yml b/doc/7/getting-started/node-js/snippets/prepare-db.test.yml index e51b6f7ce..c257e2760 100644 --- a/doc/7/getting-started/node-js/snippets/prepare-db.test.yml +++ b/doc/7/getting-started/node-js/snippets/prepare-db.test.yml @@ -6,4 +6,4 @@ hooks: template: blank expected: nyc-open-data/yellow-taxi ready! sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/node-js/snippets/subscribe.test.yml b/doc/7/getting-started/node-js/snippets/subscribe.test.yml index 5e6720558..a34b4d32a 100644 --- a/doc/7/getting-started/node-js/snippets/subscribe.test.yml +++ b/doc/7/getting-started/node-js/snippets/subscribe.test.yml @@ -8,4 +8,4 @@ hooks: template: empty-realtime expected: Successfully subscribed to document notifications! sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/raw-web/snippets/create.test.yml b/doc/7/getting-started/raw-web/snippets/create.test.yml index 557868de8..251b041d0 100644 --- a/doc/7/getting-started/raw-web/snippets/create.test.yml +++ b/doc/7/getting-started/raw-web/snippets/create.test.yml @@ -8,5 +8,5 @@ hooks: template: default expected: New document successfully created sdk: js -version: 6 +version: 7 runner: web diff --git a/doc/7/getting-started/raw-web/snippets/load-sdk.test.yml b/doc/7/getting-started/raw-web/snippets/load-sdk.test.yml index c17ef17d8..9c6f8c72d 100644 --- a/doc/7/getting-started/raw-web/snippets/load-sdk.test.yml +++ b/doc/7/getting-started/raw-web/snippets/load-sdk.test.yml @@ -6,5 +6,5 @@ hooks: template: default expected: Successfully connected to Kuzzle sdk: js -version: 6 +version: 7 runner: web diff --git a/doc/7/getting-started/raw-web/snippets/prepare-db.test.yml b/doc/7/getting-started/raw-web/snippets/prepare-db.test.yml index 3ac1c5a75..2158c88c1 100644 --- a/doc/7/getting-started/raw-web/snippets/prepare-db.test.yml +++ b/doc/7/getting-started/raw-web/snippets/prepare-db.test.yml @@ -6,5 +6,5 @@ hooks: template: default expected: nyc-open-data/yellow-taxi ready sdk: js -version: 6 +version: 7 runner: web diff --git a/doc/7/getting-started/raw-web/snippets/subscribe.test.yml b/doc/7/getting-started/raw-web/snippets/subscribe.test.yml index 2fad572cd..944ad12ed 100644 --- a/doc/7/getting-started/raw-web/snippets/subscribe.test.yml +++ b/doc/7/getting-started/raw-web/snippets/subscribe.test.yml @@ -8,5 +8,5 @@ hooks: template: default expected: Successfully subscribed to document notifications sdk: js -version: 6 +version: 7 runner: web diff --git a/doc/7/getting-started/webpack/snippets.disabled/create.test.yml b/doc/7/getting-started/webpack/snippets.disabled/create.test.yml index fb4561210..4cc80bc5e 100644 --- a/doc/7/getting-started/webpack/snippets.disabled/create.test.yml +++ b/doc/7/getting-started/webpack/snippets.disabled/create.test.yml @@ -10,4 +10,4 @@ expected: New document successfully created! runner: webpack sdk: js -version: 6 +version: 7 diff --git a/doc/7/getting-started/webpack/snippets.disabled/init-kuzzle.test.yml b/doc/7/getting-started/webpack/snippets.disabled/init-kuzzle.test.yml index cd2ff4589..6d2364a01 100644 --- a/doc/7/getting-started/webpack/snippets.disabled/init-kuzzle.test.yml +++ b/doc/7/getting-started/webpack/snippets.disabled/init-kuzzle.test.yml @@ -6,5 +6,5 @@ hooks: template: empty expected: nyc-open-data/yellow-taxi ready! sdk: js -version: 6 +version: 7 runner: webpack diff --git a/doc/7/getting-started/webpack/snippets.disabled/subscribe.test.yml b/doc/7/getting-started/webpack/snippets.disabled/subscribe.test.yml index f62f51a44..d438214ce 100644 --- a/doc/7/getting-started/webpack/snippets.disabled/subscribe.test.yml +++ b/doc/7/getting-started/webpack/snippets.disabled/subscribe.test.yml @@ -10,5 +10,5 @@ expected: - Successfully subscribed to document notifications! - New driver Sirkis with id sdk: js -version: 6 +version: 7 runner: webpack diff --git a/doc/7/protocols/http/constructor/snippets/constructor.test.yml b/doc/7/protocols/http/constructor/snippets/constructor.test.yml index 585b32c5a..35c10071d 100644 --- a/doc/7/protocols/http/constructor/snippets/constructor.test.yml +++ b/doc/7/protocols/http/constructor/snippets/constructor.test.yml @@ -7,4 +7,4 @@ hooks: template: empty expected: Success sdk: js -version: 6 +version: 7 diff --git a/doc/7/protocols/websocket/constructor/snippets/constructor.test.yml b/doc/7/protocols/websocket/constructor/snippets/constructor.test.yml index 9f49ef71a..6074dbfa5 100644 --- a/doc/7/protocols/websocket/constructor/snippets/constructor.test.yml +++ b/doc/7/protocols/websocket/constructor/snippets/constructor.test.yml @@ -7,4 +7,4 @@ hooks: template: empty expected: Success sdk: js -version: 6 +version: 7 From 3cddc8f1defbf3a3d1fd6a1204fc58ef05dba95b Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 15:16:37 +0100 Subject: [PATCH 17/29] ci(ci): fix workflow typo --- .github/workflows/pull_request.workflow.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index 4c14ecece..9adbe97f2 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -11,7 +11,6 @@ jobs: node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 - - name: Cache node modules uses: actions/cache@v3 env: cache-name: cache-node-modules @@ -65,7 +64,6 @@ jobs: runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v3 - - name: Cache node modules - uses: actions/setup-node@v4 with: node-version: "20" From 6adf7478423110d52226cd284ede4ce928b7efd0 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 15:17:42 +0100 Subject: [PATCH 18/29] ci: fix typo in workflow --- .github/workflows/pull_request.workflow.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index 9adbe97f2..4afb21b08 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -11,7 +11,6 @@ jobs: node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 - uses: actions/cache@v3 env: cache-name: cache-node-modules with: @@ -49,8 +48,6 @@ jobs: node-version: ["16", "18", "20"] steps: - uses: actions/checkout@v3 - with: - submodules: "recursive" - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} From e13c84ed2a2ec6cacf6f7ccb6d785142164f3442 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 15:24:34 +0100 Subject: [PATCH 19/29] ci: remove es-lint action to keep it inside workflow file --- .github/actions/es-lint/action.yml | 11 ----------- .github/workflows/pull_request.workflow.yml | 4 +++- 2 files changed, 3 insertions(+), 12 deletions(-) delete mode 100644 .github/actions/es-lint/action.yml diff --git a/.github/actions/es-lint/action.yml b/.github/actions/es-lint/action.yml deleted file mode 100644 index fda93f250..000000000 --- a/.github/actions/es-lint/action.yml +++ /dev/null @@ -1,11 +0,0 @@ -name: ESLint -description: Run ESLint -runs: - using: "composite" - steps: - - name: Install deps - run: npm ci - shell: bash - - name: Run lint - run: npm run test:lint - shell: bash diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index 4afb21b08..e3c223e1c 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -23,7 +23,9 @@ jobs: - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - - uses: ./.github/actions/es-lint + - runs: | + npm ci + npm run test:lint unit-tests: name: Unit Tests From 6a2252835d941ab37fe37b994cd548297ff12874 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 15:29:00 +0100 Subject: [PATCH 20/29] ci: fix typo in ci --- .github/workflows/pull_request.workflow.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index e3c223e1c..4c6fbb0e1 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -23,7 +23,7 @@ jobs: - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - - runs: | + - run: | npm ci npm run test:lint From e4298bba602cbd7b7c095efac789a1cd0dfe4ce2 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 16:16:16 +0100 Subject: [PATCH 21/29] ci: fix ci --- .github/workflows/pull_request.workflow.yml | 27 +++++++++------------ 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml index 4c6fbb0e1..a3530b9ff 100644 --- a/.github/workflows/pull_request.workflow.yml +++ b/.github/workflows/pull_request.workflow.yml @@ -8,21 +8,13 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - node-version: ["16", "18", "20"] + node-version: ["18", "20"] steps: - - uses: actions/checkout@v3 - env: - cache-name: cache-node-modules - with: - path: ~/.npm - key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-build-${{ env.cache-name }}- - ${{ runner.os }}-build- - ${{ runner.os }}- + - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} + cache: 'npm' - run: | npm ci npm run test:lint @@ -33,12 +25,13 @@ jobs: needs: [lint] strategy: matrix: - node-version: ["16", "18", "20"] + node-version: ["18", "20"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} + cache: 'npm' - uses: ./.github/actions/unit-tests functional-tests: @@ -47,12 +40,13 @@ jobs: needs: [unit-tests] strategy: matrix: - node-version: ["16", "18", "20"] + node-version: ["18", "20"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} + cache: 'npm' - uses: ./.github/actions/functional-tests with: CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }} @@ -62,10 +56,11 @@ jobs: needs: [unit-tests] runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: "20" + cache: 'npm' - uses: ./.github/actions/snippet-tests with: CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }} From 149a15ade606ad0357dda185d9db2347097c141f Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 17:16:27 +0100 Subject: [PATCH 22/29] ci: wip fixing snippet-tests --- .ci/doc/docker-compose.yml | 6 +-- .ci/doc/package.json | 9 +++++ .../{delete-specifications.js => delete.js} | 0 ...pecifications.test.yml => delete.test.yml} | 0 .../collection/exists/snippets/exists.js | 2 +- doc/7/controllers/index/delete/index.md | 2 +- .../index/delete/snippets/delete.js | 2 +- .../index/delete/snippets/delete.test.yml | 2 +- src/utils/browser.js | 40 +++++++++++++++++++ 9 files changed, 56 insertions(+), 7 deletions(-) create mode 100644 .ci/doc/package.json rename doc/7/controllers/collection/delete/snippets/{delete-specifications.js => delete.js} (100%) rename doc/7/controllers/collection/delete/snippets/{delete-specifications.test.yml => delete.test.yml} (100%) create mode 100644 src/utils/browser.js diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index a0c7da7f2..d990e5815 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -76,12 +76,11 @@ services: apt-get install -y curl; npm install -g \ eslint@8.38.0; - cd /mnt; - npm install; cd /var/snippets/web; cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/; npm install \ - /mnt/.ci/doc \ + /mnt/ \ + puppeteer \ eslint \ eslint-plugin-html \ eslint-plugin-import \ @@ -111,6 +110,7 @@ services: cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/; npm install \ /mnt/ \ + puppeteer \ babel-loader \ @babel/core \ html-webpack-plugin \ diff --git a/.ci/doc/package.json b/.ci/doc/package.json new file mode 100644 index 000000000..9a193f572 --- /dev/null +++ b/.ci/doc/package.json @@ -0,0 +1,9 @@ +{ + "name": "docs", + "version": "1.0.0", + "description": "docs for kuzzle-sdk", + "author": "The Kuzzle Team ", + "scripts": {}, + "dependencies": {}, + "devDependencies": {} +} diff --git a/doc/7/controllers/collection/delete/snippets/delete-specifications.js b/doc/7/controllers/collection/delete/snippets/delete.js similarity index 100% rename from doc/7/controllers/collection/delete/snippets/delete-specifications.js rename to doc/7/controllers/collection/delete/snippets/delete.js diff --git a/doc/7/controllers/collection/delete/snippets/delete-specifications.test.yml b/doc/7/controllers/collection/delete/snippets/delete.test.yml similarity index 100% rename from doc/7/controllers/collection/delete/snippets/delete-specifications.test.yml rename to doc/7/controllers/collection/delete/snippets/delete.test.yml diff --git a/doc/7/controllers/collection/exists/snippets/exists.js b/doc/7/controllers/collection/exists/snippets/exists.js index 167a241af..e60c074f3 100644 --- a/doc/7/controllers/collection/exists/snippets/exists.js +++ b/doc/7/controllers/collection/exists/snippets/exists.js @@ -1,5 +1,5 @@ try { - const exists = kuzzle.collection.exists('nyc-open-data', 'green-taxi'); + const exists = await kuzzle.collection.exists('nyc-open-data', 'green-taxi'); if (exists) { console.log('Success'); diff --git a/doc/7/controllers/index/delete/index.md b/doc/7/controllers/index/delete/index.md index 0afc22970..8d3ed8481 100644 --- a/doc/7/controllers/index/delete/index.md +++ b/doc/7/controllers/index/delete/index.md @@ -2,7 +2,7 @@ code: true type: page title: delete -description: Deletes an index +description: Delete an index --- # delete diff --git a/doc/7/controllers/index/delete/snippets/delete.js b/doc/7/controllers/index/delete/snippets/delete.js index ee0771bf9..4b6dedcbb 100644 --- a/doc/7/controllers/index/delete/snippets/delete.js +++ b/doc/7/controllers/index/delete/snippets/delete.js @@ -1,5 +1,5 @@ try { - kuzzle.index.delete('nyc-open-data'); + await kuzzle.index.delete('nyc-open-data'); console.log('Index deleted'); } catch (error) { diff --git a/doc/7/controllers/index/delete/snippets/delete.test.yml b/doc/7/controllers/index/delete/snippets/delete.test.yml index bd2e608a8..2ac5c0f1c 100644 --- a/doc/7/controllers/index/delete/snippets/delete.test.yml +++ b/doc/7/controllers/index/delete/snippets/delete.test.yml @@ -1,6 +1,6 @@ --- name: index#delete -description: Deletes an index +description: Delete an index hooks: before: curl -X POST kuzzle:7512/nyc-open-data/_create after: diff --git a/src/utils/browser.js b/src/utils/browser.js new file mode 100644 index 000000000..3d81f11b6 --- /dev/null +++ b/src/utils/browser.js @@ -0,0 +1,40 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.isBrowser = exports.getBrowserWindow = void 0; +function getBrowserWindow() { + let windowObject; + try { + windowObject || (windowObject = globalThis.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = global.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = window); + if (windowObject) { + return windowObject; + } + } + catch { + // return undefined + } +} +exports.getBrowserWindow = getBrowserWindow; +function isBrowser() { + const window = getBrowserWindow(); + return window !== undefined && window !== null && typeof window === "object"; +} +exports.isBrowser = isBrowser; +//# sourceMappingURL=browser.js.map \ No newline at end of file From a9239129f54d02dbe6abaa814ef76e67c6a03e55 Mon Sep 17 00:00:00 2001 From: rolljee Date: Thu, 31 Oct 2024 17:28:19 +0100 Subject: [PATCH 23/29] ci: remove not wanted file --- src/utils/browser.js | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 src/utils/browser.js diff --git a/src/utils/browser.js b/src/utils/browser.js deleted file mode 100644 index 3d81f11b6..000000000 --- a/src/utils/browser.js +++ /dev/null @@ -1,40 +0,0 @@ -"use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isBrowser = exports.getBrowserWindow = void 0; -function getBrowserWindow() { - let windowObject; - try { - windowObject || (windowObject = globalThis.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = global.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = window); - if (windowObject) { - return windowObject; - } - } - catch { - // return undefined - } -} -exports.getBrowserWindow = getBrowserWindow; -function isBrowser() { - const window = getBrowserWindow(); - return window !== undefined && window !== null && typeof window === "object"; -} -exports.isBrowser = isBrowser; -//# sourceMappingURL=browser.js.map \ No newline at end of file From ad8e53374120f149661207ca291f50a85a8c2028 Mon Sep 17 00:00:00 2001 From: rolljee Date: Mon, 4 Nov 2024 21:08:25 +0100 Subject: [PATCH 24/29] fix(ci): Update ci to work with last version of puppeteer --- .ci/doc/Dockerfile | 76 ++++++++++++++++++++++++++++++++++++++ .ci/doc/config.yml | 34 ++++++++--------- .ci/doc/docker-compose.yml | 71 +++++++++++------------------------ .ci/doc/package.json | 1 + .ci/doc/puppeteer.js | 50 ++++++++++++++++++------- .ci/test-docs.sh | 3 +- src/utils/browser.js | 40 ++++++++++++++++++++ 7 files changed, 193 insertions(+), 82 deletions(-) create mode 100644 .ci/doc/Dockerfile create mode 100644 src/utils/browser.js diff --git a/.ci/doc/Dockerfile b/.ci/doc/Dockerfile new file mode 100644 index 000000000..7f7049488 --- /dev/null +++ b/.ci/doc/Dockerfile @@ -0,0 +1,76 @@ +FROM node:20-bookworm-slim + +USER root + +RUN mkdir -p /home/node/.cache/puppeteer + +# Puppeteer Chrome headless dependencies +RUN apt-get update && apt-get install -y \ + ca-certificates \ + curl \ + fonts-liberation \ + libasound2 \ + libatk-bridge2.0-0 \ + libatk1.0-0 \ + libc6 \ + libcairo2 \ + libcups2 \ + libdbus-1-3 \ + libexpat1 \ + libfontconfig1 \ + libgbm1 \ + libgcc1 \ + libglib2.0-0 \ + libgtk-3-0 \ + libnspr4 \ + libnss3 \ + libpango-1.0-0 \ + libpangocairo-1.0-0 \ + libstdc++6 \ + libx11-6 \ + libx11-xcb1 \ + libxcb1 \ + libxcomposite1 \ + libxcursor1 \ + libxdamage1 \ + libxext6 \ + libxfixes3 \ + libxi6 \ + libxrandr2 \ + libxrender1 \ + libxss1 \ + libxtst6 \ + lsb-release \ + wget \ + xdg-utils \ + && rm -rf /var/lib/apt/lists/* + +# Install all dependencies needed for both services +RUN npm install -g \ + puppeteer \ + eslint@8.38.0 \ + eslint-plugin-html \ + eslint-plugin-import \ + eslint-plugin-node \ + eslint-plugin-promise \ + eslint-plugin-standard \ + babel-loader \ + @babel/core \ + html-webpack-plugin \ + webpack \ + webpack-cli + +RUN usermod -a -G video,audio node + +# Create working directories for snippets +RUN mkdir -p /var/snippets/web && \ + mkdir -p /var/snippets/webpack + +# Set proper permissions +RUN chown -R node:node /var/snippets/ +RUN chown -R node:node /home/node/.cache/puppeteer + +USER node + +# Keep container running +CMD ["tail", "-f", "/dev/null"] diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml index 59d9f91d1..5af33babc 100644 --- a/.ci/doc/config.yml +++ b/.ci/doc/config.yml @@ -5,40 +5,40 @@ snippets: templates: /mnt/.ci/doc/templates runners: - default: node + default: web - node: - service: doc-runner-node - path: /var/snippets/node - lint: - global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} - before: timeout 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' - run: - cmd: node {{ snippet.source }} - before: timeout 600 ash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' + # node: + # service: doc-runner-node + # path: /var/snippets/node + # lint: + # global: true + # cmd: npx eslint@8.38.0 -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} + # before: timeout 600 ash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' + # run: + # cmd: node {{ snippet.source }} + # before: timeout 600 ash -c 'until stat /home/node/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' web: service: doc-runner-web path: /var/snippets/web lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 {{ snippet.dir }}/*.html - before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' + cmd: npx eslint@8.38.0 -c /mnt/.ci/doc/eslint.json --parser-options ecmaVersion:12 {{ snippet.dir }}/*.html + before: timeout 600 bash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' run: cmd: node puppeteer.js {{ snippet.dir }}/{{ snippet.source }} - before: timeout 600 bash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' + before: timeout 600 bash -c 'until stat /home/node/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' webpack: service: doc-runner-webpack path: /var/snippets/webpack lint: global: true - cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} - before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' + cmd: npx eslint8.38.0 -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} + before: timeout 600 bash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' build: cmd: node webpackBuild.js {{ snippet.dir }}/{{ snippet.source }} - before: timeout 600 bash -c 'until stat /tmp/runner_is_ready; do sleep 1; done' + before: timeout 600 bash -c 'until stat /home/node/runner_is_ready; do sleep 1; done' run: cmd: node puppeteer.js /tmp/{{ snippet.name }}/index.html before: timeout 600 bash -c 'until curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml index d990e5815..4c03c7c72 100644 --- a/.ci/doc/docker-compose.yml +++ b/.ci/doc/docker-compose.yml @@ -47,12 +47,11 @@ services: ash -c ' mkdir -p /var/snippets/node; apk add --no-cache curl; - npm install -g eslint@8.38.0; cd /var/snippets/node; npm install \ bluebird \ /mnt/ \ - eslint \ + eslint@8.38.0 \ eslint-plugin-html \ eslint-plugin-import \ eslint-plugin-node \ @@ -67,68 +66,40 @@ services: - snippets:/var/snippets doc-runner-web: - image: ghcr.io/puppeteer/puppeteer:23.5.1 - user: root + build: . + volumes: + - ../..:/mnt + - snippets:/var/snippets + working_dir: /var/snippets/web command: > bash -c ' - mkdir -p /var/snippets/web; - apt-get update; - apt-get install -y curl; - npm install -g \ - eslint@8.38.0; - cd /var/snippets/web; cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/; - npm install \ - /mnt/ \ - puppeteer \ - eslint \ - eslint-plugin-html \ - eslint-plugin-import \ - eslint-plugin-node \ - eslint-plugin-promise \ - eslint-plugin-standard; - touch /tmp/runner_ready_to_lint; - touch /tmp/runner_is_ready; + npm install /mnt/; + cp -fr /usr/local/lib/node_modules/* /var/snippets/web/node_modules; + cp -fr /usr/local/lib/node_modules/* /var/snippets/webpack/node_modules; + touch /home/node/runner_ready_to_lint; + touch /home/node/runner_is_ready; tail -f /dev/null ' + + doc-runner-webpack: + build: . volumes: - ../..:/mnt - snippets:/var/snippets - - doc-runner-webpack: - image: ghcr.io/puppeteer/puppeteer:23.5.1 - user: root + working_dir: /var/snippets/webpack command: > bash -c ' - mkdir -p /var/snippets/webpack; - apt-get update; - apt-get install -y curl; - npm install -g \ - eslint@8.38.0; - cd /var/snippets/webpack; cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/; cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/; - npm install \ - /mnt/ \ - puppeteer \ - babel-loader \ - @babel/core \ - html-webpack-plugin \ - webpack \ - webpack-cli \ - eslint \ - eslint-plugin-html \ - eslint-plugin-import \ - eslint-plugin-node \ - eslint-plugin-promise \ - eslint-plugin-standard; - touch /tmp/runner_ready_to_lint; - touch /tmp/runner_is_ready; + npm install /mnt/; + cp -fr /usr/local/lib/node_modules/* /var/snippets/web/node_modules; + cp -fr /usr/local/lib/node_modules/* /var/snippets/webpack/node_modules; + touch /home/node/runner_ready_to_lint; + touch /home/node/runner_is_ready; tail -f /dev/null ' - volumes: - - ../..:/mnt - - snippets:/var/snippets + volumes: snippets: diff --git a/.ci/doc/package.json b/.ci/doc/package.json index 9a193f572..a98376095 100644 --- a/.ci/doc/package.json +++ b/.ci/doc/package.json @@ -3,6 +3,7 @@ "version": "1.0.0", "description": "docs for kuzzle-sdk", "author": "The Kuzzle Team ", + "main": "index.js", "scripts": {}, "dependencies": {}, "devDependencies": {} diff --git a/.ci/doc/puppeteer.js b/.ci/doc/puppeteer.js index 6e7ef84b1..eb4558052 100644 --- a/.ci/doc/puppeteer.js +++ b/.ci/doc/puppeteer.js @@ -1,38 +1,60 @@ -const puppeteer = require('puppeteer'); +const puppeteer = require("puppeteer"); const renderedSnippetPath = process.argv[2]; -const runInBrowser = async snippetPath => { +const runInBrowser = async (snippetPath) => { let browser; - try { + // Install Chrome browser first + const { execSync } = require('child_process'); + execSync('npx puppeteer browsers install chrome', { stdio: 'inherit' }); + browser = await puppeteer.launch({ dumpio: true, - args: ['--no-sandbox'] + headless: "new", + // Remove executablePath to use the bundled Chromium + args: [ + "--no-sandbox", + "--disable-setuid-sandbox", + "--disable-gpu", + "--disable-dev-shm-usage", + ], }); } catch (error) { - console.error(error); - return; + console.error('Browser launch error:', error); + process.exit(1); } try { const page = await browser.newPage(); - page.on('error', err => { - console.error(err); + page.on("error", (err) => { + console.error('Page error:', err); }); - page.on('pageerror', err => { - console.error(err); + page.on("pageerror", (err) => { + console.error('Page error:', err); + }); + + page.on('console', msg => { + console.log('Page console:', msg.text()); }); await page.goto(`file:${snippetPath}`, { - waitUntil: 'networkidle0' + waitUntil: "networkidle0", + timeout: 30000, }); } catch (error) { - console.error(error); + console.error('Page processing error:', error); } finally { - await browser.close(); + if (browser) { + await browser.close(); + } } }; -runInBrowser(renderedSnippetPath); +if (!renderedSnippetPath) { + console.error('Please provide a path to the snippet file'); + process.exit(1); +} + +runInBrowser(renderedSnippetPath); \ No newline at end of file diff --git a/.ci/test-docs.sh b/.ci/test-docs.sh index 8ff1d1ad8..23c39b09f 100644 --- a/.ci/test-docs.sh +++ b/.ci/test-docs.sh @@ -5,7 +5,8 @@ set -ex here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" cd "$here" +docker compose -f ./doc/docker-compose.yml build docker compose -f ./doc/docker-compose.yml pull docker compose -f ./doc/docker-compose.yml run doc-tests node index EXIT=$? -docker compose -f ./doc/docker-compose.yml down +# docker compose -f ./doc/docker-compose.yml down diff --git a/src/utils/browser.js b/src/utils/browser.js new file mode 100644 index 000000000..3d81f11b6 --- /dev/null +++ b/src/utils/browser.js @@ -0,0 +1,40 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.isBrowser = exports.getBrowserWindow = void 0; +function getBrowserWindow() { + let windowObject; + try { + windowObject || (windowObject = globalThis.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = global.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = window); + if (windowObject) { + return windowObject; + } + } + catch { + // return undefined + } +} +exports.getBrowserWindow = getBrowserWindow; +function isBrowser() { + const window = getBrowserWindow(); + return window !== undefined && window !== null && typeof window === "object"; +} +exports.isBrowser = isBrowser; +//# sourceMappingURL=browser.js.map \ No newline at end of file From 102b22422b08adfb5d3d471d3d3ddf58bc1819df Mon Sep 17 00:00:00 2001 From: rolljee Date: Mon, 4 Nov 2024 21:09:26 +0100 Subject: [PATCH 25/29] fix(ci): Update ci to work with last version of puppeteer --- .ci/doc/config.yml | 22 +++++++++++----------- .ci/test-docs.sh | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml index 5af33babc..6ee9fee2b 100644 --- a/.ci/doc/config.yml +++ b/.ci/doc/config.yml @@ -5,18 +5,18 @@ snippets: templates: /mnt/.ci/doc/templates runners: - default: web + default: node - # node: - # service: doc-runner-node - # path: /var/snippets/node - # lint: - # global: true - # cmd: npx eslint@8.38.0 -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} - # before: timeout 600 ash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' - # run: - # cmd: node {{ snippet.source }} - # before: timeout 600 ash -c 'until stat /home/node/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' + node: + service: doc-runner-node + path: /var/snippets/node + lint: + global: true + cmd: npx eslint@8.38.0 -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} + before: timeout 600 ash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' + run: + cmd: node {{ snippet.source }} + before: timeout 600 ash -c 'until stat /home/node/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' web: service: doc-runner-web diff --git a/.ci/test-docs.sh b/.ci/test-docs.sh index 23c39b09f..7cb3854f4 100644 --- a/.ci/test-docs.sh +++ b/.ci/test-docs.sh @@ -9,4 +9,4 @@ docker compose -f ./doc/docker-compose.yml build docker compose -f ./doc/docker-compose.yml pull docker compose -f ./doc/docker-compose.yml run doc-tests node index EXIT=$? -# docker compose -f ./doc/docker-compose.yml down +docker compose -f ./doc/docker-compose.yml down From ff6b29fa81bf2f9c017a94d2e950ee8e9c3dae2c Mon Sep 17 00:00:00 2001 From: rolljee Date: Mon, 4 Nov 2024 21:10:33 +0100 Subject: [PATCH 26/29] fix(ci): Update ci to work with last version of puppeteer --- src/utils/browser.js | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 src/utils/browser.js diff --git a/src/utils/browser.js b/src/utils/browser.js deleted file mode 100644 index 3d81f11b6..000000000 --- a/src/utils/browser.js +++ /dev/null @@ -1,40 +0,0 @@ -"use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isBrowser = exports.getBrowserWindow = void 0; -function getBrowserWindow() { - let windowObject; - try { - windowObject || (windowObject = globalThis.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = global.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = window); - if (windowObject) { - return windowObject; - } - } - catch { - // return undefined - } -} -exports.getBrowserWindow = getBrowserWindow; -function isBrowser() { - const window = getBrowserWindow(); - return window !== undefined && window !== null && typeof window === "object"; -} -exports.isBrowser = isBrowser; -//# sourceMappingURL=browser.js.map \ No newline at end of file From c413283acd10c9bd10ac45f6ebac4aaf17a6bfe3 Mon Sep 17 00:00:00 2001 From: rolljee Date: Mon, 4 Nov 2024 21:55:30 +0100 Subject: [PATCH 27/29] fix(ci): Update ci to work with last version of puppeteer --- .ci/doc/config.yml | 4 ++-- src/utils/browser.js | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 src/utils/browser.js diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml index 6ee9fee2b..9dcbd9e18 100644 --- a/.ci/doc/config.yml +++ b/.ci/doc/config.yml @@ -13,10 +13,10 @@ runners: lint: global: true cmd: npx eslint@8.38.0 -c /mnt/.ci/doc/eslint.json {{ snippet.dir }} - before: timeout 600 ash -c 'until stat /home/node/runner_ready_to_lint; do sleep 1; done' + before: timeout 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done' run: cmd: node {{ snippet.source }} - before: timeout 600 ash -c 'until stat /home/node/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' + before: timeout 600 ash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done' web: service: doc-runner-web diff --git a/src/utils/browser.js b/src/utils/browser.js new file mode 100644 index 000000000..3d81f11b6 --- /dev/null +++ b/src/utils/browser.js @@ -0,0 +1,40 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.isBrowser = exports.getBrowserWindow = void 0; +function getBrowserWindow() { + let windowObject; + try { + windowObject || (windowObject = globalThis.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = global.window); + if (windowObject) { + return windowObject; + } + } + catch { + // Check next variable + } + try { + windowObject || (windowObject = window); + if (windowObject) { + return windowObject; + } + } + catch { + // return undefined + } +} +exports.getBrowserWindow = getBrowserWindow; +function isBrowser() { + const window = getBrowserWindow(); + return window !== undefined && window !== null && typeof window === "object"; +} +exports.isBrowser = isBrowser; +//# sourceMappingURL=browser.js.map \ No newline at end of file From f4962e4ec272d3c5441a59f29ce77c4b0e6cb8e0 Mon Sep 17 00:00:00 2001 From: rolljee Date: Mon, 4 Nov 2024 22:16:49 +0100 Subject: [PATCH 28/29] fix(ci): Update ci to work with last version of puppeteer --- src/utils/browser.js | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 src/utils/browser.js diff --git a/src/utils/browser.js b/src/utils/browser.js deleted file mode 100644 index 3d81f11b6..000000000 --- a/src/utils/browser.js +++ /dev/null @@ -1,40 +0,0 @@ -"use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isBrowser = exports.getBrowserWindow = void 0; -function getBrowserWindow() { - let windowObject; - try { - windowObject || (windowObject = globalThis.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = global.window); - if (windowObject) { - return windowObject; - } - } - catch { - // Check next variable - } - try { - windowObject || (windowObject = window); - if (windowObject) { - return windowObject; - } - } - catch { - // return undefined - } -} -exports.getBrowserWindow = getBrowserWindow; -function isBrowser() { - const window = getBrowserWindow(); - return window !== undefined && window !== null && typeof window === "object"; -} -exports.isBrowser = isBrowser; -//# sourceMappingURL=browser.js.map \ No newline at end of file From b5be1d66e5b03ac2344b58bd390fa238e1b1b01d Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Tue, 5 Nov 2024 09:59:37 +0000 Subject: [PATCH 29/29] chore(release): 7.14.0-beta.1 [skip ci] # [7.14.0-beta.1](https://github.com/kuzzleio/sdk-javascript/compare/v7.13.0...v7.14.0-beta.1) (2024-11-05) ### Bug Fixes * change options in the right object ([d193eda](https://github.com/kuzzleio/sdk-javascript/commit/d193eda82f7ccc8ef155f32a872fa0a27057dc49)) * **ci:** Update ci to work with last version of puppeteer ([f4962e4](https://github.com/kuzzleio/sdk-javascript/commit/f4962e4ec272d3c5441a59f29ce77c4b0e6cb8e0)) * **ci:** Update ci to work with last version of puppeteer ([c413283](https://github.com/kuzzleio/sdk-javascript/commit/c413283acd10c9bd10ac45f6ebac4aaf17a6bfe3)) * **ci:** Update ci to work with last version of puppeteer ([ff6b29f](https://github.com/kuzzleio/sdk-javascript/commit/ff6b29fa81bf2f9c017a94d2e950ee8e9c3dae2c)) * **ci:** Update ci to work with last version of puppeteer ([102b224](https://github.com/kuzzleio/sdk-javascript/commit/102b22422b08adfb5d3d471d3d3ddf58bc1819df)) * **ci:** Update ci to work with last version of puppeteer ([ad8e533](https://github.com/kuzzleio/sdk-javascript/commit/ad8e53374120f149661207ca291f50a85a8c2028)) * eslint ([adaf4e9](https://github.com/kuzzleio/sdk-javascript/commit/adaf4e962671faac2c252d1169a6c332205dc7aa)) * ignore external library linting ([f1e27d2](https://github.com/kuzzleio/sdk-javascript/commit/f1e27d29488aa9b704935eb1fec045f5832d4851)) * use root user in the new puppeteer images ([96306fa](https://github.com/kuzzleio/sdk-javascript/commit/96306fa77bcc80c6fc2e364501c63a5b55720e06)) * ws vulnerability ([afcf3ac](https://github.com/kuzzleio/sdk-javascript/commit/afcf3ac2d993d8c132a9b09a1e8f9fdcd99617cf)) ### Features * add options parameter to controller functions containing a query ([0aa4222](https://github.com/kuzzleio/sdk-javascript/commit/0aa42224e0684bed46c14b4810d0e210b3df1ec2)) ### Reverts * revert skipLibCheck and use a fixed eslint version instead ([fb9f599](https://github.com/kuzzleio/sdk-javascript/commit/fb9f59959d1304ce18af5a9c177f8cd3bd4d7084)) --- CHANGELOG.md | 26 ++++++++++++++++++++++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d62ef8ddf..681409160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,29 @@ +# [7.14.0-beta.1](https://github.com/kuzzleio/sdk-javascript/compare/v7.13.0...v7.14.0-beta.1) (2024-11-05) + + +### Bug Fixes + +* change options in the right object ([d193eda](https://github.com/kuzzleio/sdk-javascript/commit/d193eda82f7ccc8ef155f32a872fa0a27057dc49)) +* **ci:** Update ci to work with last version of puppeteer ([f4962e4](https://github.com/kuzzleio/sdk-javascript/commit/f4962e4ec272d3c5441a59f29ce77c4b0e6cb8e0)) +* **ci:** Update ci to work with last version of puppeteer ([c413283](https://github.com/kuzzleio/sdk-javascript/commit/c413283acd10c9bd10ac45f6ebac4aaf17a6bfe3)) +* **ci:** Update ci to work with last version of puppeteer ([ff6b29f](https://github.com/kuzzleio/sdk-javascript/commit/ff6b29fa81bf2f9c017a94d2e950ee8e9c3dae2c)) +* **ci:** Update ci to work with last version of puppeteer ([102b224](https://github.com/kuzzleio/sdk-javascript/commit/102b22422b08adfb5d3d471d3d3ddf58bc1819df)) +* **ci:** Update ci to work with last version of puppeteer ([ad8e533](https://github.com/kuzzleio/sdk-javascript/commit/ad8e53374120f149661207ca291f50a85a8c2028)) +* eslint ([adaf4e9](https://github.com/kuzzleio/sdk-javascript/commit/adaf4e962671faac2c252d1169a6c332205dc7aa)) +* ignore external library linting ([f1e27d2](https://github.com/kuzzleio/sdk-javascript/commit/f1e27d29488aa9b704935eb1fec045f5832d4851)) +* use root user in the new puppeteer images ([96306fa](https://github.com/kuzzleio/sdk-javascript/commit/96306fa77bcc80c6fc2e364501c63a5b55720e06)) +* ws vulnerability ([afcf3ac](https://github.com/kuzzleio/sdk-javascript/commit/afcf3ac2d993d8c132a9b09a1e8f9fdcd99617cf)) + + +### Features + +* add options parameter to controller functions containing a query ([0aa4222](https://github.com/kuzzleio/sdk-javascript/commit/0aa42224e0684bed46c14b4810d0e210b3df1ec2)) + + +### Reverts + +* revert skipLibCheck and use a fixed eslint version instead ([fb9f599](https://github.com/kuzzleio/sdk-javascript/commit/fb9f59959d1304ce18af5a9c177f8cd3bd4d7084)) + # [7.13.0](https://github.com/kuzzleio/sdk-javascript/compare/v7.12.0...v7.13.0) (2024-10-01) diff --git a/package-lock.json b/package-lock.json index 23f689a2e..4fb61303e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "kuzzle-sdk", - "version": "7.13.0", + "version": "7.14.0-beta.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "kuzzle-sdk", - "version": "7.13.0", + "version": "7.14.0-beta.1", "license": "Apache-2.0", "dependencies": { "min-req-promise": "^1.0.1", diff --git a/package.json b/package.json index 5c28db8fb..3e46895e6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "kuzzle-sdk", - "version": "7.13.0", + "version": "7.14.0-beta.1", "description": "Official Javascript SDK for Kuzzle", "author": "The Kuzzle Team ", "repository": {