Skip to content
VexCMS

VexSearchArgs

Defined in: packages/core/src/collections/api/types.ts:470

Args for api.vex.search.

Indexable

Section titled “Indexable”

[key: string]: unknown

Properties

Section titled “Properties”

auth?

Section titled “auth?”

optional auth?: VexApiAuth

Defined in: packages/core/src/collections/api/types.ts:472

collection

Section titled “collection”

collection: string

Defined in: packages/core/src/collections/api/types.ts:473

depth?

Section titled “depth?”

optional depth?: number

Defined in: packages/core/src/collections/api/types.ts:479

drafts?

Section titled “drafts?”

optional drafts?: boolean

Defined in: packages/core/src/collections/api/types.ts:481

limit?

Section titled “limit?”

optional limit?: number

Defined in: packages/core/src/collections/api/types.ts:477

paginationOpts?

Section titled “paginationOpts?”

optional paginationOpts?: PaginationOptions

Defined in: packages/core/src/collections/api/types.ts:480

populate?

Section titled “populate?”

optional populate?: unknown

Defined in: packages/core/src/collections/api/types.ts:478

query

Section titled “query”

query: string

Defined in: packages/core/src/collections/api/types.ts:476

searchField

Section titled “searchField”

searchField: string

Defined in: packages/core/src/collections/api/types.ts:475

searchIndexName

Section titled “searchIndexName”

searchIndexName: string

Defined in: packages/core/src/collections/api/types.ts:474

where?

Section titled “where?”

optional where?: VexWhereNodeOf<unknown>

Defined in: packages/core/src/collections/api/types.ts:482