Skip to main content

Person Stages

A shared package that contains queries and types for person stages.

Usage​

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

import { PersonStage } from '@shared/person-stages'

Exported Queries​

usePersonStagesQuery​

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

const { data, isLoading } = usePersonStagesQuery(queryParams)

getPersonStages​

Fetches a paginated list of person stages from the public-api person_stages 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 getPersonStages(queryParams)

Exported Types​

TypeDescription
PersonStagePersonStage resource returned by our public apis