Class ResourceList<T>

Type Parameters

T extends DataModel

Hierarchy

ResourceList

Index

Constructors

constructor

Properties

Accessors

hasMore

Methods

Constructors

constructor

new ResourceList<T>(data: T[], fetchMore?: FetchMoreFn, cursor?: string): ResourceList<T>

- Defined in http/src/ResourceList.ts:17
Type Parameters
- T extends default<T>
Parameters
- data: T[]
- Optional fetchMore: FetchMoreFn
- Optional cursor: string
Returns ResourceList<T>

Properties

Private Optional cursor

cursor?: string

data

data: T[]

Private Optional fetchMore

fetchMore?: FetchMoreFn

Private Optional takeIterator

takeIterator?: AsyncGenerator<any, void, any>

Accessors

hasMore

get hasMore(): boolean

- Defined in http/src/ResourceList.ts:30
Returns boolean

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncGenerator<any, void, any>

- Defined in http/src/ResourceList.ts:34
Returns AsyncGenerator<any, void, any>

nextPage

nextPage(): Promise<ResourceList<T>>

- Defined in http/src/ResourceList.ts:23
Returns Promise<ResourceList<T>>

take

take(count: number): Promise<T[]>

- Defined in http/src/ResourceList.ts:43
Parameters
- count: number
Returns Promise<T[]>

takeJSON

takeJSON(count: number): Promise<Pick<T, Exclude<keyof T, "client">>[]>

- Defined in http/src/ResourceList.ts:61
Parameters
- count: number
Returns Promise<Pick<T, Exclude<keyof T, "client">>[]>

takeReset

takeReset(): void

- Defined in http/src/ResourceList.ts:57
Returns void

Generated using TypeDoc