chore: generate docs

JoinColony · Jan 28, 2025 · 64fe03a · 64fe03a
1 parent ec21928
commit 64fe03a
Show file tree

Hide file tree

Showing 1,926 changed files with 339,224 additions and 110,187 deletions.
diff --git a/packages/colony-js/docs/api/README.md b/packages/colony-js/docs/api/README.md
diff --git a/packages/colony-js/docs/api/classes/ColonyFactory.md b/packages/colony-js/docs/api/classes/ColonyFactory.md
diff --git a/packages/colony-js/docs/api/classes/ColonyNetworkFactory.md b/packages/colony-js/docs/api/classes/ColonyNetworkFactory.md
diff --git a/packages/colony-js/docs/api/classes/ColonyTokenFactory.md b/packages/colony-js/docs/api/classes/ColonyTokenFactory.md
diff --git a/packages/colony-js/docs/api/classes/ERC20TokenFactory.md b/packages/colony-js/docs/api/classes/ERC20TokenFactory.md
@@ -1,39 +1,50 @@
+[**API**](../README.md)
+
+***
+
 # Class: ERC20TokenFactory
 
 ## Constructors
 
-### constructor
+### new ERC20TokenFactory()
+
+> **new ERC20TokenFactory**(): [`ERC20TokenFactory`](ERC20TokenFactory.md)
+
+#### Returns
 
-• **new ERC20TokenFactory**()
+[`ERC20TokenFactory`](ERC20TokenFactory.md)
 
 ## Properties
 
 ### abi
 
