@itwin/core-common 3.5.0-dev.60 → 3.5.0-dev.63

package/lib/cjs/ConcurrentQuery.d.ts

@@ -80,6 +80,12 @@ export interface BaseReaderOptions {
     usePrimaryConn?: boolean;
     /** Restrict time or memory for query but use as hint and may be changed base on backend settings */
     quota?: QueryQuota;
+    /**
+     * @internal
+     * Allow query to be be deferred by milliseconds specified. This parameter is ignore by default unless
+     * concurrent query is configure to honour it.
+     */
+    delay?: number;
 }
 /**
  * ECSql query config
@@ -122,44 +128,210 @@ export declare class QueryOptionsBuilder {
     private _options;
     constructor(_options?: QueryOptions);
     getOptions(): QueryOptions;
+    /**
+     * @internal
+     * Allow to set priority of query. Query will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
+     * @param val integer value which can be negative as well. By default its zero.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setPriority(val: number): this;
+    /**
+     * Allow to set restart token. If restart token is set then any other query(s) in queue with same token is cancelled if its not already executed.
+     * @param val A string token identifying a use case in which previous query with same token is cancelled.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setRestartToken(val: string): this;
+    /**
+     * Allow to set quota restriction for query. Its a hint and may be overriden or ignored by concurrent query manager.
+     * @param val @type QueryQuota Specify time and memory that can be used by a query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setQuota(val: QueryQuota): this;
+    /**
+     * Force a query to be executed synchronously against primary connection. This option is ignored if provided by frontend.
+     * @param val A boolean value to force use primary connection on main thread to execute query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setUsePrimaryConnection(val: boolean): this;
+    /**
+     * By default all blobs are abbreviated to save memory and network bandwidth. If set to false, all blob data will be returned by query as is.
+     * Use @type BlobReader to access blob data more efficiently.
+     * @param val A boolean value, if set to false will return complete blob type property data. This could cost time and network bandwidth.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setAbbreviateBlobs(val: boolean): this;
+    /**
+     * When query fail to prepare it will log error. This setting will suppress log errors in case where query come from user typing it and its expected to fail often.
+     * @param val A boolean value, if set to true, any error logging will be suppressed.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setSuppressLogErrors(val: boolean): this;
+    /**
+     * If set ECClassId, SourceECClassId and TargetECClassId system properties will return qualified name of class instead of a @typedef Id64String.
+     * @param val A boolean value.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setConvertClassIdsToNames(val: boolean): this;
+    /**
+     * Specify limit for query. Limit determine number of rows and offset in result-set.
+     * @param val Specify count and offset from within the result-set of a ECSQL query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setLimit(val: QueryLimit): this;
+    /**
+     * Specify row format returned by concurrent query manager.
+     * @param val @enum QueryRowFormat specifying format for result.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setRowFormat(val: QueryRowFormat): this;
+    /**
+     * @internal
+     * Defers execution of query in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
+     * @param val Number of milliseconds.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
+    setDelay(val: number): this;
 }
 /** @beta */
 export declare class BlobOptionsBuilder {
     private _options;
     constructor(_options?: BlobOptions);
     getOptions(): BlobOptions;
+    /**
+     * @internal
+     * Allow to set priority of blob request. Blob request will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
+     * @param val integer value which can be negative as well. By default its zero.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setPriority(val: number): this;
+    /**
+     * Allow to set restart token. If restart token is set then any other blob request in queue with same token is cancelled if its not already executed.
+     * @param val A string token identifying a use case in which previous blob request with same token is cancelled.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setRestartToken(val: string): this;
+    /**
+     * Allow to set quota restriction for blob request. Its a hint and may be overriden or ignored by concurrent query manager.
+     * @param val @type QueryQuota Specify time and memory that can be used by a query.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setQuota(val: QueryQuota): this;
+    /**
+     * Force a blob request to be executed synchronously against primary connection. This option is ignored if provided by frontend.
+     * @param val A boolean value to force use primary connection on main thread to execute blob request.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setUsePrimaryConnection(val: boolean): this;
+    /**
+     * Specify range with in the blob that need to be returned.
+     * @param val Specify offset and count of bytes that need to be returned.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setRange(val: BlobRange): this;
+    /**
+     * @internal
+     * Defers execution of blob request in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
+     * @param val Number of milliseconds.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
+    setDelay(val: number): this;
 }
-/** @public */
+/**
+ * @public
+ * QueryBinder allow to bind values to a ECSQL query.
+ * */
 export declare class QueryBinder {
     private _args;
     private verify;
+    /**
+     * Bind boolean value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Boolean value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindBoolean(indexOrName: string | number, val: boolean): this;
+    /**
+     * Bind blob value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Blob value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindBlob(indexOrName: string | number, val: Uint8Array): this;
+    /**
+     * Bind double value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Double value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindDouble(indexOrName: string | number, val: number): this;
+    /**
+     * Bind @typedef Id64String value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @typedef Id64String value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindId(indexOrName: string | number, val: Id64String): this;
+    /**
+     * Bind @type OrderedId64Iterable to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type OrderedId64Iterable value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindIdSet(indexOrName: string | number, val: OrderedId64Iterable): this;
+    /**
+     * Bind integer to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Integer value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindInt(indexOrName: string | number, val: number): this;
+    /**
+     * Bind struct to ECSQL statement. Struct specified as object.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val struct value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindStruct(indexOrName: string | number, val: object): this;
+    /**
+     * Bind long to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Long value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindLong(indexOrName: string | number, val: number): this;
+    /**
+     * Bind string to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val String value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindString(indexOrName: string | number, val: string): this;
+    /**
+     * Bind null to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindNull(indexOrName: string | number): this;
+    /**
+     * Bind @type Point2d to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type Point2d  value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindPoint2d(indexOrName: string | number, val: Point2d): this;
+    /**
+     * Bind @type Point3d to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type Point3d  value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindPoint3d(indexOrName: string | number, val: Point3d): this;
     private static bind;
+    /**
+     * Allow bulk bind either parameters by index as value array or by parameter names as object.
+     * @param args if array of values is provided then array index is used as index. If object is provided then object property name is used as parameter name of reach value.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     static from(args: any[] | object | undefined): QueryBinder;
     serialize(): object;
 }
@@ -239,4 +411,12 @@ export declare class DbQueryError extends BentleyError {
 export interface DbRequestExecutor<TRequest extends DbRequest, TResponse extends DbResponse> {
     execute(request: TRequest): Promise<TResponse>;
 }
+/** @internal */
+export interface DbQueryConfig {
+    globalQuota?: QueryQuota;
+    ignoreDelay?: boolean;
+    ignorePriority?: boolean;
+    requestQueueSize?: number;
+    workerThreads?: number;
+}
 //# sourceMappingURL=ConcurrentQuery.d.ts.map

package/lib/cjs/ConcurrentQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AACD;;;;KAIK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAI3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IAIxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAIpC,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAI/B,oBAAoB,CAAC,GAAG,EAAE,OAAO;IAIjC,yBAAyB,CAAC,GAAG,EAAE,OAAO;IAItC,QAAQ,CAAC,GAAG,EAAE,UAAU;IAIxB,YAAY,CAAC,GAAG,EAAE,cAAc;CAKxC;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAI3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IAIxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAIpC,QAAQ,CAAC,GAAG,EAAE,SAAS;CAI/B;AAmBD,cAAc;AACd,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWP,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAYtD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAYtD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAWpD,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAYhE,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWjD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWlD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAWrC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAWtD,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;WAuBL,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AACD,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD"}
+{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD;;;;KAIK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IACjC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;;OAKG;IACI,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAItC;;;;OAIG;IACI,oBAAoB,CAAC,GAAG,EAAE,OAAO;IAIxC;;;;OAIG;IACI,yBAAyB,CAAC,GAAG,EAAE,OAAO;IAI7C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,cAAc;IAIvC;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IAChC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,SAAS;IAI9B;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AAmBD;;;KAGK;AACL,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWd;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAY7D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAY7D;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;;OAKG;IACI,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAW3D;;;;;OAKG;IACI,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAYvE;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWxD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWzD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;OAIG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAW5C;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;IAuBnB;;;;OAIG;WACW,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AACD,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/lib/cjs/ConcurrentQuery.js

@@ -39,42 +39,99 @@ class QueryOptionsBuilder {
         this._options = _options;
     }
     getOptions() { return this._options; }
+    /**
+     * @internal
+     * Allow to set priority of query. Query will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
+     * @param val integer value which can be negative as well. By default its zero.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setPriority(val) {
         this._options.priority = val;
         return this;
     }
+    /**
+     * Allow to set restart token. If restart token is set then any other query(s) in queue with same token is cancelled if its not already executed.
+     * @param val A string token identifying a use case in which previous query with same token is cancelled.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setRestartToken(val) {
         this._options.restartToken = val;
         return this;
     }
+    /**
+     * Allow to set quota restriction for query. Its a hint and may be overriden or ignored by concurrent query manager.
+     * @param val @type QueryQuota Specify time and memory that can be used by a query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setQuota(val) {
         this._options.quota = val;
         return this;
     }
+    /**
+     * Force a query to be executed synchronously against primary connection. This option is ignored if provided by frontend.
+     * @param val A boolean value to force use primary connection on main thread to execute query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setUsePrimaryConnection(val) {
         this._options.usePrimaryConn = val;
         return this;
     }
+    /**
+     * By default all blobs are abbreviated to save memory and network bandwidth. If set to false, all blob data will be returned by query as is.
+     * Use @type BlobReader to access blob data more efficiently.
+     * @param val A boolean value, if set to false will return complete blob type property data. This could cost time and network bandwidth.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setAbbreviateBlobs(val) {
         this._options.abbreviateBlobs = val;
         return this;
     }
+    /**
+     * When query fail to prepare it will log error. This setting will suppress log errors in case where query come from user typing it and its expected to fail often.
+     * @param val A boolean value, if set to true, any error logging will be suppressed.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setSuppressLogErrors(val) {
         this._options.suppressLogErrors = val;
         return this;
     }
+    /**
+     * If set ECClassId, SourceECClassId and TargetECClassId system properties will return qualified name of class instead of a @typedef Id64String.
+     * @param val A boolean value.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setConvertClassIdsToNames(val) {
         this._options.convertClassIdsToClassNames = val;
         return this;
     }
+    /**
+     * Specify limit for query. Limit determine number of rows and offset in result-set.
+     * @param val Specify count and offset from within the result-set of a ECSQL query.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setLimit(val) {
         this._options.limit = val;
         return this;
     }
+    /**
+     * Specify row format returned by concurrent query manager.
+     * @param val @enum QueryRowFormat specifying format for result.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
     setRowFormat(val) {
         this._options.rowFormat = val;
         return this;
     }
+    /**
+     * @internal
+     * Defers execution of query in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
+     * @param val Number of milliseconds.
+     * @returns @type QueryOptionsBuilder for fluent interface.
+     */
+    setDelay(val) {
+        this._options.delay = val;
+        return this;
+    }
 }
 exports.QueryOptionsBuilder = QueryOptionsBuilder;
 /** @beta */
@@ -83,26 +140,62 @@ class BlobOptionsBuilder {
         this._options = _options;
     }
     getOptions() { return this._options; }
+    /**
+     * @internal
+     * Allow to set priority of blob request. Blob request will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
+     * @param val integer value which can be negative as well. By default its zero.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setPriority(val) {
         this._options.priority = val;
         return this;
     }
+    /**
+     * Allow to set restart token. If restart token is set then any other blob request in queue with same token is cancelled if its not already executed.
+     * @param val A string token identifying a use case in which previous blob request with same token is cancelled.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setRestartToken(val) {
         this._options.restartToken = val;
         return this;
     }
+    /**
+     * Allow to set quota restriction for blob request. Its a hint and may be overriden or ignored by concurrent query manager.
+     * @param val @type QueryQuota Specify time and memory that can be used by a query.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setQuota(val) {
         this._options.quota = val;
         return this;
     }
+    /**
+     * Force a blob request to be executed synchronously against primary connection. This option is ignored if provided by frontend.
+     * @param val A boolean value to force use primary connection on main thread to execute blob request.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setUsePrimaryConnection(val) {
         this._options.usePrimaryConn = val;
         return this;
     }
+    /**
+     * Specify range with in the blob that need to be returned.
+     * @param val Specify offset and count of bytes that need to be returned.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
     setRange(val) {
         this._options.range = val;
         return this;
     }
+    /**
+     * @internal
+     * Defers execution of blob request in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
+     * @param val Number of milliseconds.
+     * @returns @type BlobOptionsBuilder for fluent interface.
+     */
+    setDelay(val) {
+        this._options.delay = val;
+        return this;
+    }
 }
 exports.BlobOptionsBuilder = BlobOptionsBuilder;
 /** @internal */
@@ -123,7 +216,10 @@ var QueryParamType;
     QueryParamType[QueryParamType["Blob"] = 10] = "Blob";
     QueryParamType[QueryParamType["Struct"] = 11] = "Struct";
 })(QueryParamType || (QueryParamType = {}));
