Skip to main content

useInvitePatient

Sends an invitation for a patient using the shared typed invite payload.

When to use it​

Build the payload from the patient invitation flow and handle the returned invite response.

Setup​

Call it from a client-side React component below OvokProvider so it uses the client configured at that provider boundary.

Hook arguments​

The hook takes no configuration arguments. Call mutate(payload) when the user or workflow is ready to run the operation; the payload and result types are shown below.

TypeScript signature​

(): OvokMutationState<InviteBody, InviteSent>

Mutation state​

The operation runs only when you call mutate(payload). The payload type is InviteBody; the returned promise and data carry InviteSent.

FieldMeaning
dataLatest successful result, or undefined before success.
loadingWhether the mutation is running.
errorNormalized Error from the latest failure.
mutateStarts the operation, resolves with its result, and rejects on failure.
resetClears mutation data and error state.

Request behavior​

The mutation is explicit: collect and validate the input in your UI, disable repeated submission while loading is true, handle the rejected promise, and render error near the action.

Example​

Call the mutation from an event handler and show its error beside the action.

import { useInvitePatient } from '@ovok/core';

type Input = Parameters<ReturnType<typeof useInvitePatient>['mutate']>[0];

export function InvitePatientExample({ input }: { input: Input }) {
  const { mutate, loading, error } = useInvitePatient();
  async function submit() {
    try { await mutate(input); } catch { /* The hook exposes the error below. */ }
  }
  return <section>
    <button disabled={loading} onClick={() => void submit()}>Submit</button>
    {error && <p role="alert">{error.message}</p>}
  </section>;
}