Interface VaultCollectionIndex<C>

Provides an API for efficiently querying a Collection for its notes.

interface VaultCollectionIndex<C extends Collection> {
    collection: DeepReadonly<C>;
    getNotes(): string[];
    getNotesFromInterval(interval: Interval): string[];
}

Type Parameters

C extends Collection

Index

Properties

Methods

getNotes getNotesFromInterval

Properties

`Readonly`collection

collection: DeepReadonly<C>

The collection that has been indexed.

Methods

getNotes

getNotes(): string[]
Returns string[]
all paths in the vault corresponding to this indexed collection.
- Defined in src/model/index/schema.ts:31

getNotesFromInterval

getNotesFromInterval(interval: Interval): string[]
Parameters
- interval: Interval
Returns string[]
all paths in the vault corresponding to the given interval, if applicable.
- Defined in src/model/index/schema.ts:34