mochi - v2.0.0

mochi/error

Types

ErrorCategory

</>

Error category for extensions

pub type ErrorCategory {
  ValidationErrorCategory
  ResolverErrorCategory
  TypeErrorCategory
  AuthenticationErrorCategory
  AuthorizationErrorCategory
  InternalErrorCategory
  UserInputErrorCategory
}

Constructors 

  • ValidationErrorCategory
  • ResolverErrorCategory
  • TypeErrorCategory
  • AuthenticationErrorCategory
  • AuthorizationErrorCategory
  • InternalErrorCategory
  • UserInputErrorCategory

ErrorCode

</> 
pub type ErrorCode {
  NotFound
  Unauthorized
  Forbidden
  BadRequest
  InternalError
}

Constructors 

  • NotFound
  • Unauthorized
  • Forbidden
  • BadRequest
  • InternalError

GqlError

</> 
pub type GqlError =
  GraphQLError

GraphQLError

</>

GraphQL-spec compliant error with extensions support

pub type GraphQLError {
  GraphQLError(
    message: String,
    locations: option.Option(List(Location)),
    path: option.Option(List(PathSegment)),
    extensions: option.Option(dict.Dict(String, dynamic.Dynamic)),
  )
}

Constructors

Location

</>

A GraphQL source location

pub type Location {
  Location(line: Int, column: Int)
}

Constructors 

  • Location(line: Int, column: Int)

PathSegment

</>

Path segment - can be field name or array index

pub type PathSegment {
  FieldSegment(name: String)
  IndexSegment(index: Int)
}

Constructors 

  • FieldSegment(name: String)
  • IndexSegment(index: Int)

Values

append_field

</> 
pub fn append_field(
  path: List(PathSegment),
  field: String,
) -> List(PathSegment)

Add field segment to path

append_index

</> 
pub fn append_index(
  path: List(PathSegment),
  index: Int,
) -> List(PathSegment)

Add index segment to path

at_location

</> 
pub fn at_location(
  err: GraphQLError,
  line: Int,
  column: Int,
) -> GraphQLError

Add a location to an error

authentication_error

</> 
pub fn authentication_error(message: String) -> GraphQLError

authorization_error

</> 
pub fn authorization_error(
  message: String,
  path: List(String),
) -> GraphQLError

Create an authorization error

code_to_string

</> 
pub fn code_to_string(code: ErrorCode) -> String

errors_to_dynamic

</> 
pub fn errors_to_dynamic(
  errors: List(GraphQLError),
) -> dynamic.Dynamic

Convert multiple errors to a list

fail

</> 
pub fn fail(message: String) -> Result(r, GraphQLError)

format

</> 
pub fn format(err: GraphQLError) -> String

Format an error as a human-readable string

internal_error

</> 
pub fn internal_error(message: String) -> GraphQLError

new

</> 
pub fn new(message: String) -> GraphQLError

new_at

</> 
pub fn new_at(
  message: String,
  path: List(String),
) -> GraphQLError

new_with_path

</> 
pub fn new_with_path(
  message: String,
  path: List(PathSegment),
) -> GraphQLError

path_from_strings

</> 
pub fn path_from_strings(path: List(String)) -> List(PathSegment)

Convert string path to PathSegment list

resolver_error

</> 
pub fn resolver_error(
  message: String,
  path: List(String),
) -> GraphQLError

Create a resolver error

to_dynamic

</> 
pub fn to_dynamic(err: GraphQLError) -> dynamic.Dynamic

Convert a GraphQLError to a Dynamic representation for JSON serialization

to_payload

</> 
pub fn to_payload(
  err: GraphQLError,
) -> #(String, option.Option(dict.Dict(String, dynamic.Dynamic)))

type_error

</> 
pub fn type_error(
  message: String,
  path: List(String),
) -> GraphQLError

Create a type error

user_input_error

</> 
pub fn user_input_error(
  message: String,
  field: String,
  path: List(String),
) -> GraphQLError

Create a user input error

validation_error

</> 
pub fn validation_error(
  message: String,
  path: List(String),
) -> GraphQLError

Create a validation error

with_category

</> 
pub fn with_category(
  err: GraphQLError,
  category: ErrorCategory,
) -> GraphQLError

Set error category in extensions

with_code

</> 
pub fn with_code(err: GraphQLError, code: String) -> GraphQLError

Set error code in extensions

with_error_code

</> 
pub fn with_error_code(
  err: GraphQLError,
  code: ErrorCode,
) -> GraphQLError

with_extension

</> 
pub fn with_extension(
  err: GraphQLError,
  key: String,
  value: dynamic.Dynamic,
) -> GraphQLError

Add an extension to an error

with_extensions

</> 
pub fn with_extensions(
  err: GraphQLError,
  extensions: dict.Dict(String, dynamic.Dynamic),
) -> GraphQLError

Set multiple extensions on an error

with_locations

</> 
pub fn with_locations(
  err: GraphQLError,
  locations: List(Location),
) -> GraphQLError

Add locations to an error

with_path

</> 
pub fn with_path(
  err: GraphQLError,
  path: List(PathSegment),
) -> GraphQLError

Set the path on an error

✨ Search Document