UNPKG

@tangany/waas

Version:

node.js SDK for Tangany Wallet as a Service API

38 lines (37 loc) 2.07 kB
import { ISearchOptions } from "./interfaces/common"; import { IMonitorSearchParams } from "./interfaces/monitor"; import { MonitorIterable } from "./iterables/auto-pagination/monitor-iterable"; import { MonitorPageIterable } from "./iterables/pagewise/monitor-page-iterable"; import { Waas } from "./waas"; import { IWaasMethod } from "./waas-method"; /** * Represents the endpoint to interact with all Ethereum monitors in a cross-wallet manner. */ export declare class EthMonitorSearch implements IWaasMethod { waas: Waas; constructor(waas: Waas); /** * Returns an asynchronous iterable to iterate **page by page** through the monitors that matched the search parameters. * @param [params] - Optional search parameters * @see [docs]{@link https://docs.tangany.com/#0cf31f8c-9ae1-4709-9ca6-842452d74b10} */ list(params?: IMonitorSearchParams): MonitorPageIterable; /** * Returns an asynchronous iterable that yields **one monitor object per iteration**. * A page of monitors that match the search parameters is fetched and saved once, so that all items can be returned one by one. * After that, the next page is loaded from the API and processed item by item again. * @param [params] - Optional search parameters * @param [options] - Additional options that do not affect the API request but the SDK-side processing * @see [docs]{@link https://docs.tangany.com/#0cf31f8c-9ae1-4709-9ca6-842452d74b10} */ list(params?: IMonitorSearchParams, options?: { autoPagination: true; }): MonitorIterable; /** * Returns an asynchronous iterable to iterate **page by page** through the monitors that matched the search parameters. * @param [params] - Optional search parameters * @param [options] - Additional options that do not affect the API request but the SDK-side processing * @see [docs]{@link https://docs.tangany.com/#0cf31f8c-9ae1-4709-9ca6-842452d74b10} */ list(params?: IMonitorSearchParams, options?: ISearchOptions): MonitorPageIterable; }