-/** @public */
+/**
+ * @public
+ * QueryBinder allow to bind values to a ECSQL query.
+ * */
 class QueryBinder {
     constructor() {
         this._args = {};
@@ -139,6 +235,12 @@ class QueryBinder {
             }
         }
     }
+    /**
+     * Bind boolean value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Boolean value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindBoolean(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -151,6 +253,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind blob value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Blob value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindBlob(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -163,6 +271,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind double value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Double value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindDouble(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -174,6 +288,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind @typedef Id64String value to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @typedef Id64String value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindId(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -185,6 +305,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind @type OrderedId64Iterable to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type OrderedId64Iterable value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindIdSet(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -197,6 +323,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind integer to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Integer value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindInt(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -208,6 +340,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind struct to ECSQL statement. Struct specified as object.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val struct value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindStruct(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -219,6 +357,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind long to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val Long value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindLong(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -230,6 +374,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind string to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val String value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindString(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -241,6 +391,11 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind null to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindNull(indexOrName) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -252,6 +407,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind @type Point2d to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type Point2d  value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindPoint2d(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -263,6 +424,12 @@ class QueryBinder {
         });
         return this;
     }
+    /**
+     * Bind @type Point3d to ECSQL statement.
+     * @param indexOrName Specify parameter index or its name used in ECSQL statement.
+     * @param val @type Point3d  value to bind to ECSQL statement.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     bindPoint3d(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
@@ -306,6 +473,11 @@ class QueryBinder {
             throw new Error("unsupported type");
         }
     }
+    /**
+     * Allow bulk bind either parameters by index as value array or by parameter names as object.
+     * @param args if array of values is provided then array index is used as index. If object is provided then object property name is used as parameter name of reach value.
+     * @returns @type QueryBinder to allow fluent interface.
+     */
     static from(args) {
         const params = new QueryBinder();
         if (typeof args === "undefined")