Class ArgumentValidationError

Hierarchy

  • GraphQLError
    • ArgumentValidationError

Constructors

constructor

Properties

coordinate? extensions locations message name nodes originalError path positions source stack? prepareStackTrace? stackTraceLimit

Accessors

[toStringTag]

Methods

toJSON toString captureStackTrace

Constructors

constructor

  • new ArgumentValidationError(validationErrors): ArgumentValidationError

  • Parameters

    • validationErrors: ValidationError[]

    Returns ArgumentValidationError

Properties

Optional Readonly coordinate

coordinate?: string

An optional schema coordinate (e.g. "MyType.myField") associated with this error.

Readonly extensions

extensions: {
    code: "BAD_USER_INPUT";
    validationErrors: ValidationError[];
    [attributeName: string]: unknown;
}

Type declaration

  • [attributeName: string]: unknown
  • code: "BAD_USER_INPUT"
  • validationErrors: ValidationError[]

Readonly locations

locations: readonly SourceLocation[]

An array of { line, column } locations within the source GraphQL document which correspond to this error.

Errors during validation often contain multiple locations, for example to point out two things with the same name. Errors during execution include a single location, the field which produced the error.

Enumerable, and appears in the result of JSON.stringify().

message

message: string

name

name: string

Readonly nodes

nodes: readonly ASTNode[]

An array of GraphQL AST Nodes corresponding to this error.

Readonly originalError

originalError: Error

The original error thrown from a field resolver during execution.

Readonly path

path: readonly (string | number)[]

An array describing the JSON-path into the execution response which corresponds to this error. Only included for errors during execution.

Enumerable, and appears in the result of JSON.stringify().

Readonly positions

positions: readonly number[]

An array of character offsets within the source GraphQL document which correspond to this error.

Readonly source

source: Source

The source GraphQL document for the first location of this error.

Note that if this Error represents more than one node, the source may not represent nodes after the first node.

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

Methods

toJSON

  • toJSON(): GraphQLFormattedError

  • Returns GraphQLFormattedError

toString

  • toString(): string

  • Returns string

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcoordinateextensionslocationsmessagenamenodesoriginalErrorpathpositionssourcestackprepareStackTracestackTraceLimit[toStringTag]toJSONtoStringcaptureStackTrace