Resolved Config between user defined options and DefaultConfig

Example

import { ResolvedConfig } from 'abitype'

ResolvedConfig['BigIntType']
interface ResolvedConfig {
    AddressType: `0x${string}`;
    ArrayMaxDepth: false;
    BigIntType: bigint;
    BytesType: {
        inputs: `0x${string}`;
        outputs: `0x${string}`;
    };
    FixedArrayMaxLength: 99;
    FixedArrayMinLength: 1;
    IntType: number;
    StrictAbiType: false;
}

Properties

AddressType: `0x${string}`

TypeScript type to use for address values

Default

0x${string}

ArrayMaxDepth: false

Maximum depth for nested array types (e.g. string[][])

Note: You probably only want to set this to a specific number if parsed types are returning as unknown and you want to figure out why. If you set this, you should probably also reduce FixedArrayMaxLength.

Default

false
BigIntType: bigint

TypeScript type to use for int<M> and uint<M> values, where M > 48

Default

bigint
BytesType: {
    inputs: `0x${string}`;
    outputs: `0x${string}`;
}

TypeScript type to use for bytes values

Type declaration

  • inputs: `0x${string}`

    TypeScript type to use for bytes input values

  • outputs: `0x${string}`

    TypeScript type to use for bytes output values

Default

{ inputs: `0x${string}` | Uint8Array; outputs: `0x${string}` }
FixedArrayMaxLength: 99

Upper bound for fixed array length

Default

99
FixedArrayMinLength: 1

Lower bound for fixed array length

Default

1
IntType: number

TypeScript type to use for int<M> and uint<M> values, where M <= 48

Default

number
StrictAbiType: false

When set, validates AbiParameter's type against AbiType

Note: You probably only want to set this to true if parsed types are returning as unknown and you want to figure out why.

Default

false

Generated using TypeDoc