Class Page<T>

Paginated Result

Type parameters

T: HalResource

Hierarchy

EmbeddedCollection<T>
- Page
  - FacetsResponse

Index

Constructors

constructor

Properties

_links
page

Methods

Constructors

constructor

new Page(key: string, resourceType: HalResourceConstructor<T>, data?: any): Page

Inherited from EmbeddedCollection.__constructor

Overrides HalResource.constructor
- Defined in src/lib/model/EmbeddedCollection.ts:11
Parameters
- key: string
- resourceType: HalResourceConstructor<T>
- Optional data: any
Returns Page

Properties

Optional _links

_links: Map<string, HalLink>

Optional page

page: PageMetadata

Pagination Metadata

Methods

getItems

getItems(): T[]

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

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 EmbeddedCollection.toJSON

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