Class IndexQueryHandler

A base class to handle common Subgraph query logic.

Hierarchy (view full)

SubgraphQueryHandler<Index, IndexListQuery, IndexesQuery, IndexesQueryVariables>
- IndexQueryHandler

Index

Constructors

constructor

new IndexQueryHandler(): IndexQueryHandler
Returns IndexQueryHandler
Inherited from SubgraphQueryHandler.constructor

Properties

getAddressFieldKeysFromFilter

getAddressFieldKeysFromFilter: (() => {
accountKeys: (keyof Index_Filter)[];
tokenKeys: (keyof Index_Filter)[];
})

Type declaration

- (): {
  accountKeys: (keyof Index_Filter)[];
  tokenKeys: (keyof Index_Filter)[];
  }
- Returns {
  accountKeys: (keyof Index_Filter)[];
  tokenKeys: (keyof Index_Filter)[];
  }
  - accountKeys: (keyof Index_Filter)[]
  - tokenKeys: (keyof Index_Filter)[]

getRelevantAddressesFromResultCore

getRelevantAddressesFromResultCore: ((result) => RelevantAddressesIntermediate)

Type declaration

- (result): RelevantAddressesIntermediate
- Parameters
  - result: Index
  Returns RelevantAddressesIntermediate

mapFromSubgraphResponse

mapFromSubgraphResponse: ((response) => Index[])

Type declaration

- (response): Index[]
- Parameters
  - response: IndexesQuery
  Returns Index[]

requestDocument

requestDocument: TypedDocumentNode<IndexesQuery, Exact<{
    block?: InputMaybe<Block_Height>;
    first?: InputMaybe<number>;
    orderBy?: InputMaybe<Index_OrderBy>;
    orderDirection?: InputMaybe<OrderDirection>;
    skip?: InputMaybe<number>;
    where?: InputMaybe<Index_Filter>;
}>>

Methods

get

get(subgraphClient, query): Promise<null | Index>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphGetQuery
Returns Promise<null | Index>
Inherited from SubgraphQueryHandler.get
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:95

getRelevantAddressesFromFilter

getRelevantAddressesFromFilter(filter?): RelevantAddresses
Parameters
- Optional filter: Index_Filter
Returns RelevantAddresses
Inherited from SubgraphQueryHandler.getRelevantAddressesFromFilter
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:86

getRelevantAddressesFromResult

getRelevantAddressesFromResult(result?): RelevantAddresses
Parameters
- Optional result: null | Index
Returns RelevantAddresses
Inherited from SubgraphQueryHandler.getRelevantAddressesFromResult
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:93

list

list(subgraphClient, query): Promise<PagedResult<Index>>
Parameters
- subgraphClient: SubgraphClient
- query: SubgraphListQuery<Index_Filter, Index_OrderBy>
Returns Promise<PagedResult<Index>>
Inherited from SubgraphQueryHandler.list
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:96

`Protected` querySubgraph

querySubgraph(subgraphClient, variables): Promise<IndexesQuery>
Parameters
- subgraphClient: SubgraphClient
- variables: Exact<{
      block?: InputMaybe<Block_Height>;
      first?: InputMaybe<number>;
      orderBy?: InputMaybe<Index_OrderBy>;
      orderDirection?: InputMaybe<OrderDirection>;
      skip?: InputMaybe<number>;
      where?: InputMaybe<Index_Filter>;
  }>
Returns Promise<IndexesQuery>
Inherited from SubgraphQueryHandler.querySubgraph
- Defined in packages/sdk-core/dist/module/subgraph/subgraphQueryHandler.d.ts:97

Class IndexQueryHandler

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns IndexQueryHandler

Properties

getAddressFieldKeysFromFilter

Type declaration

Returns { accountKeys: (keyof Index_Filter)[]; tokenKeys: (keyof Index_Filter)[]; }

accountKeys: (keyof Index_Filter)[]

tokenKeys: (keyof Index_Filter)[]

getRelevantAddressesFromResultCore

Type declaration

Parameters

result: Index

Returns RelevantAddressesIntermediate

mapFromSubgraphResponse

Type declaration

Parameters

response: IndexesQuery

Returns Index[]

requestDocument

Methods

get

Parameters

subgraphClient: SubgraphClient

query: SubgraphGetQuery

Returns Promise<null | Index>

getRelevantAddressesFromFilter

Parameters

Optional filter: Index_Filter

Returns RelevantAddresses

getRelevantAddressesFromResult

Parameters

Optional result: null | Index

Returns RelevantAddresses

list

Parameters

subgraphClient: SubgraphClient

query: SubgraphListQuery<Index_Filter, Index_OrderBy>

Returns Promise<PagedResult<Index>>

Protected querySubgraph

Parameters

subgraphClient: SubgraphClient

variables: Exact<{ block?: InputMaybe<Block_Height>; first?: InputMaybe<number>; orderBy?: InputMaybe<Index_OrderBy>; orderDirection?: InputMaybe<OrderDirection>; skip?: InputMaybe<number>; where?: InputMaybe<Index_Filter>; }>

Returns Promise<IndexesQuery>

Settings

Member Visibility

Theme

On This Page

Returns {
accountKeys: (keyof Index_Filter)[];
tokenKeys: (keyof Index_Filter)[];
}

`Optional` filter: Index_Filter

`Optional` result: null | Index

`Protected` querySubgraph

variables: Exact<{
block?: InputMaybe<Block_Height>;
first?: InputMaybe<number>;
orderBy?: InputMaybe<Index_OrderBy>;
orderDirection?: InputMaybe<OrderDirection>;
skip?: InputMaybe<number>;
where?: InputMaybe<Index_Filter>;
}>