PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest { Foo some_parameter = 1; PageRequest pagination = 2; }

from message cosmos.base.query.v1beta1.PageRequest

Hierarchy

Constructors

Properties

countTotal: boolean = false

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.

from field: bool count_total = 4;

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.

from field: bytes key = 1;

limit: bigint = protoInt64.zero

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.

from field: uint64 limit = 3;

offset: bigint = protoInt64.zero

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.

from field: uint64 offset = 2;

reverse: boolean = false

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

Since: cosmos-sdk 0.43

from field: bool reverse = 5;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cosmos.base.query.v1beta1.PageRequest" = "cosmos.base.query.v1beta1.PageRequest"

Methods