Function getIndex

getIndex<chain extends undefined | Chain>(
client: { extend: <const client extends { [key: string]: unknown }>(fn: (client: { extend: ... }) => client) => { [K in (...) | (...) | (...)]: (...)[(...)] } },
params: GetIndexParameters,
): Promise<GetIndexReturnType>
Get the index of a container by its ID.
- Docs: https://build.avax.network/docs/api-reference/index-api#indexgetindex
Type Parameters
- chain extends undefined | Chain
Parameters
- client: { extend: <const client extends { [key: string]: unknown }>(fn: (client: { extend: ... }) => client) => { [K in (...) | (...) | (...)]: (...)[(...)] } }
  The client to use. AvalancheCoreClient
- params: GetIndexParameters
  The container ID and encoding. GetIndexParameters
Returns Promise<GetIndexReturnType>
The container index. GetIndexReturnType
Example
```
import { createAvalancheCoreClient } from '@avalanche-sdk/client'
import { avalanche } from '@avalanche-sdk/client/chains'
import { getIndex } from '@avalanche-sdk/client/methods/index'

const client = createAvalancheCoreClient({
  chain: avalanche,
  transport: {
    type: "http",
    url: "<url>",
  },
})

const index = await getIndex(client, {
  id: "6fXf5hncR8LXvwtM8iezFQBpK5cubV6y1dWgpJCcNyzGB1EzY",
  encoding: "hex"
})
```
- Defined in src/methods/index/getIndex.ts:38