Skip to content

AbiParameters.format

Formats AbiParameters.AbiParameters into Human Readable ABI Parameters.

Imports

Named
import { AbiParameters } from 'ox'

Examples

import { AbiParameters } from 'ox'
 
const formatted = AbiParameters.format([
  {
    name: 'spender',
    type: 'address',
  },
  {
    name: 'amount',
    type: 'uint256',
  },
])
 

const formatted: "address spender, uint256 amount"
formatted

Definition

function format<parameters>(
  parameters: parameters | readonly [
    Parameter | abitype.AbiEventParameter,
    ...(readonly (Parameter | abitype.AbiEventParameter)[])
],
): abitype.FormatAbiParameters<parameters>

Source: src/AbiParameters.ts

Parameters

parameters

  • Type: parameters | readonly [ Parameter | abitype.AbiEventParameter, ...(readonly (Parameter | abitype.AbiEventParameter)[]) ]

The ABI Parameters to format.

Return Type

The formatted ABI Parameters .

abitype.FormatAbiParameters<parameters>