Class DocumentCatalogue

constructor

• new DocumentCatalogue(
      entries: CatalogueEntry[],
      options: CatalogueOptions,
  ): DocumentCatalogue

  Parameters

  • entries: CatalogueEntry[]
  • options: CatalogueOptions

  Returns DocumentCatalogue

ReadonlydateFieldLabel

convention

• get convention(): WeekStart

  Returns WeekStart

size

• get size(): number

  Returns number

count

• count(filter?: CatalogueFilter): number

  How many match, without building the documents.

  Parameters

  • filter: CatalogueFilter = {}

  Returns number

dayOf

• dayOf(entry: CatalogueEntry): string | null

  The day an entry falls on, in the catalogue's zone. A date-only value ignores the zone.

  Parameters

  • entry: CatalogueEntry

  Returns string | null

findDateSpan

• findDateSpan(): { first: string; last: string } | null

  The first and last day any document falls on, or null when none is dated.

  Returns { first: string; last: string } | null

latest

• latest(filter?: CatalogueFilter): CatalogueDocument | null

  The most recent DATED document, or null. Undated documents sort last and are never "latest".

  Parameters

  • filter: CatalogueFilter = {}

  Returns CatalogueDocument | null

names

• names(filter?: CatalogueFilter): CatalogueName[]

  One row per document name in scope, commonest first.

  Parameters

  • filter: CatalogueFilter = {}

  Returns CatalogueName[]

search

• search(filter?: CatalogueFilter): CatalogueDocument[]

  The documents matching a filter, oldest first. An empty result is an answer, not a failure.

  Parameters

  • filter: CatalogueFilter = {}

  Returns CatalogueDocument[]

stats

• stats(): CatalogueStats

  Returns CatalogueStats

types

• types(): CatalogueType[]

  One row per type, largest first.

  Returns CatalogueType[]