@graasp/query-client

Graasp Query Client

React Query package to consume the Graasp API.

Installation

Run the following to install the package in your project:

yarn add github:graasp/graasp-query-client.git

The package exposes the following properties:

• DATA_KEYS: keys used to refer to invalidate data
• routines: message types used for notifications
• API_ROUTES: object containing all endpoint routes
• Api: api endpoints collection

configureQueryClient returns the following properties:

• queryClient: query client property
• QueryClientProvider: query client provider
• hooks: object containing all the useQuerys
• useMutation: hook for running mutations
• ReactQueryDevtools: devtools component for the imported queryclient
• dehydrate & Hydrate: necessary properties for SSR projects (ie: nextjs)

import { configureQueryClient } from '@graasp/query-client';

const prop = configureQueryClient({ API_HOST });

Development

Run yarn to install this package's dependencies

Testing

Execute the following to run the tests in your project

yarn test

or

yarn test:watch