Skip to main content

Steps

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

Usage​

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

import { Step } from '@shared/steps'

Exported Queries​

useStepsQuery​

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

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

getSteps​

Fetches a paginated list of steps from the public-api steps 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 getSteps(queryParams)

Exported Types​

TypeDescription
StepStep resource returned by our public apis
StepTypeThe type of the action scheduled by a step