Skip to main content

Interface: FacetedSearchResults

Defined in: src/types/interfaces/search.interface.ts:228

Faceted search results with aggregations.

Extends​

Properties​

facets​

readonly facets: Record<string, readonly object[]>

Defined in: src/types/interfaces/search.interface.ts:245

Facet aggregations.

Remarks​

Maps facet dimension to value counts.

Example:

{
  "subjects": [
    { value: "Computer Science", count: 150 },
    { value: "Biology", count: 120 }
  ]
}

hits​

readonly hits: readonly object[]

Defined in: src/types/interfaces/search.interface.ts:167

Search hits (matching documents).

Inherited from​

SearchResults.hits

took​

readonly took: number

Defined in: src/types/interfaces/search.interface.ts:202

Query execution time in milliseconds.

Inherited from​

SearchResults.took

total​

readonly total: number

Defined in: src/types/interfaces/search.interface.ts:197

Total number of matching documents.

Inherited from​

SearchResults.total