Skip to content

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

ParameterTypeDescription
messagestring-
fieldNamesstring[]The arguments at fault, such as ['tokenAmounts'].
cause?unknown-

Returns

InvalidArgumentError

Overrides

BaseError.constructor

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 ParameterDescription
T extends ErrorThe error class being searched for.

Parameters

ParameterTypeDescription
errorType(…args) => TThe 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

Inherited from

BaseError.walk