Page<T>

Una página de resultados.

Se comporta como una secuencia: page.length, page.items[0], for (const x of page) recorren solo esta página. Para recorrer todas:

const primera = await sd.invoices.list();
for await (const factura of primera.autoPaging()) { ... }

Type Parameters

Type Parameter
T

Implements

• Iterable<T>

Constructors

Constructor

new Page<T>(options): Page<T>;

Parameters

Parameter	Type
options	{ items: readonly T[]; nextCursor?: string; hasMore?: boolean; limit?: number; fetchNext?: (cursor) => Promise<Page<T>>; }
options.items	readonly T[]
options.nextCursor?	string
options.hasMore?	boolean
options.limit?	number
options.fetchNext?	(cursor) => Promise<Page<T>>

Returns

Page<T>

Properties

items

readonly items: readonly T[];

---

nextCursor

readonly nextCursor: string | undefined;

---

hasMore

readonly hasMore: boolean;

---

limit

readonly limit: number;

Accessors

length

Get Signature

get length(): number;

Returns

number

---

first

Get Signature

get first(): T | undefined;

El primer elemento, o undefined si la página vino vacía.

Returns

T | undefined

Methods

[iterator]()

iterator: Iterator<T>;

Returns

Iterator<T>

Implementation of

Iterable.[iterator]

---

nextPage()

nextPage(): Promise<Page<T> | undefined>;

La página siguiente, o undefined si esta era la última.

Returns

Promise<Page<T> | undefined>

---

autoPaging()

autoPaging(): AsyncGenerator<T, void, undefined>;

Recorre todos los resultados, siguiendo el cursor solo.

El transporte regula a 5 solicitudes por segundo, así que recorrer un listado largo es lento pero no dispara 429.

Returns

AsyncGenerator<T, void, undefined>

---

all()

all(): Promise<T[]>;

Todos los resultados en un array. Cuidado con los listados largos.

Returns

Promise<T[]>

---

fromResult()

static fromResult<T>(
   items, 
   pagination, 
fetchNext?): Page<T>;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
items	readonly T[]
pagination	Pagination | undefined
fetchNext?	(cursor) => Promise<Page<T>>

Returns

Page<T>