Module

GraphQL.Client.BaseClients.Apollo

Package: purescript-graphql-client
Repository: OxfordAbstracts/purescript-graphql-client

Creates GraphQL Apollo clients

#ApolloClientOptions Source

type ApolloClientOptions = { authToken :: Maybe String, headers :: Array RequestHeader, url :: URL }

#ApolloSubClientOptions Source

type ApolloSubClientOptions = { authToken :: Maybe String, headers :: Array RequestHeader, url :: URL, websocketUrl :: URL }

#ApolloClient Source

data ApolloClient

Apollo client to make graphQL queries and mutations. From the @apollo/client npm module

Instances

#ApolloSubClient Source

data ApolloSubClient

Apollo client to make graphQL queries, mutations and subscriptions. Requires a web socket graphQL server. From the @apollo/client npm module

Instances

QueryClient ApolloSubClient { errorPolicy :: ErrorPolicy, fetchPolicy :: Maybe FetchPolicy } MutationOpts
SubscriptionClient ApolloSubClient QueryOpts
IsApollo ApolloSubClient
WatchQueryClient ApolloSubClient QueryOpts

#MutationOpts Source

type MutationOpts = { errorPolicy :: ErrorPolicy, optimisticResponse :: Maybe Json, refetchQueries :: Array String, update :: Maybe (Effect Unit) }

Instances

QueryClient ApolloClient QueryOpts MutationOpts
QueryClient ApolloSubClient { errorPolicy :: ErrorPolicy, fetchPolicy :: Maybe FetchPolicy } MutationOpts

#QueryOpts Source

type QueryOpts = { errorPolicy :: ErrorPolicy, fetchPolicy :: Maybe FetchPolicy }

Instances

#createClient Source

createClient :: forall schema. ApolloClientOptions -> Effect (Client ApolloClient schema)

#createSubscriptionClient Source

createSubscriptionClient :: forall schema. ApolloSubClientOptions -> Effect (Client ApolloSubClient schema)

#IsApollo Source

class IsApollo :: forall k. k -> Constraintclass IsApollo cl

Instances

#updateCacheJson Source

updateCacheJson :: forall s directives m q qSchema c res sr. IsApollo c => GqlQuery directives OpQuery qSchema q res => EncodeJson res => DecodeJson res => (Client c { directives :: Proxy directives, query :: qSchema | sr }) -> q -> (res -> res) -> Effect Unit

#updateCache Source

updateCache :: forall c directives qSchema q m s res sr. IsApollo c => GqlQuery directives OpQuery qSchema q res => (res -> Json) -> (Json -> Either JsonDecodeError res) -> (Client c { directives :: Proxy directives, query :: qSchema | sr }) -> q -> (res -> res) -> Effect Unit

#readQuery Source

readQuery :: forall c directives qSchema q m s res sr. IsApollo c => GqlQuery directives OpQuery qSchema q res => (Json -> Either JsonDecodeError res) -> (Client c { directives :: Proxy directives, query :: qSchema | sr }) -> q -> Effect (Maybe res)

read a query result from the cache

#writeQuery Source

writeQuery :: forall c directives qSchema q m s res sr. IsApollo c => GqlQuery directives OpQuery qSchema q res => (res -> Json) -> (Client c { directives :: Proxy directives, query :: qSchema | sr }) -> q -> res -> Effect Unit

write a query result to the cache

Modules: GraphQL.Client.Alias; GraphQL.Client.Alias.Dynamic; GraphQL.Client.Args; GraphQL.Client.Args.AllowedMismatch; GraphQL.Client.ArrayOf; GraphQL.Client.AsGql; GraphQL.Client.BaseClients.Affjax.Internal; GraphQL.Client.BaseClients.Affjax.Node; GraphQL.Client.BaseClients.Affjax.Web; GraphQL.Client.BaseClients.Apollo; GraphQL.Client.BaseClients.Apollo.ErrorPolicy; GraphQL.Client.BaseClients.Apollo.FetchPolicy; GraphQL.Client.BaseClients.Urql; GraphQL.Client.Directive; GraphQL.Client.Directive.Definition; GraphQL.Client.Directive.Location; GraphQL.Client.ErrorBoundary; GraphQL.Client.GqlError; GraphQL.Client.GqlType; GraphQL.Client.ID; GraphQL.Client.NullArray; GraphQL.Client.Operation; GraphQL.Client.Query; GraphQL.Client.QueryReturns; GraphQL.Client.SafeQueryName; GraphQL.Client.Subscription; GraphQL.Client.ToGqlString; GraphQL.Client.Types; GraphQL.Client.Union; GraphQL.Client.Variable; GraphQL.Client.Variables; GraphQL.Client.WatchQuery; GraphQL.Hasura.ComparisonExp; GraphQL.Hasura.Decode; GraphQL.Hasura.DecodeLiberal; GraphQL.Hasura.Encode