Skip to main content

@baeta/errors

Enumerations

BaetaErrorCode

Standard error codes used across the Baeta framework.

Enumeration Members

Enumeration MemberValueDescription

AggregateError

"AGGREGATE_ERROR"

Multiple errors occurred simultaneously

BadUserInput

"BAD_USER_INPUT"

Invalid input provided by the user

Forbidden

"FORBIDDEN"

User is authenticated but lacks required permissions

InternalServerError

"INTERNAL_SERVER_ERROR"

Unexpected server-side error

Unauthenticated

"UNAUTHENTICATED"

Authentication is required but was not provided

Classes

AggregateGraphQLError

Represents multiple GraphQL errors that occurred simultaneously. Useful for batch operations where multiple errors need to be reported.

Extends

  • GraphQLError

Constructors

new AggregateGraphQLError()

new AggregateGraphQLError(errors, message, options?): AggregateGraphQLError

Parameters
ParameterTypeDefault value

errors

GraphQLError[]

undefined

message

string

'Multiple errors encountered'

options?

GraphQLErrorOptions

undefined

Returns

AggregateGraphQLError

Overrides

GraphQLError.constructor

Properties

PropertyModifierTypeDescriptionInherited from

extensions

readonly

GraphQLErrorExtensions

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


BadUserInput

Thrown when the user provides invalid input data.

Extends

  • GraphQLError

Constructors

new BadUserInput()

new BadUserInput(message, options?): BadUserInput

Parameters
ParameterTypeDefault value

message

string

'Invalid user input!'

options?

GraphQLErrorOptions

undefined

Returns

BadUserInput

Overrides

GraphQLError.constructor

Properties

PropertyModifierTypeDescriptionInherited from

extensions

readonly

GraphQLErrorExtensions

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


ForbiddenError

Thrown when an authenticated user lacks the required permissions.

Extends

  • GraphQLError

Constructors

new ForbiddenError()

new ForbiddenError(message, options?): ForbiddenError

Parameters
ParameterTypeDefault value

message

string

"Access denied! You don't have permission to perform this action!"

options?

GraphQLErrorOptions

undefined

Returns

ForbiddenError

Overrides

GraphQLError.constructor

Properties

PropertyModifierTypeDescriptionInherited from

extensions

readonly

GraphQLErrorExtensions

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


InternalServerError

Thrown when an unexpected server-side error occurs. In development mode, includes the original error message and stack trace. In production, shows a generic error message.

Extends

  • GraphQLError

Constructors

new InternalServerError()

new InternalServerError(err, message, options?): InternalServerError

Parameters
ParameterTypeDefault value

err

Error

undefined

message

string

'Internal server error!'

options?

GraphQLErrorOptions

undefined

Returns

InternalServerError

Overrides

GraphQLError.constructor

Properties

PropertyModifierTypeDescriptionInherited from

extensions

readonly

GraphQLErrorExtensions

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


UnauthenticatedError

Thrown when a user attempts to access a resource without authentication. Results in a 401 HTTP status code.

Extends

  • GraphQLError

Constructors

new UnauthenticatedError()

new UnauthenticatedError(message, options?): UnauthenticatedError

Parameters
ParameterTypeDefault value

message

string

'Access denied! You need to be authenticated to perform this action!'

options?

GraphQLErrorOptions

undefined

Returns

UnauthenticatedError

Overrides

GraphQLError.constructor

Properties

PropertyModifierTypeDescriptionInherited from

extensions

readonly

GraphQLErrorExtensions

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