Class FacetsResponse<T>`Abstract`

Facet Result

Type Parameters

T extends HalResource

Hierarchy (View Summary)

Page<T>
- FacetsResponse

Index

Constructors

Properties

_facets? _links? page?

Methods

getFacets getItems performActionWithoutResourceResponse toJson toJSON

Constructors

constructor

new FacetsResponse<T extends HalResource>(
    key: string,
    resourceType: HalResourceConstructor<T>,
    data?: any,
): FacetsResponse<T>
Type Parameters
- T extends HalResource
Parameters
- key: string
- resourceType: HalResourceConstructor<T>
- Optionaldata: any
Returns FacetsResponse<T>
Inherited from Page.constructor
- Defined in src/lib/model/EmbeddedCollection.ts:13

Properties

`Optional`_facets

_facets?: Record<string, FacetCount[]>

Facet Metadata

`Optional`_links

_links?: Map<string, HalLink>

`Optional`page

page?: PageMetadata

Pagination Metadata

Methods

getFacets

getFacets(): Record<string, FacetCount[]>
Facet Metadata

Returns Record<string, FacetCount[]>
- Defined in src/lib/model/Facets.ts:72

getItems

getItems(): T[]
Returns T[]
Inherited from Page.getItems
- Defined in src/lib/model/EmbeddedCollection.ts:23

`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 Page.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 Page.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 Page.toJSON
- Defined in src/lib/model/EmbeddedCollection.ts:30