-▪ `Static` `Readonly` **abi**: readonly [{ `inputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``"name_"`` ; `type`: ``"string"``  }, { `internalType`: ``"string"`` ; `name`: ``"symbol_"`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"constructor"``  }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"value"`` ; `type`: ``"uint256"``  }] ; `name`: ``"Approval"`` ; `type`: ``"event"``  }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"``  }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"value"`` ; `type`: ``"uint256"``  }] ; `name`: ``"Transfer"`` ; `type`: ``"event"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }, { `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }] ; `name`: ``"allowance"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"approve"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"account"`` ; `type`: ``"address"``  }] ; `name`: ``"balanceOf"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"decimals"`` ; `outputs`: readonly [{ `internalType`: ``"uint8"`` ; `name`: ``""`` ; `type`: ``"uint8"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"name"`` ; `outputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``""`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"symbol"`` ; `outputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``""`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"totalSupply"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"transfer"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"``  }, { `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"transferFrom"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }]
+> `readonly` `static` **abi**: readonly \[\{ `inputs`: readonly \[\{ `internalType`: `"string"`; `name`: `"name_"`; `type`: `"string"`; \}, \{ `internalType`: `"string"`; `name`: `"symbol_"`; `type`: `"string"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"constructor"`; \}, \{ `anonymous`: `false`; `inputs`: readonly \[\{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}, \{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}, \{ `indexed`: `false`; `internalType`: `"uint256"`; `name`: `"value"`; `type`: `"uint256"`; \}\]; `name`: `"Approval"`; `type`: `"event"`; \}, \{ `anonymous`: `false`; `inputs`: readonly \[\{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"from"`; `type`: `"address"`; \}, \{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `indexed`: `false`; `internalType`: `"uint256"`; `name`: `"value"`; `type`: `"uint256"`; \}\]; `name`: `"Transfer"`; `type`: `"event"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}, \{ `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}\]; `name`: `"allowance"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"approve"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"account"`; `type`: `"address"`; \}\]; `name`: `"balanceOf"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"decimals"`; `outputs`: readonly \[\{ `internalType`: `"uint8"`; `name`: `""`; `type`: `"uint8"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"name"`; `outputs`: readonly \[\{ `internalType`: `"string"`; `name`: `""`; `type`: `"string"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"symbol"`; `outputs`: readonly \[\{ `internalType`: `"string"`; `name`: `""`; `type`: `"string"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"totalSupply"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"transfer"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"from"`; `type`: `"address"`; \}, \{ `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"transferFrom"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}\]
 
 ## Methods
 
-### connect
+### connect()
 
-▸ `Static` **connect**(`address`, `signerOrProvider`): [`ERC20Token`](../interfaces/ERC20Token.md)
+> `static` **connect**(`address`, `signerOrProvider`): [`ERC20Token`](../interfaces/ERC20Token.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `address` | `string` |
-| `signerOrProvider` | `Signer` \| `Provider` |
+##### address
+
+`string`
+
+##### signerOrProvider
+
+`Signer` | `Provider`
 
 #### Returns
 
 [`ERC20Token`](../interfaces/ERC20Token.md)
 
-___
+***
 
-### createInterface
+### createInterface()
 
-▸ `Static` **createInterface**(): `TokenERC20Interface`
+> `static` **createInterface**(): `TokenERC20Interface`
 
 #### Returns
 

diff --git a/packages/colony-js/docs/api/classes/ERC2612TokenFactory.md b/packages/colony-js/docs/api/classes/ERC2612TokenFactory.md
@@ -1,39 +1,50 @@
+[**API**](../README.md)
+
+***
+
 # Class: ERC2612TokenFactory
 
 ## Constructors
 
-### constructor
+### new ERC2612TokenFactory()
+
+> **new ERC2612TokenFactory**(): [`ERC2612TokenFactory`](ERC2612TokenFactory.md)
+
+#### Returns
 
-• **new ERC2612TokenFactory**()
+[`ERC2612TokenFactory`](ERC2612TokenFactory.md)
 
 ## Properties
 
 ### abi
 
-▪ `Static` `Readonly` **abi**: readonly [{ `inputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``"name_"`` ; `type`: ``"string"``  }, { `internalType`: ``"string"`` ; `name`: ``"symbol_"`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"constructor"``  }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"value"`` ; `type`: ``"uint256"``  }] ; `name`: ``"Approval"`` ; `type`: ``"event"``  }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"``  }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"value"`` ; `type`: ``"uint256"``  }] ; `name`: ``"Transfer"`` ; `type`: ``"event"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }, { `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }] ; `name`: ``"allowance"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"approve"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"account"`` ; `type`: ``"address"``  }] ; `name`: ``"balanceOf"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"decimals"`` ; `outputs`: readonly [{ `internalType`: ``"uint8"`` ; `name`: ``""`` ; `type`: ``"uint8"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"name"`` ; `outputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``""`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"symbol"`` ; `outputs`: readonly [{ `internalType`: ``"string"`` ; `name`: ``""`` ; `type`: ``"string"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"totalSupply"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"transfer"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"``  }, { `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"``  }] ; `name`: ``"transferFrom"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"``  }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }, { `internalType`: ``"address"`` ; `name`: ``"spender"`` ; `type`: ``"address"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"value"`` ; `type`: ``"uint256"``  }, { `internalType`: ``"uint256"`` ; `name`: ``"deadline"`` ; `type`: ``"uint256"``  }, { `internalType`: ``"uint8"`` ; `name`: ``"v"`` ; `type`: ``"uint8"``  }, { `internalType`: ``"bytes32"`` ; `name`: ``"r"`` ; `type`: ``"bytes32"``  }, { `internalType`: ``"bytes32"`` ; `name`: ``"s"`` ; `type`: ``"bytes32"``  }] ; `name`: ``"permit"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"``  }, { `inputs`: readonly [] ; `name`: ``"DOMAIN_SEPARATOR"`` ; `outputs`: readonly [{ `internalType`: ``"bytes32"`` ; `name`: ``""`` ; `type`: ``"bytes32"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"``  }] ; `name`: ``"nonces"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"``  }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"``  }]
+> `readonly` `static` **abi**: readonly \[\{ `inputs`: readonly \[\{ `internalType`: `"string"`; `name`: `"name_"`; `type`: `"string"`; \}, \{ `internalType`: `"string"`; `name`: `"symbol_"`; `type`: `"string"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"constructor"`; \}, \{ `anonymous`: `false`; `inputs`: readonly \[\{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}, \{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}, \{ `indexed`: `false`; `internalType`: `"uint256"`; `name`: `"value"`; `type`: `"uint256"`; \}\]; `name`: `"Approval"`; `type`: `"event"`; \}, \{ `anonymous`: `false`; `inputs`: readonly \[\{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"from"`; `type`: `"address"`; \}, \{ `indexed`: `true`; `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `indexed`: `false`; `internalType`: `"uint256"`; `name`: `"value"`; `type`: `"uint256"`; \}\]; `name`: `"Transfer"`; `type`: `"event"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}, \{ `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}\]; `name`: `"allowance"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"approve"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"account"`; `type`: `"address"`; \}\]; `name`: `"balanceOf"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"decimals"`; `outputs`: readonly \[\{ `internalType`: `"uint8"`; `name`: `""`; `type`: `"uint8"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"name"`; `outputs`: readonly \[\{ `internalType`: `"string"`; `name`: `""`; `type`: `"string"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"symbol"`; `outputs`: readonly \[\{ `internalType`: `"string"`; `name`: `""`; `type`: `"string"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"totalSupply"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"transfer"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"from"`; `type`: `"address"`; \}, \{ `internalType`: `"address"`; `name`: `"to"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"amount"`; `type`: `"uint256"`; \}\]; `name`: `"transferFrom"`; `outputs`: readonly \[\{ `internalType`: `"bool"`; `name`: `""`; `type`: `"bool"`; \}\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}, \{ `internalType`: `"address"`; `name`: `"spender"`; `type`: `"address"`; \}, \{ `internalType`: `"uint256"`; `name`: `"value"`; `type`: `"uint256"`; \}, \{ `internalType`: `"uint256"`; `name`: `"deadline"`; `type`: `"uint256"`; \}, \{ `internalType`: `"uint8"`; `name`: `"v"`; `type`: `"uint8"`; \}, \{ `internalType`: `"bytes32"`; `name`: `"r"`; `type`: `"bytes32"`; \}, \{ `internalType`: `"bytes32"`; `name`: `"s"`; `type`: `"bytes32"`; \}\]; `name`: `"permit"`; `outputs`: readonly \[\]; `stateMutability`: `"nonpayable"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\]; `name`: `"DOMAIN_SEPARATOR"`; `outputs`: readonly \[\{ `internalType`: `"bytes32"`; `name`: `""`; `type`: `"bytes32"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}, \{ `inputs`: readonly \[\{ `internalType`: `"address"`; `name`: `"owner"`; `type`: `"address"`; \}\]; `name`: `"nonces"`; `outputs`: readonly \[\{ `internalType`: `"uint256"`; `name`: `""`; `type`: `"uint256"`; \}\]; `stateMutability`: `"view"`; `type`: `"function"`; \}\]
 
 ## Methods
 
-### connect
+### connect()
 
-▸ `Static` **connect**(`address`, `signerOrProvider`): [`ERC2612Token`](../interfaces/ERC2612Token.md)
+> `static` **connect**(`address`, `signerOrProvider`): [`ERC2612Token`](../interfaces/ERC2612Token.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `address` | `string` |
-| `signerOrProvider` | `Signer` \| `Provider` |
+##### address
+
+`string`
+
+##### signerOrProvider
+
+`Signer` | `Provider`
 
 #### Returns
 
 [`ERC2612Token`](../interfaces/ERC2612Token.md)
 
-___
+***
 
-### createInterface
+### createInterface()
 
-▸ `Static` **createInterface**(): `TokenERC2612Interface`
+> `static` **createInterface**(): `TokenERC2612Interface`
 
 #### Returns