Class PaginatedResultAsync<TPage, TItem>

A ResultAsync<TPage, PixivError> with additional .pages() / .items() async generators for consuming paginated pixiv list responses.

Returned by all resource methods that produce a nextUrl field.

Type Parameters

TPage extends PagedResponse
TItem

Hierarchy (View Summary)

ResultAsync<TPage, PixivError>
- PaginatedResultAsync

Index

Constructors

constructor

Methods

andThen items map mapErr match pages then unwrapOr fromPromise fromResult fromResultAsync

Constructors

constructor

new PaginatedResultAsync<TPage extends PagedResponse, TItem>(
 promise: Promise<Result<TPage, PixivError>>,
 http: HttpClient,
 getItems: (page: TPage) => TItem[],
): PaginatedResultAsync<TPage, TItem>
Type Parameters
- TPage extends PagedResponse
- TItem
Parameters
- promise: Promise<Result<TPage, PixivError>>
- http: HttpClient
- getItems: (page: TPage) => TItem[]
Returns PaginatedResultAsync<TPage, TItem>
Overrides ResultAsync.constructor
- Defined in packages/core/src/paginated.ts:44

Methods

andThen

andThen<U, F>(
fn: (value: TPage) => ResultAsync<U, F> | Result<U, F>,
): ResultAsync<U, PixivError | F>
Chains another async operation that may fail.

If the inner result is Err, fn is not called.
Type Parameters
- U
- F
Parameters
- fn: (value: TPage) => ResultAsync<U, F> | Result<U, F>
 Async mapper that returns a ResultAsync<U, F>
Returns ResultAsync<U, PixivError | F>
Inherited from ResultAsync.andThen
- Defined in packages/core/src/result.ts:244

items

items(): AsyncGenerator<TItem, void, unknown>
Async generator that yields individual items across all pages.

If any page fetch fails, the generator throws a PixivFetchError.

Returns AsyncGenerator<TItem, void, unknown>
Example
```
for await (const illust of client.illusts.search({ word: 'cat' }).items()) {
 console.log(illust.title)
}
```
- Defined in packages/core/src/paginated.ts:111

map

map(fn: (value: TPage) => U): ResultAsync<U, PixivError>
Transforms the success value.

If the inner result is Err, fn is not called.
Type Parameters
- U
Parameters
- fn: (value: TPage) => U
 Synchronous mapper
Returns ResultAsync<U, PixivError>
Inherited from ResultAsync.map
- Defined in packages/core/src/result.ts:217

mapErr

mapErr<F>(fn: (error: PixivError) => F): ResultAsync<TPage, F>
Transforms the error value.

If the inner result is Ok, fn is not called.
Type Parameters
- F
Parameters
- fn: (error: PixivError) => F
 Synchronous error mapper
Returns ResultAsync<TPage, F>
Inherited from ResultAsync.mapErr
- Defined in packages/core/src/result.ts:231

match

match(
onOk: (value: TPage) => U | Promise,
onErr: (error: PixivError) => U | Promise,
): Promise
Pattern-matches on success / failure.
Type Parameters
- U
Parameters
- onOk: (value: TPage) => U | Promise
 Called with the success value
- onErr: (error: PixivError) => U | Promise
 Called with the error value
Returns Promise
A Promise
Inherited from ResultAsync.match
- Defined in packages/core/src/result.ts:266

pages

pages(): AsyncGenerator<TPage, void, unknown>
Async generator that yields each page starting from the first.

If any page fetch fails, the generator throws a PixivFetchError.

Returns AsyncGenerator<TPage, void, unknown>
Example
```
for await (const page of client.illusts.search({ word: 'cat' }).pages()) {
 console.log(page.illusts.length)
}
```
- Defined in packages/core/src/paginated.ts:83

then

then<TResult1 = Result<TPage, PixivError>, TResult2 = never>(
 onfulfilled?:
 | (
 (value: Result<TPage, PixivError>) => TResult1 | PromiseLike<TResult1>
 )
 | null,
 onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): PromiseLike<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = Result<TPage, PixivError>
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: Result<TPage, PixivError>) => TResult1 | PromiseLike<TResult1>) | null
 The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
 The callback to execute when the Promise is rejected.
Returns PromiseLike<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from ResultAsync.then
- Defined in packages/core/src/result.ts:171

unwrapOr

unwrapOr(fallback: TPage): Promise<TPage>
Returns the success value, or fallback if the result is Err.
Parameters
- fallback: TPage
 The fallback value
Returns Promise<TPage>
Inherited from ResultAsync.unwrapOr
- Defined in packages/core/src/result.ts:280

`Static`fromPromise

fromPromise<T, E>(
promise: Promise<T>,
onError: (reason: unknown) => E,
): ResultAsync<T, E>
Wraps a Promise<T> into a ResultAsync<T, E>.

If the promise rejects, onError maps the rejection reason to E.
Type Parameters
- T
- E
Parameters
- promise: Promise<T>
 The promise to wrap
- onError: (reason: unknown) => E
 Error mapper
Returns ResultAsync<T, E>
Inherited from ResultAsync.fromPromise
- Defined in packages/core/src/result.ts:189

`Static`fromResult

fromResult<T, E>(result: Result<T, E>): ResultAsync<T, E>
Wraps an already-resolved Result<T, E> into a ResultAsync<T, E>.
Type Parameters
- T
- E
Parameters
- result: Result<T, E>
 The result to wrap
Returns ResultAsync<T, E>
Inherited from ResultAsync.fromResult
- Defined in packages/core/src/result.ts:206

`Static`fromResultAsync

fromResultAsync<TPage extends PagedResponse, TItem>(
 inner: ResultAsync<TPage, PixivError>,
 http: HttpClient,
 getItems: (page: TPage) => TItem[],
): PaginatedResultAsync<TPage, TItem>
Creates a PaginatedResultAsync from a ResultAsync.
Type Parameters
- TPage extends PagedResponse
- TItem
Parameters
- inner: ResultAsync<TPage, PixivError>
 The first-page result
- http: HttpClient
 HTTP client for fetching subsequent pages
- getItems: (page: TPage) => TItem[]
 Extracts item array from a page
Returns PaginatedResultAsync<TPage, TItem>
- Defined in packages/core/src/paginated.ts:61

Class PaginatedResultAsync<TPage, TItem>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PaginatedResultAsync<TPage, TItem>

Methods

andThen

Type Parameters

Parameters

Returns ResultAsync<U, PixivError | F>

items

Returns AsyncGenerator<TItem, void, unknown>

Example

map

Type Parameters

Parameters

Returns ResultAsync<U, PixivError>

mapErr

Type Parameters

Parameters

Returns ResultAsync<TPage, F>

match

Type Parameters

Parameters

Returns Promise<U>

pages

Returns AsyncGenerator<TPage, void, unknown>

Example

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

unwrapOr

Parameters

Returns Promise<TPage>

StaticfromPromise

Type Parameters

Parameters

Returns ResultAsync<T, E>

StaticfromResult

Type Parameters

Parameters

Returns ResultAsync<T, E>

StaticfromResultAsync

Type Parameters

Parameters

Returns PaginatedResultAsync<TPage, TItem>

Settings

On This Page

`Static`fromPromise

`Static`fromResult

`Static`fromResultAsync