Variable PageRequest

Type declaration

• create:function

  • create(base?): PageRequest

  • Parameters

    • Optional base: {
          countTotal?: boolean;
          key?: Uint8Array;
          limit?: string | number | Long;
          offset?: string | number | Long;
          reverse?: boolean;
      }

      • Optional countTotal?: boolean

        count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

      • Optional key?: Uint8Array

        key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

      • Optional limit?: string | number | Long

        limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

      • Optional offset?: string | number | Long

        offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

      • Optional reverse?: boolean

        reverse is set to true if results are to be returned in the descending order.

        Since: cosmos-sdk 0.43

    Returns PageRequest

• decode:function

  • decode(input, length?): PageRequest

  • Parameters

    • input: Uint8Array | Reader

    • Optional length: number

    Returns PageRequest

• encode:function

  • encode(message, writer?): Writer

  • Parameters

    • message: PageRequest

    • writer: Writer = ...

    Returns Writer

• fromJSON:function

  • fromJSON(object): PageRequest

  • Parameters

    • object: any

    Returns PageRequest

• fromPartial:function

  • fromPartial(object): PageRequest

  • Parameters

    • object: {
          countTotal?: boolean;
          key?: Uint8Array;
          limit?: string | number | Long;
          offset?: string | number | Long;
          reverse?: boolean;
      }

      • Optional countTotal?: boolean

        count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

      • Optional key?: Uint8Array

        key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

      • Optional limit?: string | number | Long

        limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

      • Optional offset?: string | number | Long

        offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

      • Optional reverse?: boolean

        reverse is set to true if results are to be returned in the descending order.

        Since: cosmos-sdk 0.43

    Returns PageRequest

• toJSON:function

  • toJSON(message): unknown

  • Parameters

    • message: PageRequest

    Returns unknown