Interface CollectionConfig<D>

Configuration for a Collection; used in DatabaseConfig.

interface CollectionConfig<D extends CBLDictLike<D> = CBLDictionary> {
indexes?: (IndexConfig<D> | SchemaProperty<D>)[];
}

Type Parameters

D extends CBLDictLike<D> = CBLDictionary
An interface describing the schema of documents in this collection, i.e. the keys and their allowed value type(s).

Index

Properties

Properties

`Optional` `Readonly`indexes

indexes?: (IndexConfig<D> | SchemaProperty<D>)[]

Indexes to create. Each item may be a string denoting a property path (with keys separated by "."s) or an IndexConfig.