lib/proto/cosmos/base/query/v1beta1/pagination

Index

Interfaces

Type aliases

DeepPartial

Variables

Type aliases

DeepPartial

DeepPartial<T>: T extends Builtin ? T : T extends infer U[] ? DeepPartial<U>[] : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {[ K in keyof T]: DeepPartial<T[K]> } : Partial<T>

Type parameters

Variables

PageRequest

PageRequest: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PageRequest
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:84
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PageRequest
encode: function
- encode(message: PageRequest, writer?: Writer): Writer
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:68
  Parameters
  - message: PageRequest
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PageRequest
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:112
  Parameters
  - object: any
  Returns PageRequest
fromPartial: function
- fromPartial(object: { countTotal?: boolean; key?: Uint8Array; limit?: number; offset?: number }): PageRequest
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:148
  Parameters
  - object: { countTotal?: boolean; key?: Uint8Array; limit?: number; offset?: number }
    - 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?: number
      
      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?: number
      
      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.
  Returns PageRequest
toJSON: function
- toJSON(message: PageRequest): unknown
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:136
  Parameters
  - message: PageRequest
  Returns unknown

PageResponse

PageResponse: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PageResponse
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:187
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PageResponse
encode: function
- encode(message: PageResponse, writer?: Writer): Writer
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:177
  Parameters
  - message: PageResponse
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PageResponse
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:209
  Parameters
  - object: any
  Returns PageResponse
fromPartial: function
- fromPartial(object: { nextKey?: Uint8Array; total?: number }): PageResponse
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:233
  Parameters
  - object: { nextKey?: Uint8Array; total?: number }
    - Optional nextKey?: Uint8Array
      
      next_key is the key to be passed to PageRequest.key to query the next page most efficiently
    - Optional total?: number
      
      total is total number of results available if PageRequest.count_total was set, its value is undefined otherwise
  Returns PageResponse
toJSON: function
- toJSON(message: PageResponse): unknown
- - Defined in lib/proto/cosmos/base/query/v1beta1/pagination.ts:223
  Parameters
  - message: PageResponse
  Returns unknown

Const protobufPackage

protobufPackage: "cosmos.base.query.v1beta1" = 'cosmos.base.query.v1beta1'

Index

Interfaces

Type aliases

Variables

Type aliases

DeepPartial

Type parameters

T

Variables

PageRequest

Type declaration

decode: function

Parameters

input: Uint8Array | Reader

Optional length: number

Returns PageRequest

encode: function

Parameters

message: PageRequest

writer: Writer = ...

Returns Writer

fromJSON: function

Parameters

object: any

Returns PageRequest

fromPartial: function

Parameters

object: { countTotal?: boolean; key?: Uint8Array; limit?: number; offset?: number }

Optional countTotal?: boolean

Optional key?: Uint8Array

Optional limit?: number

Optional offset?: number

Returns PageRequest

toJSON: function

Parameters

message: PageRequest

Returns unknown

PageResponse

Type declaration

decode: function

Parameters

input: Uint8Array | Reader

Optional length: number

Returns PageResponse

encode: function

Parameters

message: PageResponse

writer: Writer = ...

Returns Writer

fromJSON: function

Parameters

object: any

Returns PageResponse

fromPartial: function

Parameters

object: { nextKey?: Uint8Array; total?: number }

Optional nextKey?: Uint8Array

Optional total?: number

Returns PageResponse

toJSON: function

Parameters

message: PageResponse

Returns unknown

Const protobufPackage