import PagedRequest from '~/models/Request/PagedRequest.js'

public class | source

PagedRequest

Request → PagedRequest

Runs request using Axtell REST paging.

Constructor Summary

Public Constructor
public	constructor(options: Object)

Public Members
public get	areMore: boolean If they are definetly more.
public get	page: number Gets the current page.
public set	page: number Sets the current page.

Public Methods
public	[Symbol.iterator]() The async iterator loads individual items.
public	async getPage(page: number, mutate: boolean): Object Gets a specific page.
public	async nextPage(): Object Runs for the next page (starts at zero).

From class Request
protected	_path: string
public	cancel() Cancels the request.
public	format(data: Object): Object Formats the request object and returns an object of Request<T>'s T.
public	async run(o: Object): Promise Performs the request

Creates request given path. Provide options as object

Name	Type	Attribute	Description
options	Object		See Request#constructor

If they are definetly more. If you haven't run a request this is false because we have no idea how many there are at the time.

Gets the current page.

Sets the current page. Do note this will remove all context but will not break iterators.

The async iterator loads individual items. DO NOT call any other methods as that will mess up the page indexing.

Gets a specific page.

Name	Type	Attribute	Description
data	Object[]		Array of data
areMore	boolean		If there is more. If mutate is true, this is the same as doing PagedRequest#areMore

Runs for the next page (starts at zero).

Object (nullable: true)

Same type as the Request#format.