Skip to main content

Interface: ClusterOptionsResponse

Defined in: type/ClusterOptionsResponse.ts:5

Object class for ClusterOptionsResponse

Properties​

end​

end: number

Defined in: type/ClusterOptionsResponse.ts:19

Ending index for current page


items​

items: ClusterOption[]

Defined in: type/ClusterOptionsResponse.ts:7

Items returned by the query for the current page.


itemsFound​

itemsFound: number

Defined in: type/ClusterOptionsResponse.ts:9

Total number of items found


offset?​

optional offset?: number

Defined in: type/ClusterOptionsResponse.ts:11

Number of items to skip


page?​

optional page?: number

Defined in: type/ClusterOptionsResponse.ts:13

Current page number (1-based)


pages​

pages: number

Defined in: type/ClusterOptionsResponse.ts:15

Total number of pages


start​

start: number

Defined in: type/ClusterOptionsResponse.ts:17

Starting index for current page