Jotai Apollo 🚀👻

Minimal @apollo/client integration for jotai, similar to jotai/urql.
Install
You have to install @apollo/client and jotai to access this bundle and its functions.
yarn add jotai-apollo jotai @apollo/client
atomsWithQuery
atomsWithQuery creates two atoms with a query. It internally uses client.watchQuery.
import { useAtom } from 'jotai'
import { ApolloClient, gql } from '@apollo/client'
import { atomsWithQuery } from 'jotai-apollo'
const client = new ApolloClient({ ... })
const query = gql`
query Count {
getCount {
count
}
}
`
const [countAtom, countStatusAtom] = atomsWithQuery(
(get) => ({
query
}),
() => client, // optional
)
const App =
type:
export const atomsWithQuery = <
Data,
Variables extends object = OperationVariables
>(
getArgs: (get: Getter) => QueryArgs<Variables, Data>,
getClient: (get: Getter) => ApolloClient<any> = (get) => get(clientAtom)
): readonly [
dataAtom: WritableAtom<Data, AtomWithQueryAction>,
statusAtom: WritableAtom<ApolloQueryResult<Data>, AtomWithQueryAction>
]
Examples
Rick & Morty characters
atomsWithMutation
atomsWithMutation creates two atoms with a mutation. It internally uses client.mutate.
import { useAtom } from 'jotai'
import { ApolloClient, gql } from '@apollo/client'
import { atomsWithMutation } from 'jotai-apollo'
const client = new ApolloClient({ ... })
const mutation = gql`
mutation Count {
setCount {
count
}
}
`
const [countAtom, countStatusAtom] = atomsWithMutation(
(get) => ({
mutation
}),
() => client,
)
const App =
type:
export function atomsWithMutation<
Data = any,
Variables = OperationVariables,
Context = DefaultContext,
Extensions = Record<string, any>,
Result extends FetchResult<Data, Context, Extensions> = FetchResult<
Data,
Context,
Extensions
>
>(
getClient: (get: Getter) => ApolloClient<any> = (get) => get
Examples
Contributions are welcome.
atomsWithSubscription
atomsWithSubscription creates two atoms with a mutation. It internally uses client.subscribe.
import { useAtom } from 'jotai'
import { ApolloClient, gql } from '@apollo/client'
import { atomsWithSubscription } from 'jotai-apollo'
const client = new ApolloClient({ ... })
const subscription = gql`
subscription Count {
getCount {
count
}
}
`
const [countAtom, countStatusAtom] = atomsWithSubscription(
(get) => ({
query: subscription
}),
() => client
)
const App =
type:
export function atomsWithSubscription<
Data,
Variables extends object = OperationVariables
>(
getArgs: (get: Getter) => SubscriptionOptions<Variables, Data>,
getClient: (get: Getter) => ApolloClient<any> = (get) => get(clientAtom)
): readonly [
dataAtom: WritableAtom<Data, Action>,
statusAtom: WritableAtom<SubscriptionResult<Data,
Examples
Contributions are welcome.
Contributing
If you have found what you think is a bug/feature, please file an issue.
For questions around this integration, prefer starting a discussion.