Skip to main content

Interface: PoolListOptions

gSwap SDK 2.0.0-rc.4

gSwap SDK 2.0.0-rc.4 / PoolListOptions

Interface: PoolListOptions

Defined in: packages/gswap-sdk/dist/index.d.ts:2484

Options of Pools.getPools. Omit all of search, sortBy, sortOrder, page, limit for the full, unsorted list.

Properties​

limit?​

optional limit?: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2493

Rows per page, 1-1000; omitted returns every row.

onInvalidEntry?​

optional onInvalidEntry?: InvalidEntryHandler

Defined in: packages/gswap-sdk/dist/index.d.ts:2495

Overrides the service-level handler for this call.

page?​

optional page?: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2491

1-based page number; only meaningful together with limit.

optional search?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2487

Case-insensitive match on the pair's symbols; A/B or A B matches either order. At most 64 characters.

signal?​

optional signal?: AbortSignal

Defined in: packages/gswap-sdk/dist/index.d.ts:2485

sortBy?​

optional sortBy?: PoolSortBy

Defined in: packages/gswap-sdk/dist/index.d.ts:2488

sortOrder?​

optional sortOrder?: "asc" | "desc"

Defined in: packages/gswap-sdk/dist/index.d.ts:2489