Skip to content

pbvex / server / IndexRangeBuilder

Interface: IndexRangeBuilder<TableName, DataModel, IndexFields, FieldNum>

Extends

Type Parameters

TableName

TableName extends string

DataModel

DataModel extends GenericDataModel

IndexFields

IndexFields extends readonly string[]

FieldNum

FieldNum extends number = 0

Methods

eq()

eq(fieldName, value): PlusOne<FieldNum> extends IndexFields["length"] ? IndexRange : IndexRangeBuilder<TableName, DataModel, IndexFields, PlusOne<FieldNum>>

Parameters

fieldName

IndexFields[FieldNum]

value

FieldTypeFromFieldPath<DocumentByName<DataModel, TableName>, IndexFields[FieldNum]>

Returns

PlusOne<FieldNum> extends IndexFields["length"] ? IndexRange : IndexRangeBuilder<TableName, DataModel, IndexFields, PlusOne<FieldNum>>


gt()

gt(fieldName, value): UpperBoundIndexRangeBuilder<TableName, DataModel, IndexFields[FieldNum]>

Parameters

fieldName

IndexFields[FieldNum]

value

FieldTypeFromFieldPath<DocumentByName<DataModel, TableName>, IndexFields[FieldNum]>

Returns

UpperBoundIndexRangeBuilder<TableName, DataModel, IndexFields[FieldNum]>

Inherited from

LowerBoundIndexRangeBuilder.gt


gte()

gte(fieldName, value): UpperBoundIndexRangeBuilder<TableName, DataModel, IndexFields[FieldNum]>

Parameters

fieldName

IndexFields[FieldNum]

value

FieldTypeFromFieldPath<DocumentByName<DataModel, TableName>, IndexFields[FieldNum]>

Returns

UpperBoundIndexRangeBuilder<TableName, DataModel, IndexFields[FieldNum]>

Inherited from

LowerBoundIndexRangeBuilder.gte


lt()

lt(fieldName, value): IndexRange

Parameters

fieldName

IndexFields[FieldNum]

value

FieldTypeFromFieldPath<DocumentByName<DataModel, TableName>, IndexFields[FieldNum]>

Returns

IndexRange

Inherited from

LowerBoundIndexRangeBuilder.lt


lte()

lte(fieldName, value): IndexRange

Parameters

fieldName

IndexFields[FieldNum]

value

FieldTypeFromFieldPath<DocumentByName<DataModel, TableName>, IndexFields[FieldNum]>

Returns

IndexRange

Inherited from

LowerBoundIndexRangeBuilder.lte

Generated API reference. Source of truth is the codebase.