Cadences

A shared package that exports queries, mutations, types, and utility functions for cadences.

Usage

The module has been imported into our root npm package. All you have to do is import it into your module.

import { Cadence } from '@shared/cadences'

Exported Queries

useCadencesQuery

Fetches a paginated list of cadences from the public-api cadences endpoint. You are able to pass an optional set of query params and optionally override the underlying UseQueryOptions.

  const {
    data,
    isLoading,
  } = useCadencesQuery(queryParams)

getCadences

Fetches a paginated list of cadences from the public-api cadences endpoint. You are able to pass an optional set of query params and optionally override the underlying UseQueryOptions.

This is only to be used outside of React. If you are in React please use the hook.

  const { data } = await getCadences(queryParams)

Exported Types

Type	Description
Cadence	Cadence resource returned by our public apis
CadenceFunction	The use cases for a cadence