ResolvedCollectionIndex
Defined in: packages/core/src/collections/resolveCollectionIndexes.ts:4
One index a collection declares, after precedence — exactly what the schema creates.
Properties
Section titled “Properties”draftStatus?
Section titled “draftStatus?”
optionaldraftStatus?:true|"both"
Defined in: packages/core/src/collections/resolveCollectionIndexes.ts:10
The draftStatus of whichever declaration won, if it set one.
fields
Section titled “fields”fields: readonly
string[]
Defined in: packages/core/src/collections/resolveCollectionIndexes.ts:8
Field keys in index order. Logical: a draftStatus index’s vex_status prefix is not included.
name:
string
Defined in: packages/core/src/collections/resolveCollectionIndexes.ts:6
The Convex index name, which withIndex names.
source
Section titled “source”source:
"commitTs"|"relationship"|"field"|"collection"
Defined in: packages/core/src/collections/resolveCollectionIndexes.ts:12
Which kind of declaration won.