@squidcloud/client 1.0.38 → 1.0.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -4,7 +4,8 @@ import { DocumentReference } from '../document-reference';
|
|
|
4
4
|
import { Alias } from './query.types';
|
|
5
5
|
/**
|
|
6
6
|
* A query builder that can participate in a join.
|
|
7
|
-
* To learn more about join queries, see
|
|
7
|
+
* To learn more about join queries, see
|
|
8
|
+
* {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
|
|
8
9
|
*/
|
|
9
10
|
export declare class JoinQueryBuilder<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType> | undefined>> {
|
|
10
11
|
private readonly collectionName;
|
|
@@ -28,8 +29,8 @@ export declare class JoinQueryBuilder<DocumentType extends DocumentData, MyAlias
|
|
|
28
29
|
*/
|
|
29
30
|
where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
|
|
30
31
|
/**
|
|
31
|
-
* Sets a limit to the number of results returned by the query. The maximum limit is
|
|
32
|
-
* none is provided.
|
|
32
|
+
* Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
|
|
33
|
+
* if none is provided.
|
|
33
34
|
*
|
|
34
35
|
* @param limit The maximum number of results to return
|
|
35
36
|
* @returns The query builder
|