Interface VaultIndex

API for efficiently accessing the notes of a Collection.

interface VaultIndex {
    addCollection<C extends Collection>(
        collection: C,
    ): VaultCollectionIndex<C>;
    getCollections(): Collection[];
    getCollectionsWithFile(filePath: string): Collection[];
}

Index

Methods

addCollection getCollections getCollectionsWithFile

Methods

addCollection

addCollection<C extends Collection>(collection: C): VaultCollectionIndex<C>
Register a new Collection into the index. All calls to this function will be treated as adding a brand new collection, regardless of whether the input has already been registered in an earlier call.
Type Parameters
- C extends Collection
Parameters
- collection: C
  the collection to register with this index.
Returns VaultCollectionIndex<C>
a VaultCollectionIndex that can be used to interact with the primary index.

Throws
if the index cannot support the given collection.
- Defined in src/model/index/schema.ts:16

getCollections

getCollections(): Collection[]
Returns Collection[]
the list of collections registered with this index.
- Defined in src/model/index/schema.ts:19

getCollectionsWithFile

getCollectionsWithFile(filePath: string): Collection[]
Parameters
- filePath: string
Returns Collection[]
the list of collections that claim to include the given file path.
- Defined in src/model/index/schema.ts:22