Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/pglite-react/src/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ function useLiveQueryImpl<T = { [key: string]: unknown }>(

/* eslint-disable @eslint-react/hooks-extra/no-direct-set-state-in-use-effect */
useEffect(() => {
if (!db) return // no PGliteProvider mounted � skip subscription
let cancelled = false
const cb = (results: LiveQueryResults<T>) => {
if (cancelled) return
Expand Down
11 changes: 4 additions & 7 deletions packages/pglite-react/src/provider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ interface Props<T extends PGliteWithLive> {
type PGliteProvider<T extends PGliteWithLive> = (
props: Props<T>,
) => React.JSX.Element
type UsePGlite<T extends PGliteWithLive> = (db?: T) => T
type UsePGlite<T extends PGliteWithLive> = (db?: T) => T | null

interface PGliteProviderSet<T extends PGliteWithLive> {
PGliteProvider: PGliteProvider<T>
Expand All @@ -28,12 +28,9 @@ function makePGliteProvider<T extends PGliteWithLive>(): PGliteProviderSet<T> {
// allow providing a db explicitly
if (db !== undefined) return db

if (!dbProvided)
throw new Error(
'No PGlite instance found, use PGliteProvider to provide one',
)

return dbProvided
// Return null instead of throwing when no provider is mounted.
// Callers can guard with `if (!db) return` for lazy / conditional rendering.
return dbProvided ?? null
}) as UsePGlite<T>,
PGliteProvider: ({ children, db }: Props<T>) => {
return <ctx.Provider value={db}>{children}</ctx.Provider>
Expand Down
17 changes: 17 additions & 0 deletions packages/pglite-react/test/provider.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,20 @@ describe('provider', () => {
await waitFor(() => expect(result.current).toBe(db))
})
})

describe('usePGlite outside provider', () => {
it('returns null when no PGliteProvider is mounted', () => {
const { result } = renderHook(() => usePGlite())
expect(result.current).toBeNull()
})

it('does not throw when no PGliteProvider is mounted', () => {
expect(() => renderHook(() => usePGlite())).not.toThrow()
})

it('returns the db when provided directly as argument', async () => {
const db = await PGlite.create({ extensions: { live } })
const { result } = renderHook(() => usePGlite(db as PGliteWithLive))
expect(result.current).toBe(db)
})
})