Class SearchIndexStatistics

Class representing Statistics for an Algolia Search Index

Hierarchy

HalResource
- SearchIndexStatistics

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SearchIndexStatistics(data?: any): SearchIndexStatistics

Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:28
Creates a new instance of the resource. If data is provided it will be parsed as if it had come from the remote api.

Parameters
- Optional data: any
Returns SearchIndexStatistics

Properties

Optional _links

_links: Map<string, HalLink>

Optional averageRecordSize

averageRecordSize: number

Average size of an index record (in bytes).

Optional totalRecordSize

totalRecordSize: number

Total size of records (in bytes).

Optional totalRecords

totalRecords: number

Total number of records within an index.

Optional usage

usage: SearchIndexStatisticsUsage

Usage statistics for an index.

Methods

Protected performActionWithoutResourceResponse

performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:155
POST to an action endpoint with no resource response returned.

Parameters
- name: string
- params: any
- data: any
- Default value method: POST | PATCH | PUT = HttpMethod.POST
Returns Promise<void>

toJSON

toJSON(): any

Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:53
Returns a copy of this resource's attributes excluding links and client references

Returns any

toJson

toJson(): any

Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:65
Returns a copy of this resource's attributes excluding links and client references

deprecated

Returns any

Generated using TypeDoc