Class InvalidTokenAmountError

Error type indicating the supplied token amount is not compatible with the token.

Hierarchy

TokenError
- InvalidTokenAmountError

Index

Constructors

Properties

amount code message stack? tokenDecimals prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new InvalidTokenAmountError(tokenDecimals: number, amount: TokenAmount): InvalidTokenAmountError
Constructs a new InvalidTokenAmountError.
Parameters
- tokenDecimals: number
  
  The number of decimals the token supports.
- amount: TokenAmount
  
  The token amount that is invalid.
Returns InvalidTokenAmountError
Overrides TokenError.constructor
- Defined in packages/sdk/src/plt/Token.ts:121

Properties

`Readonly` amount

amount: TokenAmount

The token amount that is invalid.

`Readonly` code

code: INVALID_TOKEN_AMOUNT = TokenErrorCode.INVALID_TOKEN_AMOUNT

message

message: string

`Optional` stack

stack?: string

`Readonly` tokenDecimals

tokenDecimals: number

The number of decimals the token supports.

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

name

get name(): string
Gets the name of the error, including its code.

Returns
The name of the error.

Returns string
Inherited from TokenError.name
- Defined in packages/sdk/src/plt/Token.ts:88

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from TokenError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc