Skip to content

v5: remove deprecated and dead exports #754

Description

@tyler-reitz

Background

reactfire ships several exports that are deprecated or dead but kept because removing them breaks consumers at load time, not just at compile time. v5 is the release that can drop them. Scope widened 2026-08-03 from the two checkOptions helpers to every deprecated export, so the breaking-removals work is tracked in one place.

To do in v5

Dead helpers (no internal call sites as of #740, which rewrote checkIdField to read options?.idField directly)

  • Remove checkOptions from src/index.ts
  • Remove checkinitialData from src/index.ts

Deprecated option

Deprecated components (both marked @deprecated Use useSigninCheck instead, both only functional in experimental Suspense mode and warning at runtime otherwise)

  • Remove ClaimsCheck (src/auth.tsx:215)
  • Remove AuthCheck (src/auth.tsx:259)

Then

  • Regenerate reference docs (npm run docs:fork) to drop the corresponding pages
  • Record each removal in the v5 upgrade guide with its replacement (initialData for startWithValue, useSigninCheck for both components)

Notes

Context: #740, #741.

Metadata

Metadata

Assignees

No one assigned

    Labels

    v5Planned for v5

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions