Documentation

Installation

Get started with Qortex

Install qortex using your preferred package manager and set up your project.

Choose Your Package

Install qortex-query OR qortex-query-react - not both! qortex-query-react includes all core APIs.

Install qortex using your preferred package manager. Choose the package that fits your needs:

For React Projects

If you're using React, install qortex-query-react (includes all core APIs):

For React Projects

# npm
npm install qortex-query-react
# yarn
yarn add qortex-query-react
# pnpm
pnpm add qortex-query-react

For Non-React Projects

If you're using vanilla JS, Vue, or other frameworks, install qortex-query:

For Non-React Projects

# npm
npm install qortex-query
# yarn
yarn add qortex-query
# pnpm
pnpm add qortex-query

Import Examples

How to import from each package:

Import Examples

// React users - everything from qortex-query-react
import { useQuery, useQueryData, registerFetcher, fetchQuery } from 'qortex-query-react';
// Core-only users - core APIs from qortex-query
import { registerFetcher, fetchQuery } from 'qortex-query';
// Persistence (separate package) - powered by qortex-db
import { createDB } from 'qortex-db';
import { createQueryPersister } from 'qortex-db/query';

Related Pages