@gear-js/api/lib/api/Waitlist.d.ts

A JavaScript library that provides functionality to connect GEAR Component APIs.

import { HexString } from '@polkadot/util/types';
import { GearApi } from '../GearApi';
import { WaitlistItem } from '../types';
export declare class GearWaitlist {
    private _api;
    constructor(_api: GearApi);
    /**
     * ## _Read program's waitlist_
     * @param programId
     * @param numberOfMessages _(default 1000)_ number of messages that will be read from program's waitlist
     * @example
     * ```javascript
     * const api = await GearApi.create();
     * const waitlist = await api.waitlist.read('0xe0c6997d0bd83269ec108474494e2bd6ed156b30de599b9f2c91e82bb6ad04e8');
     * console.log(waitlist.map(item => item.toHuman()));
     * ```
     */
    read(programId: HexString, numberOfMessages?: number): Promise<WaitlistItem[]>;
    /**
     * ## _Get particular message from program's waitlist_
     * @param programId
     * @param messageId
     * @example
     * ```javascript
     * const api = await GearApi.create();
     * const programId = '0xe0c6997d0bd83269ec108474494e2bd6ed156b30de599b9f2c91e82bb6ad04e8'
     * const messageId = '0xe9f3b99f23203d0c032868d3bd0349c8e243119626a8af98a2f4ac5ea6c78947'
     * const waitlist = await api.waitlist.read(programId, messageId);
     * console.log(waitlist.toHuman());
     * ```
     */
    read(programId: HexString, messageId: HexString): Promise<WaitlistItem>;
}