Class: IndexerPluginClient
Indexer plugin which provides access to the indexer plugin API.
Table of contents
Constructors
Methods
Constructors
constructor
• new IndexerPluginClient(client, options?)
Create a new instance of IndexerPluginClient.
Parameters
| Name | Type | Description |
|---|---|---|
client | string | IClient | The client for communications. |
options? | Object | Options for the plugin. |
Methods
basicOutputs
▸ outputs(filterOptions?): Promise<IOutputsResponse>
Find outputs using filter options.
Parameters
| Name | Type | Description |
|---|---|---|
filterOptions? | Object | The options for filtering. |
Returns
Promise<IOutputsResponse>
The outputs with the requested filters.
aliases
▸ aliases(filterOptions?): Promise<IOutputsResponse>
Find alises using filter options.
Parameters
| Name | Type | Description |
|---|---|---|
filterOptions? | Object | The options for filtering. |
Returns
Promise<IOutputsResponse>
The outputs with the requested filters.
alias
▸ alias(aliasId): Promise<IOutputsResponse>
Get the output for an alias.
Parameters
| Name | Type | Description |
|---|---|---|
aliasId | string | The alias to get the output for. |
Returns
Promise<IOutputsResponse>
The output.
nfts
▸ nfts(filterOptions?): Promise<IOutputsResponse>
Find nfts using filter options.
Parameters
| Name | Type | Description |
|---|---|---|
filterOptions? | Object | The options for filtering. |
Returns
Promise<IOutputsResponse>
The outputs with the requested filters.
nft
▸ nft(nftId): Promise<IOutputsResponse>
Get the output for a nft.
Parameters
| Name | Type | Description |
|---|---|---|
nftId | string | The nft to get the output for. |
Returns
Promise<IOutputsResponse>
The output.
foundries
▸ foundries(filterOptions?): Promise<IOutputsResponse>
Find foundries using filter options.
Parameters
| Name | Type | Description |
|---|---|---|
filterOptions? | Object | The options for filtering. |
Returns
Promise<IOutputsResponse>
The outputs with the requested filters.
foundry
▸ foundry(foundryId): Promise<IOutputsResponse>
Get the output for a foundry.
Parameters
| Name | Type | Description |
|---|---|---|
foundryId | string | The foundry to get the output for. |
Returns
Promise<IOutputsResponse>
The output.