Type Alias: ScanIndexOptions
ScanIndexOptions:
object
Options for scan when scanning over an index. When
scanning over and index you need to provide the indexName and the start
key is now a tuple consisting of secondary and primary key
Type declaration
indexName
indexName:
string
Do a scan over a named index. The indexName is
the name of an index defined when creating the Replicache instance using
ReplicacheOptions.indexes.
limit?
optionallimit:number
Only include up to limit results.
prefix?
optionalprefix:string
Only include results starting with the secondary keys starting with prefix.
start?
optionalstart:object
When provided the scan starts at this key.
start.exclusive?
optionalexclusive:boolean
Whether the key is exclusive or inclusive.