Class SearchIndexTopHits

Class representing top hits for an Algolia Search Index

Hierarchy (View Summary)

HalResource
- SearchIndexTopHits

Index

Constructors

Properties

_links? count hit

Methods

performActionWithoutResourceResponse toJson toJSON

Constructors

constructor

new SearchIndexTopHits(data?: any): SearchIndexTopHits
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
- Optionaldata: any
Returns SearchIndexTopHits
Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:35

Properties

`Optional`_links

_links?: Map<string, HalLink>

count

count: number

The number of hits

hit

hit: string

Record ObjectID that matched the search

Methods

`Protected`performActionWithoutResourceResponse

performActionWithoutResourceResponse(
    name: string,
    params: any,
    data: any,
    method?: POST | PUT | PATCH,
): Promise<void>
POST to an action endpoint with no resource response returned.
Parameters
- name: string
- params: any
- data: any
- method: POST | PUT | PATCH = HttpMethod.POST
Returns Promise<void>
Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:154

toJson

toJson(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Deprecated
Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:64

toJSON

toJSON(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:52