@squidcloud/client 1.0.336 → 1.0.337

package/dist/internal-common/src/public-types/integrations/api.public-types.d.ts

@@ -18,7 +18,7 @@ export interface CallApiOptions {
     /** If true, the response will be returned as-is without any processing. */
     nativeResponse?: boolean;
     /**
-     * An optional string to override the default origin of the API (e.g. https://host:port). Useful for
+     * An optional string to override the default origin of the API (e.g. `https://host:port`). Useful for
      * scenarios such as testing, development, or accessing the API from different environments.
      */
     originOverride?: string;

package/dist/internal-common/src/public-types/metric.public-types.d.ts

@@ -50,7 +50,7 @@ export interface QueryMetricsRequestCommon {
      * even if there is no data for some values in the database.
      *
      * Example: Consider a tag 'isError' with two possible values: '0' and '1'.
-     * When 'tagDomains' contains {'isError': ['0', '1']}, the result will include
+     * When 'tagDomains' contains `{'isError': ['0', '1']}`, the result will include
      * groups for both 'isError: 0' and 'isError: 1'. If the database lacks data for
      * 'isError: 1', the points in this group will be set to 'fillValue' (default is 'null').
      *

package/dist/typescript-client/src/query/query-builder.factory.d.ts

@@ -27,7 +27,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      */
     abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
-     * A shortcut for where(fieldName, '==', value)
+     * A shortcut for `where(fieldName, '==', value)`
      *
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
@@ -35,56 +35,56 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      */
     eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, '!=', value)
+     * A shortcut for `where(fieldName, '!=', value)`
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
      * @returns The query builder.
      */
     neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, 'in', value)
+     * A shortcut for `where(fieldName, 'in', value)`
      * @param fieldName The name of the field to query.
      * @param value An array of values to compare against.
      * @returns The query builder.
      */
     in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
     /**
-     * A shortcut for where(fieldName, 'not in', value)
+     * A shortcut for `where(fieldName, 'not in', value)`
      * @param fieldName The name of the field to query.
      * @param value An array of values to compare against.
      * @returns The query builder.
      */
     nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
     /**
-     * A shortcut for where(fieldName, '>', value)
+     * A shortcut for `where(fieldName, '>', value)`
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
      * @returns The query builder.
      */
     gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, '>=', value)
+     * A shortcut for `where(fieldName, '>=', value)`
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
      * @returns The query builder.
      */
     gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, '<', value)
+     * A shortcut for `where(fieldName, '<', value)`
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
      * @returns The query builder.
      */
     lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, '<=', value)
+     * A shortcut for `where(fieldName, '<=', value)`
      * @param fieldName The name of the field to query.
      * @param value The value to compare against.
      * @returns The query builder.
      */
     lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
-     * A shortcut for where(fieldName, 'like', pattern).
+     * A shortcut for `where(fieldName, 'like', pattern).`
      *
      * @param fieldName The name of the field to query.
      * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one
@@ -95,7 +95,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      */
     like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
     /**
-     * A shortcut for where(fieldName, 'not like', pattern).
+     * A shortcut for `where(fieldName, 'not like', pattern).`
      *
      * @param fieldName The name of the field to query.
      * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one

package/dist/typescript-client/src/query/query.types.d.ts

@@ -24,7 +24,7 @@ export interface OngoingQuery {
     subscribe: boolean;
     /**
      * In case of joins, and if this ongoing query is the root, this field emits all the supported observables
-     * for example A.join(B, {...some join condition...}).join(C, {...some join condition}.
+     * for example `A.join(B, {...some join condition...}).join(C, {...some join condition}`.
      * This field will emit [A.subject.pipe(), B.subject.pipe(), C.subject.pipe()]. Any new supported queries will be
      * added here.
      */

package/dist/typescript-client/src/version.d.ts

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.336";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.337";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.336",
+  "version": "1.0.337",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",