Class GetCursor<T>

Wrapper around a REST GET request

Type Parameters

T

Hierarchy

GetCursor

Index

Constructors

Properties

client continuationToken hasNextBatch query resource

Methods

batchesEmpty forEach getContinuationToken nextBatch toArray

Constructors

constructor

new GetCursor<T>(client: Pick<main, "request">, resource: string, query?: URLSearchParams): GetCursor<T>
Type Parameters
- T
Parameters
- client: Pick<main, "request">
- resource: string
- query: URLSearchParams = ...
Returns GetCursor<T>
- Defined in src/rest.ts:80

Properties

`Readonly` client

client: Pick<main, "request">

`Private` continuationToken

continuationToken: null | Partial<T> = null

`Private` hasNextBatch

hasNextBatch: boolean = true

`Readonly` query

query: URLSearchParams = ...

`Readonly` resource

resource: string

Methods

batchesEmpty

batchesEmpty(): boolean
Returns
boolean

Returns boolean
- Defined in src/rest.ts:130

forEach

forEach<R>(fn: ((t: T) => R)): Promise<void>
Run the provided function for each element in the cursor.

Returns
Promise
Type Parameters
- R
Parameters
- fn: ((t: T) => R)
  
  callback function
  - - (t: T): R
    - Parameters
      
      t: T
      
      Returns R
Returns Promise<void>
- Defined in src/rest.ts:140

getContinuationToken

getContinuationToken(): null | Partial<T>
Returns
continuation token

Returns null | Partial<T>
- Defined in src/rest.ts:124

nextBatch

nextBatch(): Promise<GetCursorBatch<T>>
Returns
Promise of next batch in iterator

Returns Promise<GetCursorBatch<T>>
- Defined in src/rest.ts:89

toArray

toArray(): Promise<T[]>
Returns
full cursor contents as an array

Returns Promise<T[]>
- Defined in src/rest.ts:151

Generated using TypeDoc