ForbiddenError

Thrown when an authenticated user lacks the required permissions.

Extends

• GraphQLError

Constructors

Constructor

new ForbiddenError(message, options?): ForbiddenError

Parameters

Parameter	Type	Default value
message	string	"Access denied! You don't have permission to perform this action!"
options?	GraphQLErrorOptions	undefined

Returns

ForbiddenError

Overrides

GraphQLError.constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
extensions	readonly	GraphQLErrorExtensions & object	Extension fields to add to the formatted error.	GraphQLError.extensions	‐
locations	readonly	undefined | 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().	‐	GraphQLError.locations
message	public	string	‐	‐	GraphQLError.message
name	public	string	‐	‐	GraphQLError.name
nodes	readonly	undefined | readonly ASTNode[]	An array of GraphQL AST Nodes corresponding to this error.	‐	GraphQLError.nodes
originalError	readonly	undefined | Error	The original error thrown from a field resolver during execution.	‐	GraphQLError.originalError
path	readonly	undefined | 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().	‐	GraphQLError.path
positions	readonly	undefined | readonly number[]	An array of character offsets within the source GraphQL document which correspond to this error.	‐	GraphQLError.positions
source	readonly	undefined | 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.	‐	GraphQLError.source
cause?	public	unknown	‐	‐	GraphQLError.cause
stack?	public	string	‐	‐	GraphQLError.stack

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Returns

string

Inherited from

GraphQLError.[toStringTag]

Methods

toJSON()

toJSON(): GraphQLFormattedError

Returns

GraphQLFormattedError

Inherited from

GraphQLError.toJSON

---

toString()

toString(): string

Returns a string representation of an object.

Returns

string

Inherited from

GraphQLError.toString