Document usage of the json flag

This commit is contained in:
2022-06-30 11:10:46 +02:00
parent 0d25f482dd
commit 0dac9701bc
5 changed files with 39 additions and 7 deletions

View File

@ -103,8 +103,8 @@ instance Exception ResolverException
-- | Runs the given query computation, but collects the errors into an error
-- list, which is then sent back with the data.
--
-- /runCollectErrs was part of the old executor and isn't used anymore, it will
-- be deprecated in the future and removed./
-- {-# DEPRECATED runCollectErrs was part of the old executor and isn't used
-- anymore #-}
runCollectErrs :: (Monad m, Serialize a)
=> HashMap Name (Schema.Type m)
-> CollectErrsT m a
@ -116,8 +116,8 @@ runCollectErrs types' res = do
-- | Executor context.
--
-- /Resolution was part of the old executor and isn't used anymore, it will be
-- deprecated in the future and removed./
-- {-# DEPRECATED Resolution was part of the old executor and isn't used
-- anymore #-}
data Resolution m = Resolution
{ errors :: Seq Error
, types :: HashMap Name (Schema.Type m)
@ -125,6 +125,6 @@ data Resolution m = Resolution
-- | A wrapper to pass error messages around.
--
-- /CollectErrsT was part of the old executor and isn't used anymore, it will be
-- deprecated in the future and removed./
-- {-# DEPRECATED CollectErrsT was part of the old executor and isn't used
-- anymore #-}
type CollectErrsT m = StateT (Resolution m) m

View File

@ -8,6 +8,11 @@
{-# LANGUAGE CPP #-}
-- | Types and functions used for input and result coercion.
--
-- JSON instances in this module are only available with the __json__
-- flag that is currently on by default, but will be disabled in the future.
-- Refer to the documentation in the 'Language.GraphQL' module and to
-- the __graphql-spice__ package.
module Language.GraphQL.Execute.Coerce
( Output(..)
, Serialize(..)