106 lines
3.1 KiB
TypeScript
106 lines
3.1 KiB
TypeScript
/// <reference types="long" />
|
|
import { Long, DeepPartial } from "../../../../helpers";
|
|
import * as _m0 from "protobufjs/minimal";
|
|
/**
|
|
* PageRequest is to be embedded in gRPC request messages for efficient
|
|
* pagination. Ex:
|
|
*
|
|
* message SomeRequest {
|
|
* Foo some_parameter = 1;
|
|
* PageRequest pagination = 2;
|
|
* }
|
|
*/
|
|
export interface PageRequest {
|
|
/**
|
|
* 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.
|
|
*/
|
|
key: Uint8Array;
|
|
/**
|
|
* 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.
|
|
*/
|
|
offset: 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.
|
|
*/
|
|
limit: Long;
|
|
/**
|
|
* 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.
|
|
*/
|
|
countTotal: boolean;
|
|
/**
|
|
* reverse is set to true if results are to be returned in the descending order.
|
|
*
|
|
* Since: cosmos-sdk 0.43
|
|
*/
|
|
reverse: boolean;
|
|
}
|
|
/**
|
|
* PageRequest is to be embedded in gRPC request messages for efficient
|
|
* pagination. Ex:
|
|
*
|
|
* message SomeRequest {
|
|
* Foo some_parameter = 1;
|
|
* PageRequest pagination = 2;
|
|
* }
|
|
*/
|
|
export interface PageRequestSDKType {
|
|
key: Uint8Array;
|
|
offset: Long;
|
|
limit: Long;
|
|
count_total: boolean;
|
|
reverse: boolean;
|
|
}
|
|
/**
|
|
* PageResponse is to be embedded in gRPC response messages where the
|
|
* corresponding request message has used PageRequest.
|
|
*
|
|
* message SomeResponse {
|
|
* repeated Bar results = 1;
|
|
* PageResponse page = 2;
|
|
* }
|
|
*/
|
|
export interface PageResponse {
|
|
/**
|
|
* next_key is the key to be passed to PageRequest.key to
|
|
* query the next page most efficiently. It will be empty if
|
|
* there are no more results.
|
|
*/
|
|
nextKey: Uint8Array;
|
|
/**
|
|
* total is total number of results available if PageRequest.count_total
|
|
* was set, its value is undefined otherwise
|
|
*/
|
|
total: Long;
|
|
}
|
|
/**
|
|
* PageResponse is to be embedded in gRPC response messages where the
|
|
* corresponding request message has used PageRequest.
|
|
*
|
|
* message SomeResponse {
|
|
* repeated Bar results = 1;
|
|
* PageResponse page = 2;
|
|
* }
|
|
*/
|
|
export interface PageResponseSDKType {
|
|
next_key: Uint8Array;
|
|
total: Long;
|
|
}
|
|
export declare const PageRequest: {
|
|
encode(message: PageRequest, writer?: _m0.Writer): _m0.Writer;
|
|
decode(input: _m0.Reader | Uint8Array, length?: number): PageRequest;
|
|
fromPartial(object: DeepPartial<PageRequest>): PageRequest;
|
|
};
|
|
export declare const PageResponse: {
|
|
encode(message: PageResponse, writer?: _m0.Writer): _m0.Writer;
|
|
decode(input: _m0.Reader | Uint8Array, length?: number): PageResponse;
|
|
fromPartial(object: DeepPartial<PageResponse>): PageResponse;
|
|
};
|