For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /common/classes/InvalidArgumentError.md.

Class: InvalidArgumentError

error

表示指定传递给方法的参数不正确或不被允许。

Specifies that a passed-in argument to a method is not correct or allowed.

Extends

  • Error

Constructors

Constructor

new InvalidArgumentError(funcName, argTypeName, errorType, argIndex?): InvalidArgumentError

Parameters

funcName

string

argTypeName

string

errorType

InvalidArgumentErrorType

argIndex?

number

Returns

InvalidArgumentError

Remarks

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Inherited from

Error.cause


index

readonly index: number

Early Execution

Remarks

出错的参数的索引。

Index of the argument that is in error.


message

message: string

Inherited from

Error.message


name

name: string

Inherited from

Error.name


stack?

optional stack?: string

Inherited from

Error.stack


type

readonly type: InvalidArgumentErrorType

Early Execution

Remarks

参数错误的类型。

Type of the argument error.


stackTraceLimit

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

同领域相关