refactor: type parameters to camelCase (#239)

* refactor: switch to lowercase type params * chore: changeset * chore: format * docs: format * refactor: register case * chore: format * chore: changeset --------- Co-authored-by: tmm <[email protected]>
wevm · Jun 19, 2024 · f083a7c · f083a7c
1 parent 7f52eed
commit f083a7c
Show file tree

Hide file tree

Showing 33 changed files with 852 additions and 785 deletions.
diff --git a/.changeset/neat-geckos-grab.md b/.changeset/neat-geckos-grab.md
@@ -0,0 +1,5 @@
+---
+"abitype": patch
+---
+
+Changed type parameters and register properties to camelCase.
diff --git a/docs/pages/api/human.md b/docs/pages/api/human.md
@@ -203,10 +203,10 @@ Types for parsing and formatting human-readable ABIs.
 
 Parses human-readable ABI into JSON [`Abi`](/api/types#abi).
 
-| Name          | Description                    | Type              |
-| ------------- | ------------------------------ | ----------------- |
-| `TSignatures` | Human-Readable ABI.            | `string[]`        |
-| returns       | Parsed [`Abi`](/api/types#abi) | `TAbi` (inferred) |
+| Name         | Description                    | Type             |
+| ------------ | ------------------------------ | ---------------- |
+| `signatures` | Human-Readable ABI.            | `string[]`       |
+| returns      | Parsed [`Abi`](/api/types#abi) | `abi` (inferred) |
 
 #### Example
 
@@ -239,10 +239,10 @@ let result: Result
 
 Parses human-readable ABI item (e.g. error, event, function) into ABI item.
 
-| Name         | Description              | Type                  |
-| ------------ | ------------------------ | --------------------- |
-| `TSignature` | Human-Readable ABI item. | `string[]`            |
-| returns      | Parsed ABI item          | `TAbiItem` (inferred) |
+| Name        | Description              | Type                 |
+| ----------- | ------------------------ | -------------------- |
+| `signature` | Human-Readable ABI item. | `string[]`           |
+| returns     | Parsed ABI item          | `abiItem` (inferred) |
 
 #### Example
 
@@ -293,10 +293,10 @@ let resultStruct: ResultStruct
 
 Parses human-readable ABI parameter into [`AbiParameter`](/api/types#abiparameter).
 
-| Name     | Description                                      | Type                       |
-| -------- | ------------------------------------------------ | -------------------------- |
-| `TParam` | Human-Readable ABI parameter.                    | `string \| string[]`       |
-| returns  | Parsed [`AbiParameter`](/api/types#abiparameter) | `TAbiParameter` (inferred) |
+| Name    | Description                                      | Type                      |
+| ------- | ------------------------------------------------ | ------------------------- |
+| `param` | Human-Readable ABI parameter.                    | `string \| string[]`      |
+| returns | Parsed [`AbiParameter`](/api/types#abiparameter) | `abiParameter` (inferred) |
 
 #### Example
 
@@ -331,10 +331,10 @@ type ResultStruct = ParseAbiParameter<[
 
 Parses human-readable ABI parameters into [`AbiParameter`s](/api/types#abiparameter).
 
-| Name      | Description                                       | Type                         |
-| --------- | ------------------------------------------------- | ---------------------------- |
-| `TParams` | Human-Readable ABI parameters.                    | `string \| string[]`         |
-| returns   | Parsed [`AbiParameter`s](/api/types#abiparameter) | `TAbiParameter[]` (inferred) |
+| Name     | Description                                       | Type                        |
+| -------- | ------------------------------------------------- | --------------------------- |
+| `params` | Human-Readable ABI parameters.                    | `string \| string[]`        |
+| returns  | Parsed [`AbiParameter`s](/api/types#abiparameter) | `abiParameter[]` (inferred) |
 
 #### Example
 
@@ -373,10 +373,10 @@ type ResultStruct = ParseAbiParameters<[
 
 Formats [`Abi`](/api/types#abi) into human-readable ABI.
 
-| Name        | Description         | Type                        |
-| ----------- | ------------------- | --------------------------- |
-| `TAbi`      | ABI                 | [`Abi`](/api/types#abi)     |
-| returns     | Human-Readable ABI. | `string[]` (inferred)       |
+| Name    | Description         | Type                    |
+| ------- | ------------------- | ----------------------- |
+| `abi`   | ABI                 | [`Abi`](/api/types#abi) |
+| returns | Human-Readable ABI. | `string[]` (inferred)   |
 
 #### Example
 
@@ -411,10 +411,10 @@ type Result = FormatAbi<[
 
 Formats Abi item (e.g. error, event, function) into human-readable ABI parameter.
 
-| Name            | Description              | Type                                |
-| --------------- | ------------------------ | ----------------------------------- |
-| `TAbiItem`      | ABI item                 | [`Abi[number]`](/api/types#abi)     |
-| returns         | Human-Readable ABI item. | `string` (inferred)                 |
+| Name      | Description              | Type                            |
+| --------- | ------------------------ | ------------------------------- |
+| `abiItem` | ABI item                 | [`Abi[number]`](/api/types#abi) |
+| returns   | Human-Readable ABI item. | `string` (inferred)             |
 
 #### Example
 
@@ -438,10 +438,10 @@ type Result = FormatAbiItem<{
 
 Formats [`AbiParameter`](/api/types#abiparameter) into human-readable ABI parameter.
 
-| Name            | Description                    | Type                                             |
-| --------------- | ------------------------------ | ------------------------------------------------ |
-| `TAbiParameter` | ABI parameter                  | [`AbiParameter`](/api/types#abiparameter)        |
-| returns         | Human-Readable ABI parameters. | `string[]` (inferred)                            |
+| Name           | Description                    | Type                                      |
+| -------------- | ------------------------------ | ----------------------------------------- |
+| `abiParameter` | ABI parameter                  | [`AbiParameter`](/api/types#abiparameter) |
+| returns        | Human-Readable ABI parameters. | `string[]` (inferred)                     |
 
 #### Example
 
@@ -456,10 +456,10 @@ type Result = FormatAbiParameter<{ type: 'address'; name: 'from' }>
 
 Formats [`AbiParameter`s](/api/types#abiparameter) into human-readable ABI parameters.
 
-| Name             | Description                   | Type                                               |
-| ---------------- | ----------------------------- | -------------------------------------------------- |
-| `TAbiParameters` | ABI parameters                | [`AbiParameter[]`](/api/types#abiparameter)        |
-| returns          | Human-Readable ABI parameter. | `string` (inferred)                                |
+| Name            | Description                   | Type                                        |
+| --------------- | ----------------------------- | ------------------------------------------- |
+| `abiParameters` | ABI parameters                | [`AbiParameter[]`](/api/types#abiparameter) |
+| returns         | Human-Readable ABI parameter. | `string` (inferred)                         |
 
 #### Example
 
@@ -487,10 +487,10 @@ These functions throw [errors](#errors-1) for invalid inputs. Make sure you hand
 
 Parses human-readable ABI into JSON [`Abi`](/api/types#abi).
 
-| Name         | Description                    | Type              |
-| ------------ | ------------------------------ | ----------------- |
-| `signatures` | Human-Readable ABI.            | `string[]`        |
-| returns      | Parsed [`Abi`](/api/types#abi) | `TAbi` (inferred) |
+| Name         | Description                    | Type             |
+| ------------ | ------------------------------ | ---------------- |
+| `signatures` | Human-Readable ABI.            | `string[]`       |
+| returns      | Parsed [`Abi`](/api/types#abi) | `abi` (inferred) |
 
 #### Example
 
@@ -522,10 +522,10 @@ abi
 
 Parses human-readable ABI item (e.g. error, event, function) into ABI item.
 
-| Name        | Description              | Type                  |
-| ----------- | ------------------------ | --------------------- |
-| `signature` | Human-Readable ABI item. | `string \| string[]`  |
-| returns     | Parsed ABI item          | `TAbiItem` (inferred) |
+| Name        | Description              | Type                 |
+| ----------- | ------------------------ | -------------------- |
+| `signature` | Human-Readable ABI item. | `string \| string[]` |
+| returns     | Parsed ABI item          | `abiItem` (inferred) |
 
 #### Example
 
@@ -577,10 +577,10 @@ abiItemStruct
 
 Parses human-readable ABI parameter into [`AbiParameter`](/api/types#abiparameter).
 
-| Name    | Description                                      | Type                       |
-| ------- | ------------------------------------------------ | -------------------------- |
-| `param` | Human-Readable ABI parameter.                    | `string \| string[]`       |
-| returns | Parsed [`AbiParameter`](/api/types#abiparameter) | `TAbiParameter` (inferred) |
+| Name    | Description                                      | Type                      |
+| ------- | ------------------------------------------------ | ------------------------- |
+| `param` | Human-Readable ABI parameter.                    | `string \| string[]`      |
+| returns | Parsed [`AbiParameter`](/api/types#abiparameter) | `abiParameter` (inferred) |
 
 #### Example
 
@@ -615,10 +615,10 @@ abiParameterStruct
 
 Parses human-readable ABI parameters into [`AbiParameter`s](/api/types#abiparameter).
 
-| Name     | Description                                       | Type                         |
-| -------- | ------------------------------------------------- | ---------------------------- |
-| `params` | Human-Readable ABI parameters.                    | `string \| string[]`         |
-| returns  | Parsed [`AbiParameter`s](/api/types#abiparameter) | `TAbiParameter[]` (inferred) |
+| Name     | Description                                       | Type                        |
+| -------- | ------------------------------------------------- | --------------------------- |
+| `params` | Human-Readable ABI parameters.                    | `string \| string[]`        |
+| returns  | Parsed [`AbiParameter`s](/api/types#abiparameter) | `abiParameter[]` (inferred) |
 
 #### Example
 
@@ -662,10 +662,10 @@ abiParametersStruct
 
 Formats [`Abi`](/api/types#abi) into human-readable ABI.
 
-| Name        | Description         | Type                        |
-| ----------- | ------------------- | --------------------------- |
-| `abi`       | ABI                 | [`Abi`](/api/types#abi)     |
-| returns     | Human-Readable ABI. | `string[]` (inferred)       |
+| Name        | Description         | Type                    |
+| ----------- | ------------------- | ----------------------- |
+| `abi`       | ABI                 | [`Abi`](/api/types#abi) |
+| returns     | Human-Readable ABI. | `string[]` (inferred)   |
 
 #### Example
 
@@ -700,10 +700,10 @@ const result = formatAbi([
 
 Formats Abi item (e.g. error, event, function) into human-readable ABI parameter.
 
-| Name            | Description              | Type                                |
-| --------------- | ------------------------ | ----------------------------------- |
-| `abiItem`       | ABI item                 | [`Abi[number]`](/api/types#abi)     |
-| returns         | Human-Readable ABI item. | `string` (inferred)                 |
+| Name            | Description              | Type                            |
+| --------------- | ------------------------ | ------------------------------- |
+| `abiItem`       | ABI item                 | [`Abi[number]`](/api/types#abi) |
+| returns         | Human-Readable ABI item. | `string` (inferred)             |
 
 #### Example
 
@@ -727,10 +727,10 @@ const result = formatAbiItem({
 
 Formats [`AbiParameter`](/api/types#abiparameter) into human-readable ABI parameter.
 
-| Name           | Description                   | Type                                             |
-| -------------- | ----------------------------- | ------------------------------------------------ |
-| `abiParameter` | ABI parameter                 | [`AbiParameter`](/api/types#abiparameter)        |
-| returns        | Human-Readable ABI parameter. | `string` (inferred)                              |
+| Name           | Description                   | Type                                      |
+| -------------- | ----------------------------- | ----------------------------------------- |
+| `abiParameter` | ABI parameter                 | [`AbiParameter`](/api/types#abiparameter) |
+| returns        | Human-Readable ABI parameter. | `string` (inferred)                       |
 
 #### Example
 
@@ -745,10 +745,10 @@ const result = formatAbiParameter({ type: 'address', name: 'from' })
 
 Formats [`AbiParameter`s](/api/types#abiparameter) into human-readable ABI parameters.
 
-| Name             | Description                   | Type                                               |
-| ---------------- | ----------------------------- | -------------------------------------------------- |
-| `abiParameters`  | ABI parameters                | [`AbiParameter[]`](/api/types#abiparameter)        |
-| returns          | Human-Readable ABI parameter. | `string` (inferred)                                |
+| Name             | Description                   | Type                                        |
+| ---------------- | ----------------------------- | ------------------------------------------- |
+| `abiParameters`  | ABI parameters                | [`AbiParameter[]`](/api/types#abiparameter) |
+| returns          | Human-Readable ABI parameter. | `string` (inferred)                         |
 
 #### Example
 
@@ -784,4 +784,4 @@ import {
   InvalidAbiItemError,
   UnknownTypeError,
 } from 'abitype'
-```
+```
diff --git a/docs/pages/api/utilities.md b/docs/pages/api/utilities.md
@@ -39,7 +39,7 @@ Converts array of `AbiParameter` to corresponding TypeScript primitive types.
 | ------------------- | ---------------------------------------------------- | ----------------------------- |
 | `abiParameters`     | Parameters to convert to TypeScript representations. | `readonly AbiParameter[]`     |
 | `abiParameterKind`  | Kind to narrow by parameter type.                    | `AbiParameterKind` (optional) |
-| returns             | TypeScript primitive types.                          | `type[]` (in ferred)          |
+| returns             | TypeScript primitive types.                          | `type[]` (inferred)           |
 
 #### Example
 

diff --git a/docs/pages/config.md b/docs/pages/config.md
@@ -13,12 +13,12 @@ ABIType's types are customizable using [declaration merging](https://www.typescr
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    BigIntType: bigint & { foo: 'bar' }
+    bigIntType: bigint & { foo: 'bar' }
   }
 }
 
 import { ResolvedRegister } from 'abitype'
-type Result = ResolvedRegister['BigIntType']
+type Result = ResolvedRegister['bigIntType']
 //   ^?
 
 
@@ -31,7 +31,7 @@ If you are using ABIType via another package (e.g. [`viem`](https://viem.sh)), y
 ```ts
 declare module 'viem/node_modules/abitype' {
   export interface Register {
-    BigIntType: MyCustomBigIntType
+    bigIntType: MyCustomBigIntType
   }
 }
 ```
@@ -42,10 +42,10 @@ declare module 'viem/node_modules/abitype' {
 ABIType tries to strike a balance between type exhaustiveness and speed with sensible defaults. In some cases, you might want to tune your configuration (e.g. use a custom `bigint` type). To do this, the following configuration options are available:
 
 :::warning
-When configuring `ArrayMaxDepth`, `FixedArrayMinLength`, and `FixedArrayMaxLength`, there are trade-offs. For example, choosing a non-false value for `ArrayMaxDepth` and increasing the range between `FixedArrayMinLength` and `FixedArrayMaxLength` will make your types more exhaustive, but will also slow down the compiler for type checking, autocomplete, etc.
+When configuring `arrayMaxDepth`, `fixedArrayMinLength`, and `fixedArrayMaxLength`, there are trade-offs. For example, choosing a non-false value for `arrayMaxDepth` and increasing the range between `fixedArrayMinLength` and `fixedArrayMaxLength` will make your types more exhaustive, but will also slow down the compiler for type checking, autocomplete, etc.
 :::
 
-### `AddressType`
+### `addressType`
 
 TypeScript type to use for `address` values.
 
@@ -55,12 +55,12 @@ TypeScript type to use for `address` values.
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    AddressType: `0x${string}`
+    addressType: `0x${string}`
   }
 }
 ```
 
-### `ArrayMaxDepth`
+### `arrayMaxDepth`
 
 Maximum depth for nested array types (e.g. `string[][]`). When `false`, there is no maximum array depth.
 
@@ -75,7 +75,7 @@ declare module 'abitype' {
 }
 ```
 
-### `BigIntType`
+### `bigIntType`
 
 TypeScript type to use for `int<M>` and `uint<M>` values, where `M > 48`.
 
@@ -85,12 +85,12 @@ TypeScript type to use for `int<M>` and `uint<M>` values, where `M > 48`.
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    BigIntType: bigint
+    bigIntType: bigint
   }
 }
 ```
 
-### `BytesType`
+### `bytesType`
 
 TypeScript type to use for `bytes<M>` values.
 
@@ -100,15 +100,15 @@ TypeScript type to use for `bytes<M>` values.
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    BytesType: {
+    bytesType: {
       inputs: `0x${string}`
       outputs: `0x${string}`
     }
   }
 }
 ```
 
-### `FixedArrayMinLength`
+### `fixedArrayMinLength`
 
 Lower bound for fixed-length arrays.
 
@@ -123,7 +123,7 @@ declare module 'abitype' {
 }
 ```
 
-### `FixedArrayMaxLength`
+### `fixedArrayMaxLength`
 
 Upper bound for fixed-length arrays.
 
@@ -138,7 +138,7 @@ declare module 'abitype' {
 }
 ```
 
-### `IntType`
+### `intType`
 
 TypeScript type to use for `int<M>` and `uint<M>` values, where `M <= 48`.
 
@@ -148,12 +148,12 @@ TypeScript type to use for `int<M>` and `uint<M>` values, where `M <= 48`.
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    IntType: number
+    intType: number
   }
 }
 ```
 
-### `StrictAbiType`
+### `strictAbiType`
 
 When set, validates `AbiParameter`'s `type` against `AbiType`.
 
@@ -163,7 +163,7 @@ When set, validates `AbiParameter`'s `type` against `AbiType`.
 ```ts twoslash
 declare module 'abitype' {
   export interface Register {
-    StrictAbiType: false
+    strictAbiType: false
   }
 }
 ```