SearchClientArgs
Defined in: packages/core/src/api/search/client.ts:24
Client-side args for search. Extends GenericQueryClientParams
to inherit ctx?: never and populate?: TPopulate.
Extends
Section titled “Extends”GenericQueryClientParams<TCollectionSlug,TPopulate,D>
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug
Collection slug.
TPopulate
Section titled “TPopulate”TPopulate extends PopulateShape<TCollectionSlug>
Populate object.
D extends number = number
Properties
Section titled “Properties”
optionalauth?:undefined
Defined in: packages/core/src/api/types.ts:167
Discriminator: client args MUST NOT supply auth.
Inherited from
Section titled “Inherited from”collection
Section titled “collection”collection:
TCollectionSlug
Defined in: packages/core/src/api/search/client.ts:29
optionalctx?:undefined
Defined in: packages/core/src/api/types.ts:169
Discriminator: client args MUST NOT supply ctx.
Inherited from
Section titled “Inherited from”depth?
Section titled “depth?”
optionaldepth?:D
Defined in: packages/core/src/api/types.ts:183
Auto-populate all relationship fields to this many levels.
Inferred as the literal D so a wrapper that threads D through to its
return type narrows accordingly (depth: 2 → depth-populated doc). A
non-literal number degrades to VexDocument via DepthPopulated’s
guard. D defaults to number, so wrappers that do not thread it keep the
plain passthrough they had before.
Use populate for documented consumer code; depth is internal.
Inherited from
Section titled “Inherited from”GenericQueryClientParams.depth
limit?
Section titled “limit?”
optionallimit?:number
Defined in: packages/core/src/api/search/client.ts:33
paginationOpts?
Section titled “paginationOpts?”
optionalpaginationOpts?:PaginationOptions
Defined in: packages/core/src/api/search/client.ts:34
populate?
Section titled “populate?”
optionalpopulate?:TPopulate
Defined in: packages/core/src/api/types.ts:171
Recursive populate object, type-narrowed against RelationshipKeysOf<TCollectionSlug>.
Inherited from
Section titled “Inherited from”GenericQueryClientParams.populate
query:
string
Defined in: packages/core/src/api/search/client.ts:30
searchField
Section titled “searchField”searchField:
string
Defined in: packages/core/src/api/search/client.ts:32
searchIndexName
Section titled “searchIndexName”searchIndexName:
string
Defined in: packages/core/src/api/search/client.ts:31
optionalskip?:boolean
Defined in: packages/core/src/api/types.ts:189
When true, the wrapper passes convexQuery’s "skip" sentinel instead of
args, so the query is not issued. Use for conditional queries (e.g. an id
that is not known yet) without violating the Rules of Hooks.