Maintainer	Brandon Chinn <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Data.GraphQL.Monad

Contents

MonadGraphQLQuery API
GraphQLSettings
GraphQLManager
GraphQLQueryT

Description

Defines the MonadGraphQLQuery type class to query GraphQL APIs. Also provides the GraphQLQueryT monad transformer that can be added to a transformer stack to implement the type class, and the runQuerySafeIO function to manually implement it yourself.

Synopsis

class Monad m => MonadGraphQLQuery (m :: Type -> Type) where
- runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> m (GraphQLResult (Object schema))
runQuery :: forall m query (schema :: Schema). (MonadIO m, MonadGraphQLQuery m, GraphQLQuery query, schema ~ ResultSchema query) => query -> m (Object schema)
runQuerySafeIO :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => GraphQLManager -> query -> IO (GraphQLResult (Object schema))
data GraphQLSettings = GraphQLSettings {
- managerSettings :: ManagerSettings
- url :: String
- modifyReq :: Request -> Request
}
defaultGraphQLSettings :: GraphQLSettings
data GraphQLManager
initGraphQLManager :: GraphQLSettings -> IO GraphQLManager
data GraphQLQueryT (m :: Type -> Type) a
runGraphQLQueryT :: MonadIO m => GraphQLSettings -> GraphQLQueryT m a -> m a

MonadGraphQLQuery API

class Monad m => MonadGraphQLQuery (m :: Type -> Type) where Source #

A type class for monads that can run GraphQL queries.

Methods

runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> m (GraphQLResult (Object schema)) Source #

Run the given query and return the GraphQLResult.

Instances

Instances details

MonadIO m => MonadGraphQLQuery (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> GraphQLQueryT m (GraphQLResult (Object schema)) Source #
Monad m => MonadGraphQLQuery (MockQueryT m) Source #
Instance details Defined in Data.GraphQL.TestUtils Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> MockQueryT m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (MaybeT m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> MaybeT m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (ExceptT e m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> ExceptT e m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (IdentityT m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> IdentityT m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (ReaderT r m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> ReaderT r m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (StateT s m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> StateT s m (GraphQLResult (Object schema)) Source #
MonadGraphQLQuery m => MonadGraphQLQuery (StateT s m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> StateT s m (GraphQLResult (Object schema)) Source #
(Monoid w, MonadGraphQLQuery m) => MonadGraphQLQuery (WriterT w m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> WriterT w m (GraphQLResult (Object schema)) Source #
(Monoid w, MonadGraphQLQuery m) => MonadGraphQLQuery (WriterT w m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> WriterT w m (GraphQLResult (Object schema)) Source #
(Monoid w, MonadGraphQLQuery m) => MonadGraphQLQuery (RWST r w s m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> RWST r w s m (GraphQLResult (Object schema)) Source #
(Monoid w, MonadGraphQLQuery m) => MonadGraphQLQuery (RWST r w s m) Source #
Instance details Defined in Data.GraphQL.Monad.Class Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> RWST r w s m (GraphQLResult (Object schema)) Source #

runQuery :: forall m query (schema :: Schema). (MonadIO m, MonadGraphQLQuery m, GraphQLQuery query, schema ~ ResultSchema query) => query -> m (Object schema) Source #

Run the given query and returns the result, erroring if the query returned errors.

runQuerySafeIO :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => GraphQLManager -> query -> IO (GraphQLResult (Object schema)) Source #

Execute a GraphQL query with the given GraphQLManager.

GraphQLSettings

data GraphQLSettings Source #

The settings for initializing a GraphQLManager.

Constructors

GraphQLSettings
Fields managerSettings :: ManagerSettings Uses TLS by default url :: String modifyReq :: Request -> Request

defaultGraphQLSettings :: GraphQLSettings Source #

Default settings for GraphQLSettings. Requires url field to be overridden.

Example usage:

>>> defaultGraphQLSettings
...   { url = "https://api.github.com/graphql"
...   , modifyReq = \\req -> req
...       { requestHeaders =
...           (hAuthorization, "bearer my_github_token") : requestHeaders req
...       }
...   }

GraphQLManager

data GraphQLManager Source #

The manager for running GraphQL queries.

initGraphQLManager :: GraphQLSettings -> IO GraphQLManager Source #

GraphQLQueryT

data GraphQLQueryT (m :: Type -> Type) a Source #

The monad transformer type that can be used to run GraphQL queries.

 newtype MyMonad a = MyMonad { unMyMonad :: GraphQLQueryT IO a }

 runMyMonad :: MyMonad a -> IO a
 runMyMonad = runGraphQLQueryT graphQLSettings . unMyMonad
   where
     graphQLSettings = defaultGraphQLSettings{url = "https://api.github.com/graphql"}

Instances

Instances details

MonadTrans GraphQLQueryT Source #
Instance details Defined in Data.GraphQL.Monad Methods lift :: Monad m => m a -> GraphQLQueryT m a #
MonadIO m => MonadIO (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods liftIO :: IO a -> GraphQLQueryT m a #
Applicative m => Applicative (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods pure :: a -> GraphQLQueryT m a # (<>) :: GraphQLQueryT m (a -> b) -> GraphQLQueryT m a -> GraphQLQueryT m b # liftA2 :: (a -> b -> c) -> GraphQLQueryT m a -> GraphQLQueryT m b -> GraphQLQueryT m c # (>) :: GraphQLQueryT m a -> GraphQLQueryT m b -> GraphQLQueryT m b # (<*) :: GraphQLQueryT m a -> GraphQLQueryT m b -> GraphQLQueryT m a #
Functor m => Functor (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods fmap :: (a -> b) -> GraphQLQueryT m a -> GraphQLQueryT m b # (<$) :: a -> GraphQLQueryT m b -> GraphQLQueryT m a #
Monad m => Monad (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods (>>=) :: GraphQLQueryT m a -> (a -> GraphQLQueryT m b) -> GraphQLQueryT m b # (>>) :: GraphQLQueryT m a -> GraphQLQueryT m b -> GraphQLQueryT m b # return :: a -> GraphQLQueryT m a #
MonadIO m => MonadGraphQLQuery (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods runQuerySafe :: forall query (schema :: Schema). (GraphQLQuery query, schema ~ ResultSchema query) => query -> GraphQLQueryT m (GraphQLResult (Object schema)) Source #
MonadUnliftIO m => MonadUnliftIO (GraphQLQueryT m) Source #
Instance details Defined in Data.GraphQL.Monad Methods withRunInIO :: ((forall a. GraphQLQueryT m a -> IO a) -> IO b) -> GraphQLQueryT m b #

runGraphQLQueryT :: MonadIO m => GraphQLSettings -> GraphQLQueryT m a -> m a Source #

Run the GraphQLQueryT monad transformer.