API ReferenceErrorsClass
InvalidArgumentError
Error thrown when the arguments to an SDK call cannot be used, before anything is sent: a required list is empty, two options conflict, or a value is out of range. The message says what is wrong.
Extends
Constructors
Constructor
new InvalidArgumentError( message, fieldNames?, cause?): InvalidArgumentError;Parameters
| Parameter | Type | Description |
|---|---|---|
message | string | - |
fieldNames | string[] | The arguments at fault, such as ['tokenAmounts']. |
cause? | unknown | - |
Returns
InvalidArgumentError
Overrides
Properties
fieldNames
readonly fieldNames: string[] = [];The arguments at fault, such as ['tokenAmounts'].
Methods
walk()
walk<T>(errorType): T | undefined;Finds an error of the given class in this error’s cause chain. The search starts with this error
itself, then follows each cause in turn.
Type Parameters
| Type Parameter | Description |
|---|---|
T extends Error | The error class being searched for. |
Parameters
| Parameter | Type | Description |
|---|---|---|
errorType | (…args) => T | The error class to find, such as UserRejectedRequestError. |
Returns
T | undefined
The first error in the chain that is an instance of errorType, or undefined if there is none.
Example
const rejected = error.walk(UserRejectedRequestError);if (rejected) return; // the user declined in their wallet