@wharfkit/session - v4.0.1
    Preparing search index...

    Interface GetTableRowsParamsKeyed<Index, Key>

    interface GetTableRowsParamsKeyed<
        Index = TableIndexType,
        Key = keyof TableIndexTypes,
    > {
        code: NameType;
        encode_type?: "hex" | "dec";
        index_position?:
            | "primary"
            | "secondary"
            | "tertiary"
            | "fourth"
            | "fifth"
            | "sixth"
            | "seventh"
            | "eighth"
            | "ninth"
            | "tenth";
        json?: boolean;
        key_type: Key;
        limit?: UInt32Type;
        lower_bound?: Index;
        reverse?: boolean;
        scope?: string
        | TableIndexType;
        show_payer?: boolean;
        table: NameType;
        upper_bound?: Index;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    code encode_type? index_position? json? key_type limit? lower_bound? reverse? scope? show_payer? table upper_bound?
    code: NameType

    The name of the smart contract that controls the provided table.

    encode_type?: "hex" | "dec"

    How bounds are encoded, defaults to dec; a Float128 bound sets hex and byte-reverses.

    index_position?:
        | "primary"
        | "secondary"
        | "tertiary"
        | "fourth"
        | "fifth"
        | "sixth"
        | "seventh"
        | "eighth"
        | "ninth"
        | "tenth"

    Position of the index used, defaults to primary.

    json?: boolean

    Whether node should try to decode row data using code abi. Determined automatically based the type param if omitted.

    key_type: Key

    Index key type, determined automatically when passing a typed upper_bound or lower_bound.

    limit?: UInt32Type

    How many rows to fetch, defaults to 10 if unset.

    lower_bound?: Index

    Lower lookup bound.

    reverse?: boolean

    Whether to iterate records in reverse order.

    scope?: string | TableIndexType

    The account to which this data belongs, if omitted will be set to be same as code.

    show_payer?: boolean

    Set to true to populate the ram_payers array in the response.

    table: NameType

    Name of the table to query.

    upper_bound?: Index

    Upper lookup bound.

    Settings
    Member Visibility

    On This Page
    Properties