Safe Haskell	None
Language	Haskell2010

GraphQL.Internal.Output

Description

Synopsis

data Response
- = Success Object
- | PreExecutionFailure Errors
- | ExecutionFailure Errors
- | PartialSuccess Object Errors
type Errors = NonEmpty Error
data Error = Error Text [Location]
class GraphQLError e where
- formatError :: e -> Text
- toError :: e -> Error
singleError :: GraphQLError e => e -> Errors

Documentation

data Response Source #

GraphQL response.

A GraphQL response must:

be a map
have a "data" key iff the operation executed
have an "errors" key iff the operation encountered errors
not include "data" if operation failed before execution (e.g. syntax errors, validation errors, missing info)
not have keys other than "data", "errors", and "extensions"

Other interesting things:

Doesn't have to be JSON, but does have to have maps, strings, lists, and null
Can also support bool, int, enum, and float
Value of "extensions" must be a map

"data" must be null if an error was encountered during execution that prevented a valid response.

"errors"

must be a non-empty list
each error is a map with "message", optionally "locations" key with list of locations
locations are maps with 1-indexed "line" and "column" keys.

Constructors

Success Object
PreExecutionFailure Errors
ExecutionFailure Errors
PartialSuccess Object Errors

Instances

Eq Response Source #
Instance details Defined in GraphQL.Internal.Output Methods (==) :: Response -> Response -> Bool # (/=) :: Response -> Response -> Bool #
Ord Response Source #
Instance details Defined in GraphQL.Internal.Output Methods compare :: Response -> Response -> Ordering # (<) :: Response -> Response -> Bool # (<=) :: Response -> Response -> Bool # (>) :: Response -> Response -> Bool # (>=) :: Response -> Response -> Bool # max :: Response -> Response -> Response # min :: Response -> Response -> Response #
Show Response Source #
Instance details Defined in GraphQL.Internal.Output Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
ToJSON Response Source #
Instance details Defined in GraphQL.Internal.Output Methods toJSON :: Response -> Value # toEncoding :: Response -> Encoding # toJSONList :: [Response] -> Value # toEncodingList :: [Response] -> Encoding #
ToValue Response Source #
Instance details Defined in GraphQL.Internal.Output Methods toValue :: Response -> Value' ConstScalar Source #

type Errors = NonEmpty Error Source #

data Error Source #

Constructors

Error Text [Location]

Instances

Eq Error Source #
Instance details Defined in GraphQL.Internal.Output Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Ord Error Source #
Instance details Defined in GraphQL.Internal.Output Methods compare :: Error -> Error -> Ordering # (<) :: Error -> Error -> Bool # (<=) :: Error -> Error -> Bool # (>) :: Error -> Error -> Bool # (>=) :: Error -> Error -> Bool # max :: Error -> Error -> Error # min :: Error -> Error -> Error #
Show Error Source #
Instance details Defined in GraphQL.Internal.Output Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
ToValue Error Source #
Instance details Defined in GraphQL.Internal.Output Methods toValue :: Error -> Value' ConstScalar Source #

class GraphQLError e where Source #

An error that arises while processing a GraphQL query.

Minimal complete definition

formatError

Methods

formatError :: e -> Text Source #

Represent an error as human-readable text, primarily intended for developers of GraphQL clients, and secondarily for developers of GraphQL servers.

toError :: e -> Error Source #

Represent an error as human-readable text, together with reference to a series of locations within a GraphQL query document. Default implementation calls formatError and provides no locations.

Instances

GraphQLError NameError Source #
Instance details Defined in GraphQL.Internal.Output Methods formatError :: NameError -> Text Source # toError :: NameError -> Error Source #
GraphQLError ValidationError Source #
Instance details Defined in GraphQL.Internal.Validation Methods formatError :: ValidationError -> Text Source # toError :: ValidationError -> Error Source #
GraphQLError SchemaError Source #
Instance details Defined in GraphQL.Internal.API Methods formatError :: SchemaError -> Text Source # toError :: SchemaError -> Error Source #
GraphQLError ResolverError Source #
Instance details Defined in GraphQL.Internal.Resolver Methods formatError :: ResolverError -> Text Source # toError :: ResolverError -> Error Source #
GraphQLError ExecutionError Source #
Instance details Defined in GraphQL.Internal.Execution Methods formatError :: ExecutionError -> Text Source # toError :: ExecutionError -> Error Source #
GraphQLError QueryError Source #
Instance details Defined in GraphQL Methods formatError :: QueryError -> Text Source # toError :: QueryError -> Error Source #

singleError :: GraphQLError e => e -> Errors Source #

Make a list of errors containing a single error.