GraphQL.Client.BaseClients.Apollo

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

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

data ApolloClient

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

Instances

• QueryClient ApolloClient QueryOpts MutationOpts
• IsApollo ApolloClient
• WatchQueryClient ApolloClient QueryOpts

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

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

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

Instances

• QueryClient ApolloClient QueryOpts MutationOpts
• SubscriptionClient ApolloSubClient QueryOpts
• WatchQueryClient ApolloClient QueryOpts
• WatchQueryClient ApolloSubClient QueryOpts

createClient :: forall querySchema mutationSchema subscriptionSchema. ApolloClientOptions -> Effect (Client ApolloClient querySchema mutationSchema subscriptionSchema)

createSubscriptionClient :: forall querySchema mutationSchema subscriptionSchema. ApolloSubClientOptions -> Effect (Client ApolloSubClient querySchema mutationSchema subscriptionSchema)

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

Instances

• IsApollo ApolloClient
• IsApollo ApolloSubClient

updateCacheJson :: forall s m q qSchema c res. IsApollo c => GqlQuery qSchema q res => EncodeJson res => DecodeJson res => Client c qSchema m s -> q -> (res -> res) -> Effect Unit

updateCache :: forall c qSchema q m s res. IsApollo c => GqlQuery qSchema q res => (res -> Json) -> (Json -> Either JsonDecodeError res) -> (Client c qSchema m s) -> q -> (res -> res) -> Effect Unit

readQuery :: forall c qSchema q m s res. IsApollo c => GqlQuery qSchema q res => (Json -> Either JsonDecodeError res) -> (Client c qSchema m s) -> q -> Effect (Maybe res)

read a query result from the cache

writeQuery :: forall c qSchema q m s res. IsApollo c => GqlQuery qSchema q res => (res -> Json) -> (Client c qSchema m s) -> q -> res -> Effect Unit

write a query result to the cache