Interface: PaginatedMeta

Hierarchy

Index

Properties

Properties

cacheExpiresAt

• cacheExpiresAt: number | null

Inherited from BaseMeta.cacheExpiresAt

When does the cache expire?

count

• count: number

Inherited from BaseMeta.count

How many items are there in the overall result data set.

dataType

• dataType: "stations" | "onair" | "ondemand" | "schedule" | "recommendations" | "categories"

Inherited from BaseMeta.dataType

Describes the data type returned

firstPage

• firstPage: boolean

For paginated data - is this the first page of available information?

fromCache

• fromCache: boolean

Inherited from BaseMeta.fromCache

Have cached values been returned?

lastPage

• lastPage: boolean

For paginated data - is this the last page of available information?

nesting

• nesting: boolean

Inherited from BaseMeta.nesting

Indicates that data is nested into collections of items on a per-station basis

pageNumber

• pageNumber: number

For paginated data - the current page of results. Starts at 0

pageSize

• pageSize: number

For paginated data - how many items will be returned per page of results.

paginated

• paginated: boolean

Inherited from BaseMeta.paginated

Indicates whether the results in the corresponding data field are a paginated subset of all possible results

totalPages

• totalPages: number

For paginated data - the total number of available pages of data.