buildListViewSearchQueryArgs
buildListViewSearchQueryArgs<
TFieldSlug>(props):VexSearchArgs
Defined in: packages/core/src/collections/listView/listViewQueryArgs.ts:99
Builds the exact search Convex args for one list page — shared by useVexListQuery’s
search-mode branch (client, Step 8) and NextAdminPage’s prerender (server, Design
Decision 39). sort is never part of this call (Design Decision 7) — search results
are relevance-ordered.
Type Parameters
Section titled “Type Parameters”TFieldSlug
Section titled “TFieldSlug”TFieldSlug extends string = string
Parameters
Section titled “Parameters”BuildListViewSearchQueryArgsProps<TFieldSlug>
Input props.
Returns
Section titled “Returns”The args, ready for convexQuery(vexConvexApi.search, …) or
fetchQuery(vexConvexApi.search, …).
Throws
Section titled “Throws”When searchField names a field with no declared searchIndex —
validateSavedListViewConfig (Design Decision 3) already prevents this at config time, so
reaching it here means a caller bug, not a config gap.