Structured date field index with range filters and date histograms.
DateFieldIndex
Structured date field index with range filters and date histograms.
Declaration
class DateFieldIndex
Constructors
constructor
```ts
constructor(documents: Record): DateFieldIndex
```
Parameters:
- `documents: Record`Members
indexState
```ts
get indexState(): DateFieldIndexState
```loadState
```ts
loadState(fieldIndexState: IndexState): FieldIndex
```
Parameters:
- `fieldIndexState: IndexState`indexValue
```ts
indexValue(docId: string, value: string): void
```
Parameters:
- `docId: string`
- `value: string`numericValues
```ts
numericValues(docId: string): number[]
```
Parameters:
- `docId: string`filterRange
```ts
filterRange(params: { lt?: string; lte?: string; gt?: string; gte?: string }): Hits
```
Parameters:
- `params: { lt?: string; lte?: string; gt?: string; gte?: string }`valueCount
```ts
valueCount(subsetDocIds?: Set): number
```
Parameters:
- `subsetDocIds?: Set`min
```ts
min(subsetDocIds?: Set): number | null
```
Parameters:
- `subsetDocIds?: Set`max
```ts
max(subsetDocIds?: Set): number | null
```
Parameters:
- `subsetDocIds?: Set`sum
```ts
sum(subsetDocIds?: Set): number
```
Parameters:
- `subsetDocIds?: Set`avg
```ts
avg(subsetDocIds?: Set): number | null
```
Parameters:
- `subsetDocIds?: Set`stats
```ts
stats(subsetDocIds?: Set): NumericStatsAggregation
```
Parameters:
- `subsetDocIds?: Set`rangeAggregation
```ts
rangeAggregation(ranges: NumericRangeAggregationRange[], subsetDocIds?: Set): NumericRangeAggregationBucket[]
```
Parameters:
- `ranges: NumericRangeAggregationRange[]`
- `subsetDocIds?: Set`dateHistogram
```ts
dateHistogram(intervalMs: number, subsetDocIds?: Set): DateHistogramBucket[]
```
Parameters:
- `intervalMs: number`
- `subsetDocIds?: Set`