From b113bc33796d179334acab467d1b76c6f5f73f2e Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Fri, 10 Jul 2026 12:22:23 -0700 Subject: [PATCH 01/13] fix: surface observable errors via status instead of re-throwing Removes the unconditional re-throw in useObservable that made status: 'error' unreachable. Errors are now returned in ObservableStatus so consumers can handle them locally via status checks. Users who want Error Boundary behavior can opt in by throwing the error themselves. Fixes #535, fixes #540 --- src/useObservable.ts | 9 +-------- test/useObservable.test.tsx | 12 ++++-------- 2 files changed, 5 insertions(+), 16 deletions(-) diff --git a/src/useObservable.ts b/src/useObservable.ts index fe05be5d..25eadcac 100644 --- a/src/useObservable.ts +++ b/src/useObservable.ts @@ -105,9 +105,8 @@ export function useObservable(observableId: string, source: Observa next: () => { onStoreChange(); }, - error: (e) => { + error: () => { onStoreChange(); - throw e; }, complete: () => { onStoreChange(); @@ -145,11 +144,5 @@ export function useObservable(observableId: string, source: Observa } as ObservableStatus; } - // throw an error if there is an error - // TODO(jhuleatt) this is the current, tested-for, behavior. But do we actually want it? - if (update.error) { - throw update.error; - } - return update; } diff --git a/test/useObservable.test.tsx b/test/useObservable.test.tsx index f16d327a..1483b6d7 100644 --- a/test/useObservable.test.tsx +++ b/test/useObservable.test.tsx @@ -170,18 +170,14 @@ describe('useObservable', () => { expect(result.current.data).toEqual(observableVal); }); - it('throws an error if there is an error on initial fetch', async () => { - // stop a nasty-looking console error - // https://github.com/facebook/react/issues/11098#issuecomment-523977830 - const spy = vi.spyOn(console, 'error'); - spy.mockImplementation(() => {}); - + it('surfaces errors via status instead of throwing', async () => { const error = new Error('I am an error'); const observable$ = throwError(error); - expect(() => renderHook(() => useObservable('test-error', observable$, { suspense: true }))).toThrow(error); + const { result } = renderHook(() => useObservable('test-error', observable$, { suspense: true })); - spy.mockRestore(); + await waitFor(() => expect(result.current.status).toEqual('error')); + expect(result.current.error).toEqual(error); }); it('provides the value, rather than initialData, when the observable is ready right away', () => { From 776c99347fa66df747dea80096024b82c609d4c9 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Fri, 10 Jul 2026 12:26:19 -0700 Subject: [PATCH 02/13] chore: bump version to 4.3.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ec5a2f00..01f7698c 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "4.2.3", + "version": "4.3.0", "license": "MIT", "type": "module", "main": "dist/index.umd.cjs", From 74aee917d5e9a271e214a75bb7699bcece8aa13d Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Fri, 10 Jul 2026 13:21:43 -0700 Subject: [PATCH 03/13] fix: only re-throw observable errors in suspense mode Preserves Error Boundary behavior for suspense mode while allowing non-suspense consumers to handle errors locally via status === 'error'. --- src/useObservable.ts | 6 ++++++ test/useObservable.test.tsx | 18 ++++++++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/useObservable.ts b/src/useObservable.ts index 25eadcac..91867f8f 100644 --- a/src/useObservable.ts +++ b/src/useObservable.ts @@ -144,5 +144,11 @@ export function useObservable(observableId: string, source: Observa } as ObservableStatus; } + // In suspense mode, throw errors so React Error Boundaries can catch them. + // In non-suspense mode, surface errors via status so consumers can handle them locally. + if (suspenseEnabled && update.error) { + throw update.error; + } + return update; } diff --git a/test/useObservable.test.tsx b/test/useObservable.test.tsx index 1483b6d7..20dcc9b0 100644 --- a/test/useObservable.test.tsx +++ b/test/useObservable.test.tsx @@ -170,11 +170,25 @@ describe('useObservable', () => { expect(result.current.data).toEqual(observableVal); }); - it('surfaces errors via status instead of throwing', async () => { + it('throws an error if there is an error on initial fetch', async () => { + // stop a nasty-looking console error + // https://github.com/facebook/react/issues/11098#issuecomment-523977830 + const spy = vi.spyOn(console, 'error'); + spy.mockImplementation(() => {}); + + const error = new Error('I am an error'); + const observable$ = throwError(error); + + expect(() => renderHook(() => useObservable('test-error', observable$, { suspense: true }))).toThrow(error); + + spy.mockRestore(); + }); + + it('surfaces errors via status in non-suspense mode', async () => { const error = new Error('I am an error'); const observable$ = throwError(error); - const { result } = renderHook(() => useObservable('test-error', observable$, { suspense: true })); + const { result } = renderHook(() => useObservable('test-error-non-suspense', observable$, { suspense: false })); await waitFor(() => expect(result.current.status).toEqual('error')); expect(result.current.error).toEqual(error); From 26cd552e29c0fe98d931b2d2d343fb0e2e7fb213 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Mon, 13 Jul 2026 14:22:34 -0700 Subject: [PATCH 04/13] chore: gitignore CLAUDE.local files --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index df34806e..b2ebc657 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +CLAUDE.local* .DS_Store npm-debug.log From c7d3d6a0149725a440023bb89782519582ea92bb Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Wed, 15 Jul 2026 12:31:09 -0700 Subject: [PATCH 05/13] fix: address Armando review feedback on observable error state PR - Fix ObservableStatusError.isComplete type from `true` to `boolean` (runtime is false when error fires before complete) - Add JSDoc to useObservable documenting the suspense/non-suspense error handling split - Move error test from Suspense Mode block to Non-Suspense Mode block - Add test for bare default mode (no suspense option) surfacing errors via status - Add test for late-error contract (stale data remains readable after error) - Update docs/use.md storage example to handle status === 'error' - Add v4.2 to v4.3 upgrade guide section --- docs/upgrade-guide.md | 24 +++++++++++++++++++ docs/use.md | 6 ++++- src/useObservable.ts | 13 +++++++++- test/useObservable.test.tsx | 48 ++++++++++++++++++++++++++++--------- 4 files changed, 78 insertions(+), 13 deletions(-) diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md index b5277dd9..d4f0b263 100644 --- a/docs/upgrade-guide.md +++ b/docs/upgrade-guide.md @@ -1,3 +1,27 @@ +# Upgrade from ReactFire v4.2 to v4.3 + +ReactFire v4.3.0 changes how errors are surfaced in non-suspense mode (the default). + +## Error handling behavior change + +Previously, errors from any reactfire hook were thrown unconditionally, making `status: 'error'` unreachable in practice. In v4.3.0, error handling depends on the mode: + +- **Non-suspense mode** (default, or `suspense: false`): errors are returned via `status: 'error'` so components can handle them locally. +- **Suspense mode** (`suspense: true`): errors are re-thrown so a React Error Boundary can catch them. No change from prior behavior. + +**If you rely on a React Error Boundary to catch Firebase errors in non-suspense mode**, you must add an explicit re-throw in your component: + +```tsx +const { status, error } = useStorageDownloadURL(ref); +if (status === 'error') throw error; // re-throw to reach your Error Boundary +``` + +**If you already check `status` before using `data`**, no change is needed. + +Note: once an observable errors there is no automatic retry. If you need retry behavior, unmount and remount the component. + +--- + # Upgrade from ReactFire v3 to v4 As announced in [Discussion 402](https://github.com/FirebaseExtended/reactfire/discussions/402), ReactFire v4 contains breaking changes. This guide details how to upgrade from v3 to v4. diff --git a/docs/use.md b/docs/use.md index 5686a368..404cc625 100644 --- a/docs/use.md +++ b/docs/use.md @@ -426,12 +426,16 @@ function CatImage() { const storage = useStorage(); const catRef = ref(storage, 'cats/newspaper'); - const { status, data: imageURL } = useStorageDownloadURL(catRef); + const { status, data: imageURL, error } = useStorageDownloadURL(catRef); if (status === 'loading') { return loading...; } + if (status === 'error') { + return Error: {error.message}; + } + return cat reading the newspaper; } ``` diff --git a/src/useObservable.ts b/src/useObservable.ts index 91867f8f..32af48b8 100644 --- a/src/useObservable.ts +++ b/src/useObservable.ts @@ -71,7 +71,7 @@ export interface ObservableStatusSuccess extends ObservableStatusBase { export interface ObservableStatusError extends ObservableStatusBase { status: 'error'; - isComplete: true; + isComplete: boolean; error: Error; } @@ -83,6 +83,17 @@ export interface ObservableStatusLoading extends ObservableStatusBase { export type ObservableStatus = ObservableStatusLoading | ObservableStatusError | ObservableStatusSuccess; +/** + * Subscribe to an Observable and return its current status. + * + * Error handling depends on the suspense mode: + * - Non-suspense mode (default): errors are returned as `{ status: 'error', error }` so the + * component can handle them locally without needing a React Error Boundary. + * - Suspense mode (`suspense: true`): errors are re-thrown so a React Error Boundary can catch them. + * + * If the observable emits a value and then errors, `data` retains the last emitted value and + * `status` changes to `'error'`. There is no automatic retry path once an error occurs. + */ export function useObservable(observableId: string, source: Observable, config: ReactFireOptions = {}): ObservableStatus { if (!observableId) { throw new Error('cannot call useObservable without an observableId'); diff --git a/test/useObservable.test.tsx b/test/useObservable.test.tsx index 20dcc9b0..3149efbd 100644 --- a/test/useObservable.test.tsx +++ b/test/useObservable.test.tsx @@ -124,10 +124,46 @@ describe('useObservable', () => { act(() => observable$.next('val')); expect(result.current.isComplete).toEqual(false); - + act(() => observable$.complete()); await waitFor(() => expect(result.current.isComplete).toEqual(true)); }); + + it('surfaces errors via status in non-suspense mode', async () => { + const error = new Error('I am an error'); + const observable$ = throwError(error); + + const { result } = renderHook(() => useObservable('test-error-non-suspense', observable$, { suspense: false })); + + await waitFor(() => expect(result.current.status).toEqual('error')); + expect(result.current.error).toEqual(error); + }); + + it('surfaces errors via status when no suspense option is provided', async () => { + const error = new Error('default mode error'); + const observable$ = throwError(error); + + const { result } = renderHook(() => useObservable('test-error-default-mode', observable$)); + + await waitFor(() => expect(result.current.status).toEqual('error')); + expect(result.current.error).toEqual(error); + }); + + it('retains last emitted data when observable errors after emitting', async () => { + const subject$ = new Subject(); + const error = new Error('late error'); + + const { result } = renderHook(() => useObservable('test-late-error', subject$, { suspense: false })); + + act(() => subject$.next('good value')); + await waitFor(() => expect(result.current.status).toEqual('success')); + expect(result.current.data).toEqual('good value'); + + act(() => subject$.error(error)); + await waitFor(() => expect(result.current.status).toEqual('error')); + expect(result.current.error).toEqual(error); + expect(result.current.data).toEqual('good value'); + }); }); describe('Suspense Mode', () => { @@ -184,16 +220,6 @@ describe('useObservable', () => { spy.mockRestore(); }); - it('surfaces errors via status in non-suspense mode', async () => { - const error = new Error('I am an error'); - const observable$ = throwError(error); - - const { result } = renderHook(() => useObservable('test-error-non-suspense', observable$, { suspense: false })); - - await waitFor(() => expect(result.current.status).toEqual('error')); - expect(result.current.error).toEqual(error); - }); - it('provides the value, rather than initialData, when the observable is ready right away', () => { const startVal = 'howdy'; const observableVal = "y'all"; From 13bfb96cc98fe04edf13baa2742a273c61cffdd8 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Wed, 15 Jul 2026 12:39:16 -0700 Subject: [PATCH 06/13] chore: regenerate reference docs --- docs/reference/classes/ReactFireError.md | 10 +++++----- docs/reference/functions/AuthCheck.md | 2 +- docs/reference/functions/ClaimsCheck.md | 2 +- docs/reference/functions/FirebaseAppProvider.md | 2 +- docs/reference/functions/StorageImage.md | 2 +- docs/reference/functions/SuspenseWithPerf.md | 2 +- docs/reference/functions/checkIdField.md | 2 +- docs/reference/functions/checkOptions.md | 2 +- docs/reference/functions/checkinitialData.md | 2 +- docs/reference/functions/preloadFirestoreDoc.md | 2 +- docs/reference/functions/preloadObservable.md | 2 +- docs/reference/functions/preloadUser.md | 2 +- docs/reference/functions/useAnalytics.md | 2 +- docs/reference/functions/useAppCheck.md | 2 +- docs/reference/functions/useAuth.md | 2 +- .../functions/useCallableFunctionResponse.md | 2 +- docs/reference/functions/useDatabase.md | 2 +- docs/reference/functions/useDatabaseList.md | 2 +- docs/reference/functions/useDatabaseListData.md | 2 +- docs/reference/functions/useDatabaseObject.md | 2 +- .../reference/functions/useDatabaseObjectData.md | 2 +- docs/reference/functions/useFirebaseApp.md | 2 +- docs/reference/functions/useFirestore.md | 2 +- .../functions/useFirestoreCollection.md | 2 +- .../functions/useFirestoreCollectionData.md | 2 +- docs/reference/functions/useFirestoreDoc.md | 2 +- docs/reference/functions/useFirestoreDocData.md | 2 +- .../functions/useFirestoreDocDataOnce.md | 2 +- docs/reference/functions/useFirestoreDocOnce.md | 2 +- docs/reference/functions/useFunctions.md | 2 +- docs/reference/functions/useIdTokenResult.md | 2 +- docs/reference/functions/useIsSuspenseEnabled.md | 2 +- docs/reference/functions/useObservable.md | 12 +++++++++++- docs/reference/functions/usePerformance.md | 2 +- docs/reference/functions/useRemoteConfig.md | 2 +- docs/reference/functions/useRemoteConfigAll.md | 2 +- .../functions/useRemoteConfigBoolean.md | 2 +- .../reference/functions/useRemoteConfigNumber.md | 2 +- .../reference/functions/useRemoteConfigString.md | 2 +- docs/reference/functions/useRemoteConfigValue.md | 2 +- docs/reference/functions/useSigninCheck.md | 2 +- docs/reference/functions/useStorage.md | 2 +- .../reference/functions/useStorageDownloadURL.md | 2 +- docs/reference/functions/useStorageTask.md | 2 +- .../useSuspenseEnabledFromConfigAndContext.md | 2 +- docs/reference/functions/useUser.md | 2 +- docs/reference/interfaces/AuthCheckProps.md | 8 ++++---- docs/reference/interfaces/ClaimCheckErrors.md | 2 +- docs/reference/interfaces/ClaimsCheckProps.md | 10 +++++----- docs/reference/interfaces/ClaimsValidator.md | 4 ++-- .../interfaces/FirebaseAppProviderProps.md | 10 +++++----- .../interfaces/ObservableStatusError.md | 16 ++++++++-------- .../interfaces/ObservableStatusLoading.md | 14 +++++++------- .../interfaces/ObservableStatusSuccess.md | 14 +++++++------- docs/reference/interfaces/ReactFireOptions.md | 10 +++++----- .../interfaces/SignInCheckOptionsBasic.md | 12 ++++++------ .../interfaces/SignInCheckOptionsClaimsObject.md | 14 +++++++------- .../SignInCheckOptionsClaimsValidator.md | 14 +++++++------- docs/reference/interfaces/SuspensePerfProps.md | 8 ++++---- docs/reference/type-aliases/ObservableStatus.md | 2 +- docs/reference/type-aliases/ReactFireGlobals.md | 8 ++++---- docs/reference/type-aliases/SigninCheckResult.md | 2 +- docs/reference/type-aliases/StorageImageProps.md | 10 +++++----- docs/reference/variables/AnalyticsProvider.md | 2 +- docs/reference/variables/AnalyticsSdkContext.md | 2 +- docs/reference/variables/AppCheckProvider.md | 2 +- docs/reference/variables/AppCheckSdkContext.md | 2 +- docs/reference/variables/AuthProvider.md | 2 +- docs/reference/variables/AuthSdkContext.md | 2 +- docs/reference/variables/DatabaseProvider.md | 2 +- docs/reference/variables/DatabaseSdkContext.md | 2 +- docs/reference/variables/FirestoreProvider.md | 2 +- docs/reference/variables/FirestoreSdkContext.md | 2 +- docs/reference/variables/FunctionsProvider.md | 2 +- docs/reference/variables/FunctionsSdkContext.md | 2 +- docs/reference/variables/PerformanceProvider.md | 2 +- .../reference/variables/PerformanceSdkContext.md | 2 +- docs/reference/variables/RemoteConfigProvider.md | 2 +- .../variables/RemoteConfigSdkContext.md | 2 +- docs/reference/variables/StorageProvider.md | 2 +- docs/reference/variables/StorageSdkContext.md | 2 +- docs/reference/variables/useInitAnalytics.md | 2 +- docs/reference/variables/useInitAppCheck.md | 2 +- docs/reference/variables/useInitAuth.md | 2 +- docs/reference/variables/useInitDatabase.md | 2 +- docs/reference/variables/useInitFirestore.md | 2 +- docs/reference/variables/useInitFunctions.md | 2 +- docs/reference/variables/useInitPerformance.md | 2 +- docs/reference/variables/useInitRemoteConfig.md | 2 +- docs/reference/variables/useInitStorage.md | 2 +- docs/reference/variables/version.md | 2 +- 91 files changed, 167 insertions(+), 157 deletions(-) diff --git a/docs/reference/classes/ReactFireError.md b/docs/reference/classes/ReactFireError.md index 591ddb68..6e35ee91 100644 --- a/docs/reference/classes/ReactFireError.md +++ b/docs/reference/classes/ReactFireError.md @@ -6,7 +6,7 @@ # Class: ReactFireError -Defined in: [src/index.ts:12](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L12) +Defined in: [src/index.ts:12](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L12) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/index.ts:12](https://github.com/FirebaseExtended/reactfire/blob > **new ReactFireError**(`code`, `message`, `customData?`): `ReactFireError` -Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) #### Parameters @@ -60,7 +60,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:24 > `readonly` **code**: `string` -Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) *** @@ -68,7 +68,7 @@ Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob > `optional` **customData?**: `Record`\<`string`, `unknown`\> -Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) *** @@ -88,7 +88,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075 > `readonly` **name**: `"ReactFireError"` = `'ReactFireError'` -Defined in: [src/index.ts:13](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L13) +Defined in: [src/index.ts:13](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L13) #### Overrides diff --git a/docs/reference/functions/AuthCheck.md b/docs/reference/functions/AuthCheck.md index 06738074..a2c73441 100644 --- a/docs/reference/functions/AuthCheck.md +++ b/docs/reference/functions/AuthCheck.md @@ -8,7 +8,7 @@ > **AuthCheck**(`__namedParameters`): `ReactElement` -Defined in: [src/auth.tsx:257](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L257) +Defined in: [src/auth.tsx:257](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L257) ## Parameters diff --git a/docs/reference/functions/ClaimsCheck.md b/docs/reference/functions/ClaimsCheck.md index 5138d974..230ed4bb 100644 --- a/docs/reference/functions/ClaimsCheck.md +++ b/docs/reference/functions/ClaimsCheck.md @@ -8,7 +8,7 @@ > **ClaimsCheck**(`__namedParameters`): `Element` -Defined in: [src/auth.tsx:213](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L213) +Defined in: [src/auth.tsx:213](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L213) ## Parameters diff --git a/docs/reference/functions/FirebaseAppProvider.md b/docs/reference/functions/FirebaseAppProvider.md index 6b851653..f64b20b0 100644 --- a/docs/reference/functions/FirebaseAppProvider.md +++ b/docs/reference/functions/FirebaseAppProvider.md @@ -8,7 +8,7 @@ > **FirebaseAppProvider**(`props`): `Element` -Defined in: [src/firebaseApp.tsx:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L26) +Defined in: [src/firebaseApp.tsx:26](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L26) ## Parameters diff --git a/docs/reference/functions/StorageImage.md b/docs/reference/functions/StorageImage.md index 24370e02..8ae20007 100644 --- a/docs/reference/functions/StorageImage.md +++ b/docs/reference/functions/StorageImage.md @@ -8,7 +8,7 @@ > **StorageImage**(`props`): `Element` -Defined in: [src/storage.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L78) +Defined in: [src/storage.tsx:78](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L78) ## Parameters diff --git a/docs/reference/functions/SuspenseWithPerf.md b/docs/reference/functions/SuspenseWithPerf.md index 6ab06a72..87d04f94 100644 --- a/docs/reference/functions/SuspenseWithPerf.md +++ b/docs/reference/functions/SuspenseWithPerf.md @@ -8,7 +8,7 @@ > **SuspenseWithPerf**(`__namedParameters`): `ReactElement` -Defined in: [src/performance.tsx:9](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L9) +Defined in: [src/performance.tsx:9](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L9) ## Parameters diff --git a/docs/reference/functions/checkIdField.md b/docs/reference/functions/checkIdField.md index 82d7c5a9..4cef06ff 100644 --- a/docs/reference/functions/checkIdField.md +++ b/docs/reference/functions/checkIdField.md @@ -8,7 +8,7 @@ > **checkIdField**(`options`): `any` -Defined in: [src/index.ts:47](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L47) +Defined in: [src/index.ts:47](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L47) ## Parameters diff --git a/docs/reference/functions/checkOptions.md b/docs/reference/functions/checkOptions.md index 4f4fdaf0..57294f80 100644 --- a/docs/reference/functions/checkOptions.md +++ b/docs/reference/functions/checkOptions.md @@ -8,7 +8,7 @@ > **checkOptions**(`options`, `field`): `any` -Defined in: [src/index.ts:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L34) +Defined in: [src/index.ts:34](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L34) ## Parameters diff --git a/docs/reference/functions/checkinitialData.md b/docs/reference/functions/checkinitialData.md index f2c78405..0abdebde 100644 --- a/docs/reference/functions/checkinitialData.md +++ b/docs/reference/functions/checkinitialData.md @@ -8,7 +8,7 @@ > **checkinitialData**(`options`): `any` -Defined in: [src/index.ts:43](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L43) +Defined in: [src/index.ts:43](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L43) ## Parameters diff --git a/docs/reference/functions/preloadFirestoreDoc.md b/docs/reference/functions/preloadFirestoreDoc.md index a9c7db3a..713f2f77 100644 --- a/docs/reference/functions/preloadFirestoreDoc.md +++ b/docs/reference/functions/preloadFirestoreDoc.md @@ -8,7 +8,7 @@ > **preloadFirestoreDoc**(`refProvider`): `Promise`\<`SuspenseSubject`\<`DocumentSnapshot`\<`DocumentData`, `DocumentData`\>\>\> -Defined in: [src/firestore.tsx:28](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L28) +Defined in: [src/firestore.tsx:28](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L28) Preload a subscription to a Firestore document reference. diff --git a/docs/reference/functions/preloadObservable.md b/docs/reference/functions/preloadObservable.md index 92aab4f9..2f08bde0 100644 --- a/docs/reference/functions/preloadObservable.md +++ b/docs/reference/functions/preloadObservable.md @@ -8,7 +8,7 @@ > **preloadObservable**\<`T`\>(`source`, `id`, `suspenseEnabled?`): `SuspenseSubject`\<`T`\> -Defined in: [src/useObservable.ts:20](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L20) +Defined in: [src/useObservable.ts:20](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L20) ## Type Parameters diff --git a/docs/reference/functions/preloadUser.md b/docs/reference/functions/preloadUser.md index 65e598af..8df97f52 100644 --- a/docs/reference/functions/preloadUser.md +++ b/docs/reference/functions/preloadUser.md @@ -8,7 +8,7 @@ > **preloadUser**(`authResolver`): `Promise`\<`User` \| `null` \| `undefined`\> -Defined in: [src/auth.tsx:11](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L11) +Defined in: [src/auth.tsx:11](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L11) ## Parameters diff --git a/docs/reference/functions/useAnalytics.md b/docs/reference/functions/useAnalytics.md index 1a8eb2eb..0f562daf 100644 --- a/docs/reference/functions/useAnalytics.md +++ b/docs/reference/functions/useAnalytics.md @@ -8,7 +8,7 @@ > **useAnalytics**(): `Analytics` -Defined in: [src/sdk.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L84) +Defined in: [src/sdk.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L84) ## Returns diff --git a/docs/reference/functions/useAppCheck.md b/docs/reference/functions/useAppCheck.md index 0a8f8e45..0bdedb1d 100644 --- a/docs/reference/functions/useAppCheck.md +++ b/docs/reference/functions/useAppCheck.md @@ -8,7 +8,7 @@ > **useAppCheck**(): `AppCheck` -Defined in: [src/sdk.tsx:82](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L82) +Defined in: [src/sdk.tsx:82](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L82) ## Returns diff --git a/docs/reference/functions/useAuth.md b/docs/reference/functions/useAuth.md index fd9a7056..46976021 100644 --- a/docs/reference/functions/useAuth.md +++ b/docs/reference/functions/useAuth.md @@ -8,7 +8,7 @@ > **useAuth**(): `Auth` -Defined in: [src/sdk.tsx:83](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L83) +Defined in: [src/sdk.tsx:83](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L83) ## Returns diff --git a/docs/reference/functions/useCallableFunctionResponse.md b/docs/reference/functions/useCallableFunctionResponse.md index 04d98135..56f7332d 100644 --- a/docs/reference/functions/useCallableFunctionResponse.md +++ b/docs/reference/functions/useCallableFunctionResponse.md @@ -8,7 +8,7 @@ > **useCallableFunctionResponse**\<`RequestData`, `ResponseData`\>(`functionName`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`ResponseData`\> -Defined in: [src/functions.tsx:13](https://github.com/FirebaseExtended/reactfire/blob/main/src/functions.tsx#L13) +Defined in: [src/functions.tsx:13](https://github.com/tyler-reitz/reactfire/blob/main/src/functions.tsx#L13) Calls a callable function. diff --git a/docs/reference/functions/useDatabase.md b/docs/reference/functions/useDatabase.md index 1efac90b..72fb7ad6 100644 --- a/docs/reference/functions/useDatabase.md +++ b/docs/reference/functions/useDatabase.md @@ -8,7 +8,7 @@ > **useDatabase**(): `Database` -Defined in: [src/sdk.tsx:85](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L85) +Defined in: [src/sdk.tsx:85](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L85) ## Returns diff --git a/docs/reference/functions/useDatabaseList.md b/docs/reference/functions/useDatabaseList.md index 80615cd5..c4b10c4f 100644 --- a/docs/reference/functions/useDatabaseList.md +++ b/docs/reference/functions/useDatabaseList.md @@ -8,7 +8,7 @@ > **useDatabaseList**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[] \| `QueryChange`[]\> -Defined in: [src/database.tsx:48](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L48) +Defined in: [src/database.tsx:48](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L48) Subscribe to a Realtime Database list diff --git a/docs/reference/functions/useDatabaseListData.md b/docs/reference/functions/useDatabaseListData.md index 991381f3..5ee4f668 100644 --- a/docs/reference/functions/useDatabaseListData.md +++ b/docs/reference/functions/useDatabaseListData.md @@ -8,7 +8,7 @@ > **useDatabaseListData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[] \| `null`\> -Defined in: [src/database.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L58) +Defined in: [src/database.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L58) ## Type Parameters diff --git a/docs/reference/functions/useDatabaseObject.md b/docs/reference/functions/useDatabaseObject.md index 9ff176ff..fa0ab424 100644 --- a/docs/reference/functions/useDatabaseObject.md +++ b/docs/reference/functions/useDatabaseObject.md @@ -8,7 +8,7 @@ > **useDatabaseObject**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `QueryChange`\> -Defined in: [src/database.tsx:27](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L27) +Defined in: [src/database.tsx:27](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L27) Subscribe to a Realtime Database object diff --git a/docs/reference/functions/useDatabaseObjectData.md b/docs/reference/functions/useDatabaseObjectData.md index 34fec029..46dacedf 100644 --- a/docs/reference/functions/useDatabaseObjectData.md +++ b/docs/reference/functions/useDatabaseObjectData.md @@ -8,7 +8,7 @@ > **useDatabaseObjectData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`\> -Defined in: [src/database.tsx:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L34) +Defined in: [src/database.tsx:34](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L34) ## Type Parameters diff --git a/docs/reference/functions/useFirebaseApp.md b/docs/reference/functions/useFirebaseApp.md index d7f1d7cc..c7e3e431 100644 --- a/docs/reference/functions/useFirebaseApp.md +++ b/docs/reference/functions/useFirebaseApp.md @@ -8,7 +8,7 @@ > **useFirebaseApp**(): `FirebaseApp` -Defined in: [src/firebaseApp.tsx:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L80) +Defined in: [src/firebaseApp.tsx:80](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L80) ## Returns diff --git a/docs/reference/functions/useFirestore.md b/docs/reference/functions/useFirestore.md index 648d679b..609a8944 100644 --- a/docs/reference/functions/useFirestore.md +++ b/docs/reference/functions/useFirestore.md @@ -8,7 +8,7 @@ > **useFirestore**(): `Firestore` -Defined in: [src/sdk.tsx:86](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L86) +Defined in: [src/sdk.tsx:86](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L86) ## Returns diff --git a/docs/reference/functions/useFirestoreCollection.md b/docs/reference/functions/useFirestoreCollection.md index a67b5de4..4444a5bf 100644 --- a/docs/reference/functions/useFirestoreCollection.md +++ b/docs/reference/functions/useFirestoreCollection.md @@ -8,7 +8,7 @@ > **useFirestoreCollection**\<`T`\>(`query`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`QuerySnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:86](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L86) +Defined in: [src/firestore.tsx:86](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L86) Subscribe to a Firestore collection diff --git a/docs/reference/functions/useFirestoreCollectionData.md b/docs/reference/functions/useFirestoreCollectionData.md index 09f70b29..33773aa0 100644 --- a/docs/reference/functions/useFirestoreCollectionData.md +++ b/docs/reference/functions/useFirestoreCollectionData.md @@ -8,7 +8,7 @@ > **useFirestoreCollectionData**\<`T`\>(`query`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[]\> -Defined in: [src/firestore.tsx:96](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L96) +Defined in: [src/firestore.tsx:96](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L96) Subscribe to a Firestore collection and unwrap the snapshot into an array. diff --git a/docs/reference/functions/useFirestoreDoc.md b/docs/reference/functions/useFirestoreDoc.md index 00add301..215c0db4 100644 --- a/docs/reference/functions/useFirestoreDoc.md +++ b/docs/reference/functions/useFirestoreDoc.md @@ -8,7 +8,7 @@ > **useFirestoreDoc**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`DocumentSnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:42](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L42) +Defined in: [src/firestore.tsx:42](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L42) Subscribe to Firestore Document changes diff --git a/docs/reference/functions/useFirestoreDocData.md b/docs/reference/functions/useFirestoreDocData.md index 1267c3da..f6696f15 100644 --- a/docs/reference/functions/useFirestoreDocData.md +++ b/docs/reference/functions/useFirestoreDocData.md @@ -8,7 +8,7 @@ > **useFirestoreDocData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `undefined`\> -Defined in: [src/firestore.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L62) +Defined in: [src/firestore.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L62) Subscribe to Firestore Document changes and unwrap the document into a plain object diff --git a/docs/reference/functions/useFirestoreDocDataOnce.md b/docs/reference/functions/useFirestoreDocDataOnce.md index db47124e..4a46f418 100644 --- a/docs/reference/functions/useFirestoreDocDataOnce.md +++ b/docs/reference/functions/useFirestoreDocDataOnce.md @@ -8,7 +8,7 @@ > **useFirestoreDocDataOnce**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `undefined`\> -Defined in: [src/firestore.tsx:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L74) +Defined in: [src/firestore.tsx:74](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L74) Get a Firestore document, unwrap the document into a plain object, and don't subscribe to changes diff --git a/docs/reference/functions/useFirestoreDocOnce.md b/docs/reference/functions/useFirestoreDocOnce.md index bbe224d7..47fc208e 100644 --- a/docs/reference/functions/useFirestoreDocOnce.md +++ b/docs/reference/functions/useFirestoreDocOnce.md @@ -8,7 +8,7 @@ > **useFirestoreDocOnce**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`DocumentSnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:52](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L52) +Defined in: [src/firestore.tsx:52](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L52) Get a firestore document and don't subscribe to changes diff --git a/docs/reference/functions/useFunctions.md b/docs/reference/functions/useFunctions.md index bd5a2ade..41aea275 100644 --- a/docs/reference/functions/useFunctions.md +++ b/docs/reference/functions/useFunctions.md @@ -8,7 +8,7 @@ > **useFunctions**(): `Functions` -Defined in: [src/sdk.tsx:87](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L87) +Defined in: [src/sdk.tsx:87](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L87) ## Returns diff --git a/docs/reference/functions/useIdTokenResult.md b/docs/reference/functions/useIdTokenResult.md index a8e573dd..d6efc428 100644 --- a/docs/reference/functions/useIdTokenResult.md +++ b/docs/reference/functions/useIdTokenResult.md @@ -8,7 +8,7 @@ > **useIdTokenResult**(`user`, `forceRefresh?`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`IdTokenResult`\> -Defined in: [src/auth.tsx:41](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L41) +Defined in: [src/auth.tsx:41](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L41) ## Parameters diff --git a/docs/reference/functions/useIsSuspenseEnabled.md b/docs/reference/functions/useIsSuspenseEnabled.md index b068fabe..7b72213d 100644 --- a/docs/reference/functions/useIsSuspenseEnabled.md +++ b/docs/reference/functions/useIsSuspenseEnabled.md @@ -8,7 +8,7 @@ > **useIsSuspenseEnabled**(): `boolean` -Defined in: [src/firebaseApp.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L62) +Defined in: [src/firebaseApp.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L62) ## Returns diff --git a/docs/reference/functions/useObservable.md b/docs/reference/functions/useObservable.md index e0e6db0c..169d30c0 100644 --- a/docs/reference/functions/useObservable.md +++ b/docs/reference/functions/useObservable.md @@ -8,7 +8,17 @@ > **useObservable**\<`T`\>(`observableId`, `source`, `config?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`\> -Defined in: [src/useObservable.ts:86](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L86) +Defined in: [src/useObservable.ts:97](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L97) + +Subscribe to an Observable and return its current status. + +Error handling depends on the suspense mode: +- Non-suspense mode (default): errors are returned as `{ status: 'error', error }` so the + component can handle them locally without needing a React Error Boundary. +- Suspense mode (`suspense: true`): errors are re-thrown so a React Error Boundary can catch them. + +If the observable emits a value and then errors, `data` retains the last emitted value and +`status` changes to `'error'`. There is no automatic retry path once an error occurs. ## Type Parameters diff --git a/docs/reference/functions/usePerformance.md b/docs/reference/functions/usePerformance.md index 0ff1b523..ad8b1a08 100644 --- a/docs/reference/functions/usePerformance.md +++ b/docs/reference/functions/usePerformance.md @@ -8,7 +8,7 @@ > **usePerformance**(): `FirebasePerformance` -Defined in: [src/sdk.tsx:88](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L88) +Defined in: [src/sdk.tsx:88](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L88) ## Returns diff --git a/docs/reference/functions/useRemoteConfig.md b/docs/reference/functions/useRemoteConfig.md index 78b14879..b06ecf96 100644 --- a/docs/reference/functions/useRemoteConfig.md +++ b/docs/reference/functions/useRemoteConfig.md @@ -8,7 +8,7 @@ > **useRemoteConfig**(): `RemoteConfig` -Defined in: [src/sdk.tsx:90](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L90) +Defined in: [src/sdk.tsx:90](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L90) ## Returns diff --git a/docs/reference/functions/useRemoteConfigAll.md b/docs/reference/functions/useRemoteConfigAll.md index 52553698..53d9038d 100644 --- a/docs/reference/functions/useRemoteConfigAll.md +++ b/docs/reference/functions/useRemoteConfigAll.md @@ -8,7 +8,7 @@ > **useRemoteConfigAll**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`AllParameters`\> -Defined in: [src/remote-config.tsx:66](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L66) +Defined in: [src/remote-config.tsx:66](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L66) Convience method similar to useRemoteConfigValue. Returns allRemote Config parameters. diff --git a/docs/reference/functions/useRemoteConfigBoolean.md b/docs/reference/functions/useRemoteConfigBoolean.md index 14c2e3c4..0d80ede8 100644 --- a/docs/reference/functions/useRemoteConfigBoolean.md +++ b/docs/reference/functions/useRemoteConfigBoolean.md @@ -8,7 +8,7 @@ > **useRemoteConfigBoolean**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`boolean`\> -Defined in: [src/remote-config.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L58) +Defined in: [src/remote-config.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L58) Convience method similar to useRemoteConfigValue. Returns a `boolean` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigNumber.md b/docs/reference/functions/useRemoteConfigNumber.md index 337d8d66..cbc00fcd 100644 --- a/docs/reference/functions/useRemoteConfigNumber.md +++ b/docs/reference/functions/useRemoteConfigNumber.md @@ -8,7 +8,7 @@ > **useRemoteConfigNumber**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`number`\> -Defined in: [src/remote-config.tsx:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L50) +Defined in: [src/remote-config.tsx:50](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L50) Convience method similar to useRemoteConfigValue. Returns a `number` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigString.md b/docs/reference/functions/useRemoteConfigString.md index 65e01bca..0a7c80f3 100644 --- a/docs/reference/functions/useRemoteConfigString.md +++ b/docs/reference/functions/useRemoteConfigString.md @@ -8,7 +8,7 @@ > **useRemoteConfigString**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`string`\> -Defined in: [src/remote-config.tsx:42](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L42) +Defined in: [src/remote-config.tsx:42](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L42) Convience method similar to useRemoteConfigValue. Returns a `string` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigValue.md b/docs/reference/functions/useRemoteConfigValue.md index d598191f..2a422bae 100644 --- a/docs/reference/functions/useRemoteConfigValue.md +++ b/docs/reference/functions/useRemoteConfigValue.md @@ -8,7 +8,7 @@ > **useRemoteConfigValue**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`Value`\> -Defined in: [src/remote-config.tsx:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L34) +Defined in: [src/remote-config.tsx:34](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L34) Accepts a key and optionally a Remote Config instance. Returns a Remote Config Value. diff --git a/docs/reference/functions/useSigninCheck.md b/docs/reference/functions/useSigninCheck.md index 928d22e5..480baee5 100644 --- a/docs/reference/functions/useSigninCheck.md +++ b/docs/reference/functions/useSigninCheck.md @@ -8,7 +8,7 @@ > **useSigninCheck**(`options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<[`SigninCheckResult`](../type-aliases/SigninCheckResult.md)\> -Defined in: [src/auth.tsx:134](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L134) +Defined in: [src/auth.tsx:134](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L134) Subscribe to the signed-in status of a user. diff --git a/docs/reference/functions/useStorage.md b/docs/reference/functions/useStorage.md index 74d28fe2..fa5f4d2e 100644 --- a/docs/reference/functions/useStorage.md +++ b/docs/reference/functions/useStorage.md @@ -8,7 +8,7 @@ > **useStorage**(): `FirebaseStorage` -Defined in: [src/sdk.tsx:89](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L89) +Defined in: [src/sdk.tsx:89](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L89) ## Returns diff --git a/docs/reference/functions/useStorageDownloadURL.md b/docs/reference/functions/useStorageDownloadURL.md index 2ab6fb3d..2b4e8fd7 100644 --- a/docs/reference/functions/useStorageDownloadURL.md +++ b/docs/reference/functions/useStorageDownloadURL.md @@ -8,7 +8,7 @@ > **useStorageDownloadURL**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`string` \| `T`\> -Defined in: [src/storage.tsx:29](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L29) +Defined in: [src/storage.tsx:29](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L29) Subscribe to a storage ref's download URL diff --git a/docs/reference/functions/useStorageTask.md b/docs/reference/functions/useStorageTask.md index 2d462c71..8bc76230 100644 --- a/docs/reference/functions/useStorageTask.md +++ b/docs/reference/functions/useStorageTask.md @@ -8,7 +8,7 @@ > **useStorageTask**\<`T`\>(`task`, `ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `UploadTaskSnapshot`\> -Defined in: [src/storage.tsx:16](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L16) +Defined in: [src/storage.tsx:16](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L16) Subscribe to the progress of a storage task diff --git a/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md b/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md index 4781e595..c1d89629 100644 --- a/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md +++ b/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md @@ -8,7 +8,7 @@ > **useSuspenseEnabledFromConfigAndContext**(`suspenseFromConfig?`): `boolean` -Defined in: [src/firebaseApp.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L69) +Defined in: [src/firebaseApp.tsx:69](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L69) ## Parameters diff --git a/docs/reference/functions/useUser.md b/docs/reference/functions/useUser.md index da91d45b..d4536df2 100644 --- a/docs/reference/functions/useUser.md +++ b/docs/reference/functions/useUser.md @@ -8,7 +8,7 @@ > **useUser**\<`T`\>(`options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`User` \| `null`\> -Defined in: [src/auth.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L22) +Defined in: [src/auth.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L22) Subscribe to Firebase auth state changes, including token refresh diff --git a/docs/reference/interfaces/AuthCheckProps.md b/docs/reference/interfaces/AuthCheckProps.md index 37e7b895..26aa237e 100644 --- a/docs/reference/interfaces/AuthCheckProps.md +++ b/docs/reference/interfaces/AuthCheckProps.md @@ -6,7 +6,7 @@ # Interface: AuthCheckProps -Defined in: [src/auth.tsx:52](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L52) +Defined in: [src/auth.tsx:52](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L52) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/auth.tsx:52](https://github.com/FirebaseExtended/reactfire/blob > **children**: `ReactNode` -Defined in: [src/auth.tsx:54](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L54) +Defined in: [src/auth.tsx:54](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L54) *** @@ -22,7 +22,7 @@ Defined in: [src/auth.tsx:54](https://github.com/FirebaseExtended/reactfire/blob > **fallback**: `ReactNode` -Defined in: [src/auth.tsx:53](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L53) +Defined in: [src/auth.tsx:53](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L53) *** @@ -30,4 +30,4 @@ Defined in: [src/auth.tsx:53](https://github.com/FirebaseExtended/reactfire/blob > `optional` **requiredClaims?**: `Object` -Defined in: [src/auth.tsx:55](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L55) +Defined in: [src/auth.tsx:55](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L55) diff --git a/docs/reference/interfaces/ClaimCheckErrors.md b/docs/reference/interfaces/ClaimCheckErrors.md index 470ca5ab..53b598f6 100644 --- a/docs/reference/interfaces/ClaimCheckErrors.md +++ b/docs/reference/interfaces/ClaimCheckErrors.md @@ -6,7 +6,7 @@ # Interface: ClaimCheckErrors -Defined in: [src/auth.tsx:65](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L65) +Defined in: [src/auth.tsx:65](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L65) ## Indexable diff --git a/docs/reference/interfaces/ClaimsCheckProps.md b/docs/reference/interfaces/ClaimsCheckProps.md index 4d39e79b..ab7dc291 100644 --- a/docs/reference/interfaces/ClaimsCheckProps.md +++ b/docs/reference/interfaces/ClaimsCheckProps.md @@ -6,7 +6,7 @@ # Interface: ClaimsCheckProps -Defined in: [src/auth.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L58) +Defined in: [src/auth.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L58) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/auth.tsx:58](https://github.com/FirebaseExtended/reactfire/blob > **children**: `ReactNode` -Defined in: [src/auth.tsx:61](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L61) +Defined in: [src/auth.tsx:61](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L61) *** @@ -22,7 +22,7 @@ Defined in: [src/auth.tsx:61](https://github.com/FirebaseExtended/reactfire/blob > **fallback**: `ReactNode` -Defined in: [src/auth.tsx:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L60) +Defined in: [src/auth.tsx:60](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L60) *** @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:60](https://github.com/FirebaseExtended/reactfire/blob > **requiredClaims**: `object` -Defined in: [src/auth.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L62) +Defined in: [src/auth.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L62) #### Index Signature @@ -42,4 +42,4 @@ Defined in: [src/auth.tsx:62](https://github.com/FirebaseExtended/reactfire/blob > **user**: `User` -Defined in: [src/auth.tsx:59](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L59) +Defined in: [src/auth.tsx:59](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L59) diff --git a/docs/reference/interfaces/ClaimsValidator.md b/docs/reference/interfaces/ClaimsValidator.md index feb558fd..9f3991ba 100644 --- a/docs/reference/interfaces/ClaimsValidator.md +++ b/docs/reference/interfaces/ClaimsValidator.md @@ -6,11 +6,11 @@ # Interface: ClaimsValidator() -Defined in: [src/auth.tsx:91](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L91) +Defined in: [src/auth.tsx:91](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L91) > **ClaimsValidator**(`claims`): `object` -Defined in: [src/auth.tsx:92](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L92) +Defined in: [src/auth.tsx:92](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L92) ## Parameters diff --git a/docs/reference/interfaces/FirebaseAppProviderProps.md b/docs/reference/interfaces/FirebaseAppProviderProps.md index 80a7ff39..55a78242 100644 --- a/docs/reference/interfaces/FirebaseAppProviderProps.md +++ b/docs/reference/interfaces/FirebaseAppProviderProps.md @@ -6,7 +6,7 @@ # Interface: FirebaseAppProviderProps -Defined in: [src/firebaseApp.tsx:14](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L14) +Defined in: [src/firebaseApp.tsx:14](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L14) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/firebaseApp.tsx:14](https://github.com/FirebaseExtended/reactfi > `optional` **appName?**: `string` -Defined in: [src/firebaseApp.tsx:17](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L17) +Defined in: [src/firebaseApp.tsx:17](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L17) *** @@ -22,7 +22,7 @@ Defined in: [src/firebaseApp.tsx:17](https://github.com/FirebaseExtended/reactfi > `optional` **firebaseApp?**: `FirebaseApp` -Defined in: [src/firebaseApp.tsx:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L15) +Defined in: [src/firebaseApp.tsx:15](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L15) *** @@ -30,7 +30,7 @@ Defined in: [src/firebaseApp.tsx:15](https://github.com/FirebaseExtended/reactfi > `optional` **firebaseConfig?**: `FirebaseOptions` -Defined in: [src/firebaseApp.tsx:16](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L16) +Defined in: [src/firebaseApp.tsx:16](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L16) *** @@ -38,4 +38,4 @@ Defined in: [src/firebaseApp.tsx:16](https://github.com/FirebaseExtended/reactfi > `optional` **suspense?**: `boolean` -Defined in: [src/firebaseApp.tsx:18](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L18) +Defined in: [src/firebaseApp.tsx:18](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L18) diff --git a/docs/reference/interfaces/ObservableStatusError.md b/docs/reference/interfaces/ObservableStatusError.md index c6293b1d..bfeec51e 100644 --- a/docs/reference/interfaces/ObservableStatusError.md +++ b/docs/reference/interfaces/ObservableStatusError.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusError\ -Defined in: [src/useObservable.ts:72](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L72) +Defined in: [src/useObservable.ts:72](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L72) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:72](https://github.com/FirebaseExtended/reactf > **data**: `T` \| `undefined` -Defined in: [src/useObservable.ts:56](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L56) +Defined in: [src/useObservable.ts:56](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L56) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` -Defined in: [src/useObservable.ts:75](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L75) +Defined in: [src/useObservable.ts:75](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L75) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `boolean` -Defined in: [src/useObservable.ts:46](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L46) +Defined in: [src/useObservable.ts:46](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L46) Indicates whether the hook has emitted a value at some point @@ -82,9 +82,9 @@ If `initialData` is passed in, this will be `true`. ### isComplete -> **isComplete**: `true` +> **isComplete**: `boolean` -Defined in: [src/useObservable.ts:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L74) +Defined in: [src/useObservable.ts:74](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L74) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"error"` -Defined in: [src/useObservable.ts:73](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L73) +Defined in: [src/useObservable.ts:73](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L73) The loading status. diff --git a/docs/reference/interfaces/ObservableStatusLoading.md b/docs/reference/interfaces/ObservableStatusLoading.md index f0bf2fcd..1645827c 100644 --- a/docs/reference/interfaces/ObservableStatusLoading.md +++ b/docs/reference/interfaces/ObservableStatusLoading.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusLoading\ -Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L78) +Defined in: [src/useObservable.ts:78](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L78) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactf > **data**: `undefined` -Defined in: [src/useObservable.ts:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L80) +Defined in: [src/useObservable.ts:80](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L80) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` \| `undefined` -Defined in: [src/useObservable.ts:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L60) +Defined in: [src/useObservable.ts:60](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L60) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `false` -Defined in: [src/useObservable.ts:81](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L81) +Defined in: [src/useObservable.ts:81](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L81) Indicates whether the hook has emitted a value at some point @@ -84,7 +84,7 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L50) +Defined in: [src/useObservable.ts:50](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L50) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"loading"` -Defined in: [src/useObservable.ts:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L79) +Defined in: [src/useObservable.ts:79](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L79) The loading status. diff --git a/docs/reference/interfaces/ObservableStatusSuccess.md b/docs/reference/interfaces/ObservableStatusSuccess.md index 8a5a4445..ae4bdf31 100644 --- a/docs/reference/interfaces/ObservableStatusSuccess.md +++ b/docs/reference/interfaces/ObservableStatusSuccess.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusSuccess\ -Defined in: [src/useObservable.ts:67](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L67) +Defined in: [src/useObservable.ts:67](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L67) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:67](https://github.com/FirebaseExtended/reactf > **data**: `T` -Defined in: [src/useObservable.ts:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L69) +Defined in: [src/useObservable.ts:69](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L69) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` \| `undefined` -Defined in: [src/useObservable.ts:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L60) +Defined in: [src/useObservable.ts:60](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L60) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `boolean` -Defined in: [src/useObservable.ts:46](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L46) +Defined in: [src/useObservable.ts:46](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L46) Indicates whether the hook has emitted a value at some point @@ -84,7 +84,7 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L50) +Defined in: [src/useObservable.ts:50](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L50) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"success"` -Defined in: [src/useObservable.ts:68](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L68) +Defined in: [src/useObservable.ts:68](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L68) The loading status. diff --git a/docs/reference/interfaces/ReactFireOptions.md b/docs/reference/interfaces/ReactFireOptions.md index 7ca63c5e..6c319ad6 100644 --- a/docs/reference/interfaces/ReactFireOptions.md +++ b/docs/reference/interfaces/ReactFireOptions.md @@ -6,7 +6,7 @@ # Interface: ReactFireOptions\ -Defined in: [src/index.ts:24](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L24) +Defined in: [src/index.ts:24](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L24) ## Extended by @@ -24,7 +24,7 @@ Defined in: [src/index.ts:24](https://github.com/FirebaseExtended/reactfire/blob > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) *** @@ -32,7 +32,7 @@ Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) *** @@ -40,7 +40,7 @@ Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -52,4 +52,4 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) diff --git a/docs/reference/interfaces/SignInCheckOptionsBasic.md b/docs/reference/interfaces/SignInCheckOptionsBasic.md index 6c9f2d66..c460454a 100644 --- a/docs/reference/interfaces/SignInCheckOptionsBasic.md +++ b/docs/reference/interfaces/SignInCheckOptionsBasic.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsBasic -Defined in: [src/auth.tsx:83](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L83) +Defined in: [src/auth.tsx:83](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L83) ## Extends @@ -23,7 +23,7 @@ Defined in: [src/auth.tsx:83](https://github.com/FirebaseExtended/reactfire/blob > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) *** @@ -31,7 +31,7 @@ Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -43,7 +43,7 @@ Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -71,7 +71,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) #### Inherited from diff --git a/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md b/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md index 092cde82..fc0e364a 100644 --- a/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md +++ b/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsClaimsObject -Defined in: [src/auth.tsx:87](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L87) +Defined in: [src/auth.tsx:87](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L87) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/auth.tsx:87](https://github.com/FirebaseExtended/reactfire/blob > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) #### Inherited from @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob > **requiredClaims**: `ParsedToken` -Defined in: [src/auth.tsx:88](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L88) +Defined in: [src/auth.tsx:88](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L88) *** @@ -62,7 +62,7 @@ Defined in: [src/auth.tsx:88](https://github.com/FirebaseExtended/reactfire/blob > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -78,7 +78,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) #### Inherited from diff --git a/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md b/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md index 83517d7a..55ae514b 100644 --- a/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md +++ b/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsClaimsValidator -Defined in: [src/auth.tsx:98](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L98) +Defined in: [src/auth.tsx:98](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L98) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/auth.tsx:98](https://github.com/FirebaseExtended/reactfire/blob > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) #### Inherited from @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -70,7 +70,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) #### Inherited from @@ -82,4 +82,4 @@ Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob > **validateCustomClaims**: [`ClaimsValidator`](ClaimsValidator.md) -Defined in: [src/auth.tsx:99](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L99) +Defined in: [src/auth.tsx:99](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L99) diff --git a/docs/reference/interfaces/SuspensePerfProps.md b/docs/reference/interfaces/SuspensePerfProps.md index a2ab17da..fbfaa1aa 100644 --- a/docs/reference/interfaces/SuspensePerfProps.md +++ b/docs/reference/interfaces/SuspensePerfProps.md @@ -6,7 +6,7 @@ # Interface: SuspensePerfProps -Defined in: [src/performance.tsx:3](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L3) +Defined in: [src/performance.tsx:3](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L3) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/performance.tsx:3](https://github.com/FirebaseExtended/reactfir > **children**: `ReactNode` -Defined in: [src/performance.tsx:4](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L4) +Defined in: [src/performance.tsx:4](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L4) *** @@ -22,7 +22,7 @@ Defined in: [src/performance.tsx:4](https://github.com/FirebaseExtended/reactfir > **fallback**: `ReactNode` -Defined in: [src/performance.tsx:6](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L6) +Defined in: [src/performance.tsx:6](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L6) *** @@ -30,4 +30,4 @@ Defined in: [src/performance.tsx:6](https://github.com/FirebaseExtended/reactfir > **traceId**: `string` -Defined in: [src/performance.tsx:5](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L5) +Defined in: [src/performance.tsx:5](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L5) diff --git a/docs/reference/type-aliases/ObservableStatus.md b/docs/reference/type-aliases/ObservableStatus.md index bbf0276d..8587e411 100644 --- a/docs/reference/type-aliases/ObservableStatus.md +++ b/docs/reference/type-aliases/ObservableStatus.md @@ -8,7 +8,7 @@ > **ObservableStatus**\<`T`\> = [`ObservableStatusLoading`](../interfaces/ObservableStatusLoading.md)\<`T`\> \| [`ObservableStatusError`](../interfaces/ObservableStatusError.md)\<`T`\> \| [`ObservableStatusSuccess`](../interfaces/ObservableStatusSuccess.md)\<`T`\> -Defined in: [src/useObservable.ts:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L84) +Defined in: [src/useObservable.ts:84](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L84) ## Type Parameters diff --git a/docs/reference/type-aliases/ReactFireGlobals.md b/docs/reference/type-aliases/ReactFireGlobals.md index 995ef49a..d0adeb33 100644 --- a/docs/reference/type-aliases/ReactFireGlobals.md +++ b/docs/reference/type-aliases/ReactFireGlobals.md @@ -8,7 +8,7 @@ > **ReactFireGlobals** = `object` -Defined in: [src/index.ts:6](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L6) +Defined in: [src/index.ts:6](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [src/index.ts:6](https://github.com/FirebaseExtended/reactfire/blob/ > **\_reactFireDatabaseCachedQueries**: `DatabaseQuery`[] -Defined in: [src/index.ts:7](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L7) +Defined in: [src/index.ts:7](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L7) *** @@ -24,7 +24,7 @@ Defined in: [src/index.ts:7](https://github.com/FirebaseExtended/reactfire/blob/ > **\_reactFireFirestoreQueryCache**: `FirestoreQuery`[] -Defined in: [src/index.ts:8](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L8) +Defined in: [src/index.ts:8](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L8) *** @@ -32,4 +32,4 @@ Defined in: [src/index.ts:8](https://github.com/FirebaseExtended/reactfire/blob/ > **\_reactFirePreloadedObservables**: `Map`\<`string`, `SuspenseSubject`\<`any`\>\> -Defined in: [src/index.ts:9](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L9) +Defined in: [src/index.ts:9](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L9) diff --git a/docs/reference/type-aliases/SigninCheckResult.md b/docs/reference/type-aliases/SigninCheckResult.md index bb80be74..5e25682e 100644 --- a/docs/reference/type-aliases/SigninCheckResult.md +++ b/docs/reference/type-aliases/SigninCheckResult.md @@ -8,4 +8,4 @@ > **SigninCheckResult** = \{ `errors`: \{ \}; `hasRequiredClaims`: `false`; `signedIn`: `false`; `user`: `null`; \} \| \{ `errors`: [`ClaimCheckErrors`](../interfaces/ClaimCheckErrors.md); `hasRequiredClaims`: `boolean`; `signedIn`: `true`; `user`: `User`; \} -Defined in: [src/auth.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L69) +Defined in: [src/auth.tsx:69](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L69) diff --git a/docs/reference/type-aliases/StorageImageProps.md b/docs/reference/type-aliases/StorageImageProps.md index b75fa337..f79d625b 100644 --- a/docs/reference/type-aliases/StorageImageProps.md +++ b/docs/reference/type-aliases/StorageImageProps.md @@ -8,7 +8,7 @@ > **StorageImageProps** = `object` -Defined in: [src/storage.tsx:36](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L36) +Defined in: [src/storage.tsx:36](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L36) ## Properties @@ -16,7 +16,7 @@ Defined in: [src/storage.tsx:36](https://github.com/FirebaseExtended/reactfire/b > `optional` **placeHolder?**: `React.ReactNode` -Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L40) +Defined in: [src/storage.tsx:40](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L40) *** @@ -24,7 +24,7 @@ Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/b > `optional` **storage?**: `FirebaseStorage` -Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L38) +Defined in: [src/storage.tsx:38](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L38) *** @@ -32,7 +32,7 @@ Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/b > **storagePath**: `string` -Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L37) +Defined in: [src/storage.tsx:37](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L37) *** @@ -40,4 +40,4 @@ Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/b > `optional` **suspense?**: `boolean` -Defined in: [src/storage.tsx:39](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L39) +Defined in: [src/storage.tsx:39](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L39) diff --git a/docs/reference/variables/AnalyticsProvider.md b/docs/reference/variables/AnalyticsProvider.md index 67edf246..7e36d04c 100644 --- a/docs/reference/variables/AnalyticsProvider.md +++ b/docs/reference/variables/AnalyticsProvider.md @@ -8,7 +8,7 @@ > `const` **AnalyticsProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L74) +Defined in: [src/sdk.tsx:74](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L74) ## Parameters diff --git a/docs/reference/variables/AnalyticsSdkContext.md b/docs/reference/variables/AnalyticsSdkContext.md index 8d51b3f9..483209d3 100644 --- a/docs/reference/variables/AnalyticsSdkContext.md +++ b/docs/reference/variables/AnalyticsSdkContext.md @@ -8,4 +8,4 @@ > `const` **AnalyticsSdkContext**: `Context`\<`Analytics` \| `undefined`\> -Defined in: [src/sdk.tsx:20](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L20) +Defined in: [src/sdk.tsx:20](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L20) diff --git a/docs/reference/variables/AppCheckProvider.md b/docs/reference/variables/AppCheckProvider.md index ff42596a..f8d2e847 100644 --- a/docs/reference/variables/AppCheckProvider.md +++ b/docs/reference/variables/AppCheckProvider.md @@ -8,7 +8,7 @@ > `const` **AppCheckProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:72](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L72) +Defined in: [src/sdk.tsx:72](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L72) ## Parameters diff --git a/docs/reference/variables/AppCheckSdkContext.md b/docs/reference/variables/AppCheckSdkContext.md index 311519af..f016ac4c 100644 --- a/docs/reference/variables/AppCheckSdkContext.md +++ b/docs/reference/variables/AppCheckSdkContext.md @@ -8,4 +8,4 @@ > `const` **AppCheckSdkContext**: `Context`\<`AppCheck` \| `undefined`\> -Defined in: [src/sdk.tsx:18](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L18) +Defined in: [src/sdk.tsx:18](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L18) diff --git a/docs/reference/variables/AuthProvider.md b/docs/reference/variables/AuthProvider.md index 11ea5392..33889ce0 100644 --- a/docs/reference/variables/AuthProvider.md +++ b/docs/reference/variables/AuthProvider.md @@ -8,7 +8,7 @@ > `const` **AuthProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:73](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L73) +Defined in: [src/sdk.tsx:73](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L73) ## Parameters diff --git a/docs/reference/variables/AuthSdkContext.md b/docs/reference/variables/AuthSdkContext.md index 22b522cb..2ab5f3c8 100644 --- a/docs/reference/variables/AuthSdkContext.md +++ b/docs/reference/variables/AuthSdkContext.md @@ -8,4 +8,4 @@ > `const` **AuthSdkContext**: `Context`\<`Auth` \| `undefined`\> -Defined in: [src/sdk.tsx:19](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L19) +Defined in: [src/sdk.tsx:19](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L19) diff --git a/docs/reference/variables/DatabaseProvider.md b/docs/reference/variables/DatabaseProvider.md index e8069948..f9371493 100644 --- a/docs/reference/variables/DatabaseProvider.md +++ b/docs/reference/variables/DatabaseProvider.md @@ -8,7 +8,7 @@ > `const` **DatabaseProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:75](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L75) +Defined in: [src/sdk.tsx:75](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L75) ## Parameters diff --git a/docs/reference/variables/DatabaseSdkContext.md b/docs/reference/variables/DatabaseSdkContext.md index 09acae02..dcb795b2 100644 --- a/docs/reference/variables/DatabaseSdkContext.md +++ b/docs/reference/variables/DatabaseSdkContext.md @@ -8,4 +8,4 @@ > `const` **DatabaseSdkContext**: `Context`\<`Database` \| `undefined`\> -Defined in: [src/sdk.tsx:21](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L21) +Defined in: [src/sdk.tsx:21](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L21) diff --git a/docs/reference/variables/FirestoreProvider.md b/docs/reference/variables/FirestoreProvider.md index d689f31f..d465802f 100644 --- a/docs/reference/variables/FirestoreProvider.md +++ b/docs/reference/variables/FirestoreProvider.md @@ -8,7 +8,7 @@ > `const` **FirestoreProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:76](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L76) +Defined in: [src/sdk.tsx:76](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L76) ## Parameters diff --git a/docs/reference/variables/FirestoreSdkContext.md b/docs/reference/variables/FirestoreSdkContext.md index 0fcb9ea2..177e08ca 100644 --- a/docs/reference/variables/FirestoreSdkContext.md +++ b/docs/reference/variables/FirestoreSdkContext.md @@ -8,4 +8,4 @@ > `const` **FirestoreSdkContext**: `Context`\<`Firestore` \| `undefined`\> -Defined in: [src/sdk.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L22) +Defined in: [src/sdk.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L22) diff --git a/docs/reference/variables/FunctionsProvider.md b/docs/reference/variables/FunctionsProvider.md index 918b2609..392a159c 100644 --- a/docs/reference/variables/FunctionsProvider.md +++ b/docs/reference/variables/FunctionsProvider.md @@ -8,7 +8,7 @@ > `const` **FunctionsProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:77](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L77) +Defined in: [src/sdk.tsx:77](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L77) ## Parameters diff --git a/docs/reference/variables/FunctionsSdkContext.md b/docs/reference/variables/FunctionsSdkContext.md index fe59787f..d46d84e8 100644 --- a/docs/reference/variables/FunctionsSdkContext.md +++ b/docs/reference/variables/FunctionsSdkContext.md @@ -8,4 +8,4 @@ > `const` **FunctionsSdkContext**: `Context`\<`Functions` \| `undefined`\> -Defined in: [src/sdk.tsx:23](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L23) +Defined in: [src/sdk.tsx:23](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L23) diff --git a/docs/reference/variables/PerformanceProvider.md b/docs/reference/variables/PerformanceProvider.md index ee2fcc28..0f24ad2f 100644 --- a/docs/reference/variables/PerformanceProvider.md +++ b/docs/reference/variables/PerformanceProvider.md @@ -8,7 +8,7 @@ > `const` **PerformanceProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L78) +Defined in: [src/sdk.tsx:78](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L78) ## Parameters diff --git a/docs/reference/variables/PerformanceSdkContext.md b/docs/reference/variables/PerformanceSdkContext.md index cff32f29..2d266faf 100644 --- a/docs/reference/variables/PerformanceSdkContext.md +++ b/docs/reference/variables/PerformanceSdkContext.md @@ -8,4 +8,4 @@ > `const` **PerformanceSdkContext**: `Context`\<`FirebasePerformance` \| `undefined`\> -Defined in: [src/sdk.tsx:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L25) +Defined in: [src/sdk.tsx:25](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L25) diff --git a/docs/reference/variables/RemoteConfigProvider.md b/docs/reference/variables/RemoteConfigProvider.md index 8d3d3625..21e79a6e 100644 --- a/docs/reference/variables/RemoteConfigProvider.md +++ b/docs/reference/variables/RemoteConfigProvider.md @@ -8,7 +8,7 @@ > `const` **RemoteConfigProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L80) +Defined in: [src/sdk.tsx:80](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L80) ## Parameters diff --git a/docs/reference/variables/RemoteConfigSdkContext.md b/docs/reference/variables/RemoteConfigSdkContext.md index 00fbb0f7..e1d15288 100644 --- a/docs/reference/variables/RemoteConfigSdkContext.md +++ b/docs/reference/variables/RemoteConfigSdkContext.md @@ -8,4 +8,4 @@ > `const` **RemoteConfigSdkContext**: `Context`\<`RemoteConfig` \| `undefined`\> -Defined in: [src/sdk.tsx:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L26) +Defined in: [src/sdk.tsx:26](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L26) diff --git a/docs/reference/variables/StorageProvider.md b/docs/reference/variables/StorageProvider.md index dbcb81c1..04d3612c 100644 --- a/docs/reference/variables/StorageProvider.md +++ b/docs/reference/variables/StorageProvider.md @@ -8,7 +8,7 @@ > `const` **StorageProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L79) +Defined in: [src/sdk.tsx:79](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L79) ## Parameters diff --git a/docs/reference/variables/StorageSdkContext.md b/docs/reference/variables/StorageSdkContext.md index e921e113..14c6cc7e 100644 --- a/docs/reference/variables/StorageSdkContext.md +++ b/docs/reference/variables/StorageSdkContext.md @@ -8,4 +8,4 @@ > `const` **StorageSdkContext**: `Context`\<`FirebaseStorage` \| `undefined`\> -Defined in: [src/sdk.tsx:24](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L24) +Defined in: [src/sdk.tsx:24](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L24) diff --git a/docs/reference/variables/useInitAnalytics.md b/docs/reference/variables/useInitAnalytics.md index 80cddfb2..56162094 100644 --- a/docs/reference/variables/useInitAnalytics.md +++ b/docs/reference/variables/useInitAnalytics.md @@ -8,4 +8,4 @@ > `const` **useInitAnalytics**: `InitSdkHook`\<`Analytics`\> -Defined in: [src/sdk.tsx:99](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L99) +Defined in: [src/sdk.tsx:99](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L99) diff --git a/docs/reference/variables/useInitAppCheck.md b/docs/reference/variables/useInitAppCheck.md index 810fc3f0..7a350d58 100644 --- a/docs/reference/variables/useInitAppCheck.md +++ b/docs/reference/variables/useInitAppCheck.md @@ -8,4 +8,4 @@ > `const` **useInitAppCheck**: `InitSdkHook`\<`AppCheck`\> -Defined in: [src/sdk.tsx:97](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L97) +Defined in: [src/sdk.tsx:97](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L97) diff --git a/docs/reference/variables/useInitAuth.md b/docs/reference/variables/useInitAuth.md index bd29275b..2ffd8888 100644 --- a/docs/reference/variables/useInitAuth.md +++ b/docs/reference/variables/useInitAuth.md @@ -8,4 +8,4 @@ > `const` **useInitAuth**: `InitSdkHook`\<`Auth`\> -Defined in: [src/sdk.tsx:98](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L98) +Defined in: [src/sdk.tsx:98](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L98) diff --git a/docs/reference/variables/useInitDatabase.md b/docs/reference/variables/useInitDatabase.md index 4bb0de18..7876835b 100644 --- a/docs/reference/variables/useInitDatabase.md +++ b/docs/reference/variables/useInitDatabase.md @@ -8,4 +8,4 @@ > `const` **useInitDatabase**: `InitSdkHook`\<`Database`\> -Defined in: [src/sdk.tsx:100](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L100) +Defined in: [src/sdk.tsx:100](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L100) diff --git a/docs/reference/variables/useInitFirestore.md b/docs/reference/variables/useInitFirestore.md index 5ef24c7e..99025829 100644 --- a/docs/reference/variables/useInitFirestore.md +++ b/docs/reference/variables/useInitFirestore.md @@ -8,4 +8,4 @@ > `const` **useInitFirestore**: `InitSdkHook`\<`Firestore`\> -Defined in: [src/sdk.tsx:101](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L101) +Defined in: [src/sdk.tsx:101](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L101) diff --git a/docs/reference/variables/useInitFunctions.md b/docs/reference/variables/useInitFunctions.md index 63c7eed4..4e6e085f 100644 --- a/docs/reference/variables/useInitFunctions.md +++ b/docs/reference/variables/useInitFunctions.md @@ -8,4 +8,4 @@ > `const` **useInitFunctions**: `InitSdkHook`\<`Functions`\> -Defined in: [src/sdk.tsx:102](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L102) +Defined in: [src/sdk.tsx:102](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L102) diff --git a/docs/reference/variables/useInitPerformance.md b/docs/reference/variables/useInitPerformance.md index 150cdfdd..9f804a55 100644 --- a/docs/reference/variables/useInitPerformance.md +++ b/docs/reference/variables/useInitPerformance.md @@ -8,4 +8,4 @@ > `const` **useInitPerformance**: `InitSdkHook`\<`FirebasePerformance`\> -Defined in: [src/sdk.tsx:103](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L103) +Defined in: [src/sdk.tsx:103](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L103) diff --git a/docs/reference/variables/useInitRemoteConfig.md b/docs/reference/variables/useInitRemoteConfig.md index f9871886..8f8e89b3 100644 --- a/docs/reference/variables/useInitRemoteConfig.md +++ b/docs/reference/variables/useInitRemoteConfig.md @@ -8,4 +8,4 @@ > `const` **useInitRemoteConfig**: `InitSdkHook`\<`RemoteConfig`\> -Defined in: [src/sdk.tsx:105](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L105) +Defined in: [src/sdk.tsx:105](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L105) diff --git a/docs/reference/variables/useInitStorage.md b/docs/reference/variables/useInitStorage.md index a38823da..bd4c75b1 100644 --- a/docs/reference/variables/useInitStorage.md +++ b/docs/reference/variables/useInitStorage.md @@ -8,4 +8,4 @@ > `const` **useInitStorage**: `InitSdkHook`\<`FirebaseStorage`\> -Defined in: [src/sdk.tsx:107](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L107) +Defined in: [src/sdk.tsx:107](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L107) diff --git a/docs/reference/variables/version.md b/docs/reference/variables/version.md index 35c34d90..bb7d0e99 100644 --- a/docs/reference/variables/version.md +++ b/docs/reference/variables/version.md @@ -8,4 +8,4 @@ > `const` **version**: `string` -Defined in: [src/firebaseApp.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L22) +Defined in: [src/firebaseApp.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L22) From 91ea1ac6f1e2852662079d25042625938affb96c Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Wed, 15 Jul 2026 12:41:47 -0700 Subject: [PATCH 07/13] chore: regenerate reference docs --- docs/reference/classes/ReactFireError.md | 10 +++++----- docs/reference/functions/AuthCheck.md | 2 +- docs/reference/functions/ClaimsCheck.md | 2 +- docs/reference/functions/FirebaseAppProvider.md | 2 +- docs/reference/functions/StorageImage.md | 2 +- docs/reference/functions/SuspenseWithPerf.md | 2 +- docs/reference/functions/checkIdField.md | 2 +- docs/reference/functions/checkOptions.md | 2 +- docs/reference/functions/checkinitialData.md | 2 +- docs/reference/functions/preloadFirestoreDoc.md | 2 +- docs/reference/functions/preloadObservable.md | 2 +- docs/reference/functions/preloadUser.md | 2 +- docs/reference/functions/useAnalytics.md | 2 +- docs/reference/functions/useAppCheck.md | 2 +- docs/reference/functions/useAuth.md | 2 +- .../functions/useCallableFunctionResponse.md | 2 +- docs/reference/functions/useDatabase.md | 2 +- docs/reference/functions/useDatabaseList.md | 2 +- docs/reference/functions/useDatabaseListData.md | 2 +- docs/reference/functions/useDatabaseObject.md | 2 +- docs/reference/functions/useDatabaseObjectData.md | 2 +- docs/reference/functions/useFirebaseApp.md | 2 +- docs/reference/functions/useFirestore.md | 2 +- docs/reference/functions/useFirestoreCollection.md | 2 +- .../functions/useFirestoreCollectionData.md | 2 +- docs/reference/functions/useFirestoreDoc.md | 2 +- docs/reference/functions/useFirestoreDocData.md | 2 +- .../reference/functions/useFirestoreDocDataOnce.md | 2 +- docs/reference/functions/useFirestoreDocOnce.md | 2 +- docs/reference/functions/useFunctions.md | 2 +- docs/reference/functions/useIdTokenResult.md | 2 +- docs/reference/functions/useIsSuspenseEnabled.md | 2 +- docs/reference/functions/useObservable.md | 2 +- docs/reference/functions/usePerformance.md | 2 +- docs/reference/functions/useRemoteConfig.md | 2 +- docs/reference/functions/useRemoteConfigAll.md | 2 +- docs/reference/functions/useRemoteConfigBoolean.md | 2 +- docs/reference/functions/useRemoteConfigNumber.md | 2 +- docs/reference/functions/useRemoteConfigString.md | 2 +- docs/reference/functions/useRemoteConfigValue.md | 2 +- docs/reference/functions/useSigninCheck.md | 2 +- docs/reference/functions/useStorage.md | 2 +- docs/reference/functions/useStorageDownloadURL.md | 2 +- docs/reference/functions/useStorageTask.md | 2 +- .../useSuspenseEnabledFromConfigAndContext.md | 2 +- docs/reference/functions/useUser.md | 2 +- docs/reference/interfaces/AuthCheckProps.md | 8 ++++---- docs/reference/interfaces/ClaimCheckErrors.md | 2 +- docs/reference/interfaces/ClaimsCheckProps.md | 10 +++++----- docs/reference/interfaces/ClaimsValidator.md | 4 ++-- .../interfaces/FirebaseAppProviderProps.md | 10 +++++----- docs/reference/interfaces/ObservableStatusError.md | 14 +++++++------- .../interfaces/ObservableStatusLoading.md | 14 +++++++------- .../interfaces/ObservableStatusSuccess.md | 14 +++++++------- docs/reference/interfaces/ReactFireOptions.md | 10 +++++----- .../interfaces/SignInCheckOptionsBasic.md | 12 ++++++------ .../interfaces/SignInCheckOptionsClaimsObject.md | 14 +++++++------- .../SignInCheckOptionsClaimsValidator.md | 14 +++++++------- docs/reference/interfaces/SuspensePerfProps.md | 8 ++++---- docs/reference/type-aliases/ObservableStatus.md | 2 +- docs/reference/type-aliases/ReactFireGlobals.md | 8 ++++---- docs/reference/type-aliases/SigninCheckResult.md | 2 +- docs/reference/type-aliases/StorageImageProps.md | 10 +++++----- docs/reference/variables/AnalyticsProvider.md | 2 +- docs/reference/variables/AnalyticsSdkContext.md | 2 +- docs/reference/variables/AppCheckProvider.md | 2 +- docs/reference/variables/AppCheckSdkContext.md | 2 +- docs/reference/variables/AuthProvider.md | 2 +- docs/reference/variables/AuthSdkContext.md | 2 +- docs/reference/variables/DatabaseProvider.md | 2 +- docs/reference/variables/DatabaseSdkContext.md | 2 +- docs/reference/variables/FirestoreProvider.md | 2 +- docs/reference/variables/FirestoreSdkContext.md | 2 +- docs/reference/variables/FunctionsProvider.md | 2 +- docs/reference/variables/FunctionsSdkContext.md | 2 +- docs/reference/variables/PerformanceProvider.md | 2 +- docs/reference/variables/PerformanceSdkContext.md | 2 +- docs/reference/variables/RemoteConfigProvider.md | 2 +- docs/reference/variables/RemoteConfigSdkContext.md | 2 +- docs/reference/variables/StorageProvider.md | 2 +- docs/reference/variables/StorageSdkContext.md | 2 +- docs/reference/variables/useInitAnalytics.md | 2 +- docs/reference/variables/useInitAppCheck.md | 2 +- docs/reference/variables/useInitAuth.md | 2 +- docs/reference/variables/useInitDatabase.md | 2 +- docs/reference/variables/useInitFirestore.md | 2 +- docs/reference/variables/useInitFunctions.md | 2 +- docs/reference/variables/useInitPerformance.md | 2 +- docs/reference/variables/useInitRemoteConfig.md | 2 +- docs/reference/variables/useInitStorage.md | 2 +- docs/reference/variables/version.md | 2 +- 91 files changed, 156 insertions(+), 156 deletions(-) diff --git a/docs/reference/classes/ReactFireError.md b/docs/reference/classes/ReactFireError.md index 6e35ee91..591ddb68 100644 --- a/docs/reference/classes/ReactFireError.md +++ b/docs/reference/classes/ReactFireError.md @@ -6,7 +6,7 @@ # Class: ReactFireError -Defined in: [src/index.ts:12](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L12) +Defined in: [src/index.ts:12](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L12) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/index.ts:12](https://github.com/tyler-reitz/reactfire/blob/main > **new ReactFireError**(`code`, `message`, `customData?`): `ReactFireError` -Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) #### Parameters @@ -60,7 +60,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:24 > `readonly` **code**: `string` -Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) *** @@ -68,7 +68,7 @@ Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **customData?**: `Record`\<`string`, `unknown`\> -Defined in: [src/index.ts:15](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L15) +Defined in: [src/index.ts:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L15) *** @@ -88,7 +88,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075 > `readonly` **name**: `"ReactFireError"` = `'ReactFireError'` -Defined in: [src/index.ts:13](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L13) +Defined in: [src/index.ts:13](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L13) #### Overrides diff --git a/docs/reference/functions/AuthCheck.md b/docs/reference/functions/AuthCheck.md index a2c73441..06738074 100644 --- a/docs/reference/functions/AuthCheck.md +++ b/docs/reference/functions/AuthCheck.md @@ -8,7 +8,7 @@ > **AuthCheck**(`__namedParameters`): `ReactElement` -Defined in: [src/auth.tsx:257](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L257) +Defined in: [src/auth.tsx:257](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L257) ## Parameters diff --git a/docs/reference/functions/ClaimsCheck.md b/docs/reference/functions/ClaimsCheck.md index 230ed4bb..5138d974 100644 --- a/docs/reference/functions/ClaimsCheck.md +++ b/docs/reference/functions/ClaimsCheck.md @@ -8,7 +8,7 @@ > **ClaimsCheck**(`__namedParameters`): `Element` -Defined in: [src/auth.tsx:213](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L213) +Defined in: [src/auth.tsx:213](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L213) ## Parameters diff --git a/docs/reference/functions/FirebaseAppProvider.md b/docs/reference/functions/FirebaseAppProvider.md index f64b20b0..6b851653 100644 --- a/docs/reference/functions/FirebaseAppProvider.md +++ b/docs/reference/functions/FirebaseAppProvider.md @@ -8,7 +8,7 @@ > **FirebaseAppProvider**(`props`): `Element` -Defined in: [src/firebaseApp.tsx:26](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L26) +Defined in: [src/firebaseApp.tsx:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L26) ## Parameters diff --git a/docs/reference/functions/StorageImage.md b/docs/reference/functions/StorageImage.md index 8ae20007..24370e02 100644 --- a/docs/reference/functions/StorageImage.md +++ b/docs/reference/functions/StorageImage.md @@ -8,7 +8,7 @@ > **StorageImage**(`props`): `Element` -Defined in: [src/storage.tsx:78](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L78) +Defined in: [src/storage.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L78) ## Parameters diff --git a/docs/reference/functions/SuspenseWithPerf.md b/docs/reference/functions/SuspenseWithPerf.md index 87d04f94..6ab06a72 100644 --- a/docs/reference/functions/SuspenseWithPerf.md +++ b/docs/reference/functions/SuspenseWithPerf.md @@ -8,7 +8,7 @@ > **SuspenseWithPerf**(`__namedParameters`): `ReactElement` -Defined in: [src/performance.tsx:9](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L9) +Defined in: [src/performance.tsx:9](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L9) ## Parameters diff --git a/docs/reference/functions/checkIdField.md b/docs/reference/functions/checkIdField.md index 4cef06ff..82d7c5a9 100644 --- a/docs/reference/functions/checkIdField.md +++ b/docs/reference/functions/checkIdField.md @@ -8,7 +8,7 @@ > **checkIdField**(`options`): `any` -Defined in: [src/index.ts:47](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L47) +Defined in: [src/index.ts:47](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L47) ## Parameters diff --git a/docs/reference/functions/checkOptions.md b/docs/reference/functions/checkOptions.md index 57294f80..4f4fdaf0 100644 --- a/docs/reference/functions/checkOptions.md +++ b/docs/reference/functions/checkOptions.md @@ -8,7 +8,7 @@ > **checkOptions**(`options`, `field`): `any` -Defined in: [src/index.ts:34](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L34) +Defined in: [src/index.ts:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L34) ## Parameters diff --git a/docs/reference/functions/checkinitialData.md b/docs/reference/functions/checkinitialData.md index 0abdebde..f2c78405 100644 --- a/docs/reference/functions/checkinitialData.md +++ b/docs/reference/functions/checkinitialData.md @@ -8,7 +8,7 @@ > **checkinitialData**(`options`): `any` -Defined in: [src/index.ts:43](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L43) +Defined in: [src/index.ts:43](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L43) ## Parameters diff --git a/docs/reference/functions/preloadFirestoreDoc.md b/docs/reference/functions/preloadFirestoreDoc.md index 713f2f77..a9c7db3a 100644 --- a/docs/reference/functions/preloadFirestoreDoc.md +++ b/docs/reference/functions/preloadFirestoreDoc.md @@ -8,7 +8,7 @@ > **preloadFirestoreDoc**(`refProvider`): `Promise`\<`SuspenseSubject`\<`DocumentSnapshot`\<`DocumentData`, `DocumentData`\>\>\> -Defined in: [src/firestore.tsx:28](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L28) +Defined in: [src/firestore.tsx:28](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L28) Preload a subscription to a Firestore document reference. diff --git a/docs/reference/functions/preloadObservable.md b/docs/reference/functions/preloadObservable.md index 2f08bde0..92aab4f9 100644 --- a/docs/reference/functions/preloadObservable.md +++ b/docs/reference/functions/preloadObservable.md @@ -8,7 +8,7 @@ > **preloadObservable**\<`T`\>(`source`, `id`, `suspenseEnabled?`): `SuspenseSubject`\<`T`\> -Defined in: [src/useObservable.ts:20](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L20) +Defined in: [src/useObservable.ts:20](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L20) ## Type Parameters diff --git a/docs/reference/functions/preloadUser.md b/docs/reference/functions/preloadUser.md index 8df97f52..65e598af 100644 --- a/docs/reference/functions/preloadUser.md +++ b/docs/reference/functions/preloadUser.md @@ -8,7 +8,7 @@ > **preloadUser**(`authResolver`): `Promise`\<`User` \| `null` \| `undefined`\> -Defined in: [src/auth.tsx:11](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L11) +Defined in: [src/auth.tsx:11](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L11) ## Parameters diff --git a/docs/reference/functions/useAnalytics.md b/docs/reference/functions/useAnalytics.md index 0f562daf..1a8eb2eb 100644 --- a/docs/reference/functions/useAnalytics.md +++ b/docs/reference/functions/useAnalytics.md @@ -8,7 +8,7 @@ > **useAnalytics**(): `Analytics` -Defined in: [src/sdk.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L84) +Defined in: [src/sdk.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L84) ## Returns diff --git a/docs/reference/functions/useAppCheck.md b/docs/reference/functions/useAppCheck.md index 0bdedb1d..0a8f8e45 100644 --- a/docs/reference/functions/useAppCheck.md +++ b/docs/reference/functions/useAppCheck.md @@ -8,7 +8,7 @@ > **useAppCheck**(): `AppCheck` -Defined in: [src/sdk.tsx:82](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L82) +Defined in: [src/sdk.tsx:82](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L82) ## Returns diff --git a/docs/reference/functions/useAuth.md b/docs/reference/functions/useAuth.md index 46976021..fd9a7056 100644 --- a/docs/reference/functions/useAuth.md +++ b/docs/reference/functions/useAuth.md @@ -8,7 +8,7 @@ > **useAuth**(): `Auth` -Defined in: [src/sdk.tsx:83](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L83) +Defined in: [src/sdk.tsx:83](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L83) ## Returns diff --git a/docs/reference/functions/useCallableFunctionResponse.md b/docs/reference/functions/useCallableFunctionResponse.md index 56f7332d..04d98135 100644 --- a/docs/reference/functions/useCallableFunctionResponse.md +++ b/docs/reference/functions/useCallableFunctionResponse.md @@ -8,7 +8,7 @@ > **useCallableFunctionResponse**\<`RequestData`, `ResponseData`\>(`functionName`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`ResponseData`\> -Defined in: [src/functions.tsx:13](https://github.com/tyler-reitz/reactfire/blob/main/src/functions.tsx#L13) +Defined in: [src/functions.tsx:13](https://github.com/FirebaseExtended/reactfire/blob/main/src/functions.tsx#L13) Calls a callable function. diff --git a/docs/reference/functions/useDatabase.md b/docs/reference/functions/useDatabase.md index 72fb7ad6..1efac90b 100644 --- a/docs/reference/functions/useDatabase.md +++ b/docs/reference/functions/useDatabase.md @@ -8,7 +8,7 @@ > **useDatabase**(): `Database` -Defined in: [src/sdk.tsx:85](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L85) +Defined in: [src/sdk.tsx:85](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L85) ## Returns diff --git a/docs/reference/functions/useDatabaseList.md b/docs/reference/functions/useDatabaseList.md index c4b10c4f..80615cd5 100644 --- a/docs/reference/functions/useDatabaseList.md +++ b/docs/reference/functions/useDatabaseList.md @@ -8,7 +8,7 @@ > **useDatabaseList**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[] \| `QueryChange`[]\> -Defined in: [src/database.tsx:48](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L48) +Defined in: [src/database.tsx:48](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L48) Subscribe to a Realtime Database list diff --git a/docs/reference/functions/useDatabaseListData.md b/docs/reference/functions/useDatabaseListData.md index 5ee4f668..991381f3 100644 --- a/docs/reference/functions/useDatabaseListData.md +++ b/docs/reference/functions/useDatabaseListData.md @@ -8,7 +8,7 @@ > **useDatabaseListData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[] \| `null`\> -Defined in: [src/database.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L58) +Defined in: [src/database.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L58) ## Type Parameters diff --git a/docs/reference/functions/useDatabaseObject.md b/docs/reference/functions/useDatabaseObject.md index fa0ab424..9ff176ff 100644 --- a/docs/reference/functions/useDatabaseObject.md +++ b/docs/reference/functions/useDatabaseObject.md @@ -8,7 +8,7 @@ > **useDatabaseObject**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `QueryChange`\> -Defined in: [src/database.tsx:27](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L27) +Defined in: [src/database.tsx:27](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L27) Subscribe to a Realtime Database object diff --git a/docs/reference/functions/useDatabaseObjectData.md b/docs/reference/functions/useDatabaseObjectData.md index 46dacedf..34fec029 100644 --- a/docs/reference/functions/useDatabaseObjectData.md +++ b/docs/reference/functions/useDatabaseObjectData.md @@ -8,7 +8,7 @@ > **useDatabaseObjectData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`\> -Defined in: [src/database.tsx:34](https://github.com/tyler-reitz/reactfire/blob/main/src/database.tsx#L34) +Defined in: [src/database.tsx:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/database.tsx#L34) ## Type Parameters diff --git a/docs/reference/functions/useFirebaseApp.md b/docs/reference/functions/useFirebaseApp.md index c7e3e431..d7f1d7cc 100644 --- a/docs/reference/functions/useFirebaseApp.md +++ b/docs/reference/functions/useFirebaseApp.md @@ -8,7 +8,7 @@ > **useFirebaseApp**(): `FirebaseApp` -Defined in: [src/firebaseApp.tsx:80](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L80) +Defined in: [src/firebaseApp.tsx:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L80) ## Returns diff --git a/docs/reference/functions/useFirestore.md b/docs/reference/functions/useFirestore.md index 609a8944..648d679b 100644 --- a/docs/reference/functions/useFirestore.md +++ b/docs/reference/functions/useFirestore.md @@ -8,7 +8,7 @@ > **useFirestore**(): `Firestore` -Defined in: [src/sdk.tsx:86](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L86) +Defined in: [src/sdk.tsx:86](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L86) ## Returns diff --git a/docs/reference/functions/useFirestoreCollection.md b/docs/reference/functions/useFirestoreCollection.md index 4444a5bf..a67b5de4 100644 --- a/docs/reference/functions/useFirestoreCollection.md +++ b/docs/reference/functions/useFirestoreCollection.md @@ -8,7 +8,7 @@ > **useFirestoreCollection**\<`T`\>(`query`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`QuerySnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:86](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L86) +Defined in: [src/firestore.tsx:86](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L86) Subscribe to a Firestore collection diff --git a/docs/reference/functions/useFirestoreCollectionData.md b/docs/reference/functions/useFirestoreCollectionData.md index 33773aa0..09f70b29 100644 --- a/docs/reference/functions/useFirestoreCollectionData.md +++ b/docs/reference/functions/useFirestoreCollectionData.md @@ -8,7 +8,7 @@ > **useFirestoreCollectionData**\<`T`\>(`query`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`[]\> -Defined in: [src/firestore.tsx:96](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L96) +Defined in: [src/firestore.tsx:96](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L96) Subscribe to a Firestore collection and unwrap the snapshot into an array. diff --git a/docs/reference/functions/useFirestoreDoc.md b/docs/reference/functions/useFirestoreDoc.md index 215c0db4..00add301 100644 --- a/docs/reference/functions/useFirestoreDoc.md +++ b/docs/reference/functions/useFirestoreDoc.md @@ -8,7 +8,7 @@ > **useFirestoreDoc**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`DocumentSnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:42](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L42) +Defined in: [src/firestore.tsx:42](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L42) Subscribe to Firestore Document changes diff --git a/docs/reference/functions/useFirestoreDocData.md b/docs/reference/functions/useFirestoreDocData.md index f6696f15..1267c3da 100644 --- a/docs/reference/functions/useFirestoreDocData.md +++ b/docs/reference/functions/useFirestoreDocData.md @@ -8,7 +8,7 @@ > **useFirestoreDocData**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `undefined`\> -Defined in: [src/firestore.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L62) +Defined in: [src/firestore.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L62) Subscribe to Firestore Document changes and unwrap the document into a plain object diff --git a/docs/reference/functions/useFirestoreDocDataOnce.md b/docs/reference/functions/useFirestoreDocDataOnce.md index 4a46f418..db47124e 100644 --- a/docs/reference/functions/useFirestoreDocDataOnce.md +++ b/docs/reference/functions/useFirestoreDocDataOnce.md @@ -8,7 +8,7 @@ > **useFirestoreDocDataOnce**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `undefined`\> -Defined in: [src/firestore.tsx:74](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L74) +Defined in: [src/firestore.tsx:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L74) Get a Firestore document, unwrap the document into a plain object, and don't subscribe to changes diff --git a/docs/reference/functions/useFirestoreDocOnce.md b/docs/reference/functions/useFirestoreDocOnce.md index 47fc208e..bbe224d7 100644 --- a/docs/reference/functions/useFirestoreDocOnce.md +++ b/docs/reference/functions/useFirestoreDocOnce.md @@ -8,7 +8,7 @@ > **useFirestoreDocOnce**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`DocumentSnapshot`\<`T`, `DocumentData`\>\> -Defined in: [src/firestore.tsx:52](https://github.com/tyler-reitz/reactfire/blob/main/src/firestore.tsx#L52) +Defined in: [src/firestore.tsx:52](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L52) Get a firestore document and don't subscribe to changes diff --git a/docs/reference/functions/useFunctions.md b/docs/reference/functions/useFunctions.md index 41aea275..bd5a2ade 100644 --- a/docs/reference/functions/useFunctions.md +++ b/docs/reference/functions/useFunctions.md @@ -8,7 +8,7 @@ > **useFunctions**(): `Functions` -Defined in: [src/sdk.tsx:87](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L87) +Defined in: [src/sdk.tsx:87](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L87) ## Returns diff --git a/docs/reference/functions/useIdTokenResult.md b/docs/reference/functions/useIdTokenResult.md index d6efc428..a8e573dd 100644 --- a/docs/reference/functions/useIdTokenResult.md +++ b/docs/reference/functions/useIdTokenResult.md @@ -8,7 +8,7 @@ > **useIdTokenResult**(`user`, `forceRefresh?`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`IdTokenResult`\> -Defined in: [src/auth.tsx:41](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L41) +Defined in: [src/auth.tsx:41](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L41) ## Parameters diff --git a/docs/reference/functions/useIsSuspenseEnabled.md b/docs/reference/functions/useIsSuspenseEnabled.md index 7b72213d..b068fabe 100644 --- a/docs/reference/functions/useIsSuspenseEnabled.md +++ b/docs/reference/functions/useIsSuspenseEnabled.md @@ -8,7 +8,7 @@ > **useIsSuspenseEnabled**(): `boolean` -Defined in: [src/firebaseApp.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L62) +Defined in: [src/firebaseApp.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L62) ## Returns diff --git a/docs/reference/functions/useObservable.md b/docs/reference/functions/useObservable.md index 169d30c0..0044586e 100644 --- a/docs/reference/functions/useObservable.md +++ b/docs/reference/functions/useObservable.md @@ -8,7 +8,7 @@ > **useObservable**\<`T`\>(`observableId`, `source`, `config?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`\> -Defined in: [src/useObservable.ts:97](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L97) +Defined in: [src/useObservable.ts:97](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L97) Subscribe to an Observable and return its current status. diff --git a/docs/reference/functions/usePerformance.md b/docs/reference/functions/usePerformance.md index ad8b1a08..0ff1b523 100644 --- a/docs/reference/functions/usePerformance.md +++ b/docs/reference/functions/usePerformance.md @@ -8,7 +8,7 @@ > **usePerformance**(): `FirebasePerformance` -Defined in: [src/sdk.tsx:88](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L88) +Defined in: [src/sdk.tsx:88](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L88) ## Returns diff --git a/docs/reference/functions/useRemoteConfig.md b/docs/reference/functions/useRemoteConfig.md index b06ecf96..78b14879 100644 --- a/docs/reference/functions/useRemoteConfig.md +++ b/docs/reference/functions/useRemoteConfig.md @@ -8,7 +8,7 @@ > **useRemoteConfig**(): `RemoteConfig` -Defined in: [src/sdk.tsx:90](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L90) +Defined in: [src/sdk.tsx:90](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L90) ## Returns diff --git a/docs/reference/functions/useRemoteConfigAll.md b/docs/reference/functions/useRemoteConfigAll.md index 53d9038d..52553698 100644 --- a/docs/reference/functions/useRemoteConfigAll.md +++ b/docs/reference/functions/useRemoteConfigAll.md @@ -8,7 +8,7 @@ > **useRemoteConfigAll**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`AllParameters`\> -Defined in: [src/remote-config.tsx:66](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L66) +Defined in: [src/remote-config.tsx:66](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L66) Convience method similar to useRemoteConfigValue. Returns allRemote Config parameters. diff --git a/docs/reference/functions/useRemoteConfigBoolean.md b/docs/reference/functions/useRemoteConfigBoolean.md index 0d80ede8..14c2e3c4 100644 --- a/docs/reference/functions/useRemoteConfigBoolean.md +++ b/docs/reference/functions/useRemoteConfigBoolean.md @@ -8,7 +8,7 @@ > **useRemoteConfigBoolean**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`boolean`\> -Defined in: [src/remote-config.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L58) +Defined in: [src/remote-config.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L58) Convience method similar to useRemoteConfigValue. Returns a `boolean` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigNumber.md b/docs/reference/functions/useRemoteConfigNumber.md index cbc00fcd..337d8d66 100644 --- a/docs/reference/functions/useRemoteConfigNumber.md +++ b/docs/reference/functions/useRemoteConfigNumber.md @@ -8,7 +8,7 @@ > **useRemoteConfigNumber**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`number`\> -Defined in: [src/remote-config.tsx:50](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L50) +Defined in: [src/remote-config.tsx:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L50) Convience method similar to useRemoteConfigValue. Returns a `number` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigString.md b/docs/reference/functions/useRemoteConfigString.md index 0a7c80f3..65e01bca 100644 --- a/docs/reference/functions/useRemoteConfigString.md +++ b/docs/reference/functions/useRemoteConfigString.md @@ -8,7 +8,7 @@ > **useRemoteConfigString**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`string`\> -Defined in: [src/remote-config.tsx:42](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L42) +Defined in: [src/remote-config.tsx:42](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L42) Convience method similar to useRemoteConfigValue. Returns a `string` from a Remote Config parameter. diff --git a/docs/reference/functions/useRemoteConfigValue.md b/docs/reference/functions/useRemoteConfigValue.md index 2a422bae..d598191f 100644 --- a/docs/reference/functions/useRemoteConfigValue.md +++ b/docs/reference/functions/useRemoteConfigValue.md @@ -8,7 +8,7 @@ > **useRemoteConfigValue**(`key`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`Value`\> -Defined in: [src/remote-config.tsx:34](https://github.com/tyler-reitz/reactfire/blob/main/src/remote-config.tsx#L34) +Defined in: [src/remote-config.tsx:34](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config.tsx#L34) Accepts a key and optionally a Remote Config instance. Returns a Remote Config Value. diff --git a/docs/reference/functions/useSigninCheck.md b/docs/reference/functions/useSigninCheck.md index 480baee5..928d22e5 100644 --- a/docs/reference/functions/useSigninCheck.md +++ b/docs/reference/functions/useSigninCheck.md @@ -8,7 +8,7 @@ > **useSigninCheck**(`options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<[`SigninCheckResult`](../type-aliases/SigninCheckResult.md)\> -Defined in: [src/auth.tsx:134](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L134) +Defined in: [src/auth.tsx:134](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L134) Subscribe to the signed-in status of a user. diff --git a/docs/reference/functions/useStorage.md b/docs/reference/functions/useStorage.md index fa5f4d2e..74d28fe2 100644 --- a/docs/reference/functions/useStorage.md +++ b/docs/reference/functions/useStorage.md @@ -8,7 +8,7 @@ > **useStorage**(): `FirebaseStorage` -Defined in: [src/sdk.tsx:89](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L89) +Defined in: [src/sdk.tsx:89](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L89) ## Returns diff --git a/docs/reference/functions/useStorageDownloadURL.md b/docs/reference/functions/useStorageDownloadURL.md index 2b4e8fd7..2ab6fb3d 100644 --- a/docs/reference/functions/useStorageDownloadURL.md +++ b/docs/reference/functions/useStorageDownloadURL.md @@ -8,7 +8,7 @@ > **useStorageDownloadURL**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`string` \| `T`\> -Defined in: [src/storage.tsx:29](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L29) +Defined in: [src/storage.tsx:29](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L29) Subscribe to a storage ref's download URL diff --git a/docs/reference/functions/useStorageTask.md b/docs/reference/functions/useStorageTask.md index 8bc76230..2d462c71 100644 --- a/docs/reference/functions/useStorageTask.md +++ b/docs/reference/functions/useStorageTask.md @@ -8,7 +8,7 @@ > **useStorageTask**\<`T`\>(`task`, `ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `UploadTaskSnapshot`\> -Defined in: [src/storage.tsx:16](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L16) +Defined in: [src/storage.tsx:16](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L16) Subscribe to the progress of a storage task diff --git a/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md b/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md index c1d89629..4781e595 100644 --- a/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md +++ b/docs/reference/functions/useSuspenseEnabledFromConfigAndContext.md @@ -8,7 +8,7 @@ > **useSuspenseEnabledFromConfigAndContext**(`suspenseFromConfig?`): `boolean` -Defined in: [src/firebaseApp.tsx:69](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L69) +Defined in: [src/firebaseApp.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L69) ## Parameters diff --git a/docs/reference/functions/useUser.md b/docs/reference/functions/useUser.md index d4536df2..da91d45b 100644 --- a/docs/reference/functions/useUser.md +++ b/docs/reference/functions/useUser.md @@ -8,7 +8,7 @@ > **useUser**\<`T`\>(`options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`User` \| `null`\> -Defined in: [src/auth.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L22) +Defined in: [src/auth.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L22) Subscribe to Firebase auth state changes, including token refresh diff --git a/docs/reference/interfaces/AuthCheckProps.md b/docs/reference/interfaces/AuthCheckProps.md index 26aa237e..37e7b895 100644 --- a/docs/reference/interfaces/AuthCheckProps.md +++ b/docs/reference/interfaces/AuthCheckProps.md @@ -6,7 +6,7 @@ # Interface: AuthCheckProps -Defined in: [src/auth.tsx:52](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L52) +Defined in: [src/auth.tsx:52](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L52) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/auth.tsx:52](https://github.com/tyler-reitz/reactfire/blob/main > **children**: `ReactNode` -Defined in: [src/auth.tsx:54](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L54) +Defined in: [src/auth.tsx:54](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L54) *** @@ -22,7 +22,7 @@ Defined in: [src/auth.tsx:54](https://github.com/tyler-reitz/reactfire/blob/main > **fallback**: `ReactNode` -Defined in: [src/auth.tsx:53](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L53) +Defined in: [src/auth.tsx:53](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L53) *** @@ -30,4 +30,4 @@ Defined in: [src/auth.tsx:53](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **requiredClaims?**: `Object` -Defined in: [src/auth.tsx:55](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L55) +Defined in: [src/auth.tsx:55](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L55) diff --git a/docs/reference/interfaces/ClaimCheckErrors.md b/docs/reference/interfaces/ClaimCheckErrors.md index 53b598f6..470ca5ab 100644 --- a/docs/reference/interfaces/ClaimCheckErrors.md +++ b/docs/reference/interfaces/ClaimCheckErrors.md @@ -6,7 +6,7 @@ # Interface: ClaimCheckErrors -Defined in: [src/auth.tsx:65](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L65) +Defined in: [src/auth.tsx:65](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L65) ## Indexable diff --git a/docs/reference/interfaces/ClaimsCheckProps.md b/docs/reference/interfaces/ClaimsCheckProps.md index ab7dc291..4d39e79b 100644 --- a/docs/reference/interfaces/ClaimsCheckProps.md +++ b/docs/reference/interfaces/ClaimsCheckProps.md @@ -6,7 +6,7 @@ # Interface: ClaimsCheckProps -Defined in: [src/auth.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L58) +Defined in: [src/auth.tsx:58](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L58) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/auth.tsx:58](https://github.com/tyler-reitz/reactfire/blob/main > **children**: `ReactNode` -Defined in: [src/auth.tsx:61](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L61) +Defined in: [src/auth.tsx:61](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L61) *** @@ -22,7 +22,7 @@ Defined in: [src/auth.tsx:61](https://github.com/tyler-reitz/reactfire/blob/main > **fallback**: `ReactNode` -Defined in: [src/auth.tsx:60](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L60) +Defined in: [src/auth.tsx:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L60) *** @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:60](https://github.com/tyler-reitz/reactfire/blob/main > **requiredClaims**: `object` -Defined in: [src/auth.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L62) +Defined in: [src/auth.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L62) #### Index Signature @@ -42,4 +42,4 @@ Defined in: [src/auth.tsx:62](https://github.com/tyler-reitz/reactfire/blob/main > **user**: `User` -Defined in: [src/auth.tsx:59](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L59) +Defined in: [src/auth.tsx:59](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L59) diff --git a/docs/reference/interfaces/ClaimsValidator.md b/docs/reference/interfaces/ClaimsValidator.md index 9f3991ba..feb558fd 100644 --- a/docs/reference/interfaces/ClaimsValidator.md +++ b/docs/reference/interfaces/ClaimsValidator.md @@ -6,11 +6,11 @@ # Interface: ClaimsValidator() -Defined in: [src/auth.tsx:91](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L91) +Defined in: [src/auth.tsx:91](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L91) > **ClaimsValidator**(`claims`): `object` -Defined in: [src/auth.tsx:92](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L92) +Defined in: [src/auth.tsx:92](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L92) ## Parameters diff --git a/docs/reference/interfaces/FirebaseAppProviderProps.md b/docs/reference/interfaces/FirebaseAppProviderProps.md index 55a78242..80a7ff39 100644 --- a/docs/reference/interfaces/FirebaseAppProviderProps.md +++ b/docs/reference/interfaces/FirebaseAppProviderProps.md @@ -6,7 +6,7 @@ # Interface: FirebaseAppProviderProps -Defined in: [src/firebaseApp.tsx:14](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L14) +Defined in: [src/firebaseApp.tsx:14](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L14) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/firebaseApp.tsx:14](https://github.com/tyler-reitz/reactfire/bl > `optional` **appName?**: `string` -Defined in: [src/firebaseApp.tsx:17](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L17) +Defined in: [src/firebaseApp.tsx:17](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L17) *** @@ -22,7 +22,7 @@ Defined in: [src/firebaseApp.tsx:17](https://github.com/tyler-reitz/reactfire/bl > `optional` **firebaseApp?**: `FirebaseApp` -Defined in: [src/firebaseApp.tsx:15](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L15) +Defined in: [src/firebaseApp.tsx:15](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L15) *** @@ -30,7 +30,7 @@ Defined in: [src/firebaseApp.tsx:15](https://github.com/tyler-reitz/reactfire/bl > `optional` **firebaseConfig?**: `FirebaseOptions` -Defined in: [src/firebaseApp.tsx:16](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L16) +Defined in: [src/firebaseApp.tsx:16](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L16) *** @@ -38,4 +38,4 @@ Defined in: [src/firebaseApp.tsx:16](https://github.com/tyler-reitz/reactfire/bl > `optional` **suspense?**: `boolean` -Defined in: [src/firebaseApp.tsx:18](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L18) +Defined in: [src/firebaseApp.tsx:18](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L18) diff --git a/docs/reference/interfaces/ObservableStatusError.md b/docs/reference/interfaces/ObservableStatusError.md index bfeec51e..9d1f0f3e 100644 --- a/docs/reference/interfaces/ObservableStatusError.md +++ b/docs/reference/interfaces/ObservableStatusError.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusError\ -Defined in: [src/useObservable.ts:72](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L72) +Defined in: [src/useObservable.ts:72](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L72) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:72](https://github.com/tyler-reitz/reactfire/b > **data**: `T` \| `undefined` -Defined in: [src/useObservable.ts:56](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L56) +Defined in: [src/useObservable.ts:56](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L56) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` -Defined in: [src/useObservable.ts:75](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L75) +Defined in: [src/useObservable.ts:75](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L75) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `boolean` -Defined in: [src/useObservable.ts:46](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L46) +Defined in: [src/useObservable.ts:46](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L46) Indicates whether the hook has emitted a value at some point @@ -84,7 +84,7 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:74](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L74) +Defined in: [src/useObservable.ts:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L74) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"error"` -Defined in: [src/useObservable.ts:73](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L73) +Defined in: [src/useObservable.ts:73](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L73) The loading status. diff --git a/docs/reference/interfaces/ObservableStatusLoading.md b/docs/reference/interfaces/ObservableStatusLoading.md index 1645827c..f0bf2fcd 100644 --- a/docs/reference/interfaces/ObservableStatusLoading.md +++ b/docs/reference/interfaces/ObservableStatusLoading.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusLoading\ -Defined in: [src/useObservable.ts:78](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L78) +Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L78) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:78](https://github.com/tyler-reitz/reactfire/b > **data**: `undefined` -Defined in: [src/useObservable.ts:80](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L80) +Defined in: [src/useObservable.ts:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L80) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` \| `undefined` -Defined in: [src/useObservable.ts:60](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L60) +Defined in: [src/useObservable.ts:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L60) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `false` -Defined in: [src/useObservable.ts:81](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L81) +Defined in: [src/useObservable.ts:81](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L81) Indicates whether the hook has emitted a value at some point @@ -84,7 +84,7 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:50](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L50) +Defined in: [src/useObservable.ts:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L50) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"loading"` -Defined in: [src/useObservable.ts:79](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L79) +Defined in: [src/useObservable.ts:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L79) The loading status. diff --git a/docs/reference/interfaces/ObservableStatusSuccess.md b/docs/reference/interfaces/ObservableStatusSuccess.md index ae4bdf31..8a5a4445 100644 --- a/docs/reference/interfaces/ObservableStatusSuccess.md +++ b/docs/reference/interfaces/ObservableStatusSuccess.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusSuccess\ -Defined in: [src/useObservable.ts:67](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L67) +Defined in: [src/useObservable.ts:67](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L67) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:67](https://github.com/tyler-reitz/reactfire/b > **data**: `T` -Defined in: [src/useObservable.ts:69](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L69) +Defined in: [src/useObservable.ts:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L69) The most recent value. @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` \| `undefined` -Defined in: [src/useObservable.ts:60](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L60) +Defined in: [src/useObservable.ts:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L60) Any error that may have occurred in the underlying observable @@ -54,7 +54,7 @@ Any error that may have occurred in the underlying observable > **firstValuePromise**: `Promise`\<`void`\> -Defined in: [src/useObservable.ts:64](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L64) +Defined in: [src/useObservable.ts:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L64) Promise that resolves after first emit from observable @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `boolean` -Defined in: [src/useObservable.ts:46](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L46) +Defined in: [src/useObservable.ts:46](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L46) Indicates whether the hook has emitted a value at some point @@ -84,7 +84,7 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:50](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L50) +Defined in: [src/useObservable.ts:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L50) If this is `true`, the hook will be emitting no further items. @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"success"` -Defined in: [src/useObservable.ts:68](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L68) +Defined in: [src/useObservable.ts:68](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L68) The loading status. diff --git a/docs/reference/interfaces/ReactFireOptions.md b/docs/reference/interfaces/ReactFireOptions.md index 6c319ad6..7ca63c5e 100644 --- a/docs/reference/interfaces/ReactFireOptions.md +++ b/docs/reference/interfaces/ReactFireOptions.md @@ -6,7 +6,7 @@ # Interface: ReactFireOptions\ -Defined in: [src/index.ts:24](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L24) +Defined in: [src/index.ts:24](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L24) ## Extended by @@ -24,7 +24,7 @@ Defined in: [src/index.ts:24](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) *** @@ -32,7 +32,7 @@ Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) *** @@ -40,7 +40,7 @@ Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -52,4 +52,4 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) diff --git a/docs/reference/interfaces/SignInCheckOptionsBasic.md b/docs/reference/interfaces/SignInCheckOptionsBasic.md index c460454a..6c9f2d66 100644 --- a/docs/reference/interfaces/SignInCheckOptionsBasic.md +++ b/docs/reference/interfaces/SignInCheckOptionsBasic.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsBasic -Defined in: [src/auth.tsx:83](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L83) +Defined in: [src/auth.tsx:83](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L83) ## Extends @@ -23,7 +23,7 @@ Defined in: [src/auth.tsx:83](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) *** @@ -31,7 +31,7 @@ Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -43,7 +43,7 @@ Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -71,7 +71,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) #### Inherited from diff --git a/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md b/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md index fc0e364a..092cde82 100644 --- a/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md +++ b/docs/reference/interfaces/SignInCheckOptionsClaimsObject.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsClaimsObject -Defined in: [src/auth.tsx:87](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L87) +Defined in: [src/auth.tsx:87](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L87) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/auth.tsx:87](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) #### Inherited from @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main > **requiredClaims**: `ParsedToken` -Defined in: [src/auth.tsx:88](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L88) +Defined in: [src/auth.tsx:88](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L88) *** @@ -62,7 +62,7 @@ Defined in: [src/auth.tsx:88](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -78,7 +78,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) #### Inherited from diff --git a/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md b/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md index 55ae514b..83517d7a 100644 --- a/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md +++ b/docs/reference/interfaces/SignInCheckOptionsClaimsValidator.md @@ -6,7 +6,7 @@ # Interface: SignInCheckOptionsClaimsValidator -Defined in: [src/auth.tsx:98](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L98) +Defined in: [src/auth.tsx:98](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L98) ## Extends @@ -18,7 +18,7 @@ Defined in: [src/auth.tsx:98](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **forceRefresh?**: `boolean` -Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L84) +Defined in: [src/auth.tsx:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L84) #### Inherited from @@ -30,7 +30,7 @@ Defined in: [src/auth.tsx:84](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **idField?**: `string` -Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L25) +Defined in: [src/index.ts:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L25) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [src/index.ts:25](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **initialData?**: `any` -Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L26) +Defined in: [src/index.ts:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L26) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [src/index.ts:26](https://github.com/tyler-reitz/reactfire/blob/main > `optional` **startWithValue?**: `any` -Defined in: [src/index.ts:30](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L30) +Defined in: [src/index.ts:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L30) #### Deprecated @@ -70,7 +70,7 @@ use initialData instead > `optional` **suspense?**: `boolean` -Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L31) +Defined in: [src/index.ts:31](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L31) #### Inherited from @@ -82,4 +82,4 @@ Defined in: [src/index.ts:31](https://github.com/tyler-reitz/reactfire/blob/main > **validateCustomClaims**: [`ClaimsValidator`](ClaimsValidator.md) -Defined in: [src/auth.tsx:99](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L99) +Defined in: [src/auth.tsx:99](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L99) diff --git a/docs/reference/interfaces/SuspensePerfProps.md b/docs/reference/interfaces/SuspensePerfProps.md index fbfaa1aa..a2ab17da 100644 --- a/docs/reference/interfaces/SuspensePerfProps.md +++ b/docs/reference/interfaces/SuspensePerfProps.md @@ -6,7 +6,7 @@ # Interface: SuspensePerfProps -Defined in: [src/performance.tsx:3](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L3) +Defined in: [src/performance.tsx:3](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L3) ## Properties @@ -14,7 +14,7 @@ Defined in: [src/performance.tsx:3](https://github.com/tyler-reitz/reactfire/blo > **children**: `ReactNode` -Defined in: [src/performance.tsx:4](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L4) +Defined in: [src/performance.tsx:4](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L4) *** @@ -22,7 +22,7 @@ Defined in: [src/performance.tsx:4](https://github.com/tyler-reitz/reactfire/blo > **fallback**: `ReactNode` -Defined in: [src/performance.tsx:6](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L6) +Defined in: [src/performance.tsx:6](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L6) *** @@ -30,4 +30,4 @@ Defined in: [src/performance.tsx:6](https://github.com/tyler-reitz/reactfire/blo > **traceId**: `string` -Defined in: [src/performance.tsx:5](https://github.com/tyler-reitz/reactfire/blob/main/src/performance.tsx#L5) +Defined in: [src/performance.tsx:5](https://github.com/FirebaseExtended/reactfire/blob/main/src/performance.tsx#L5) diff --git a/docs/reference/type-aliases/ObservableStatus.md b/docs/reference/type-aliases/ObservableStatus.md index 8587e411..bbf0276d 100644 --- a/docs/reference/type-aliases/ObservableStatus.md +++ b/docs/reference/type-aliases/ObservableStatus.md @@ -8,7 +8,7 @@ > **ObservableStatus**\<`T`\> = [`ObservableStatusLoading`](../interfaces/ObservableStatusLoading.md)\<`T`\> \| [`ObservableStatusError`](../interfaces/ObservableStatusError.md)\<`T`\> \| [`ObservableStatusSuccess`](../interfaces/ObservableStatusSuccess.md)\<`T`\> -Defined in: [src/useObservable.ts:84](https://github.com/tyler-reitz/reactfire/blob/main/src/useObservable.ts#L84) +Defined in: [src/useObservable.ts:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L84) ## Type Parameters diff --git a/docs/reference/type-aliases/ReactFireGlobals.md b/docs/reference/type-aliases/ReactFireGlobals.md index d0adeb33..995ef49a 100644 --- a/docs/reference/type-aliases/ReactFireGlobals.md +++ b/docs/reference/type-aliases/ReactFireGlobals.md @@ -8,7 +8,7 @@ > **ReactFireGlobals** = `object` -Defined in: [src/index.ts:6](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L6) +Defined in: [src/index.ts:6](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [src/index.ts:6](https://github.com/tyler-reitz/reactfire/blob/main/ > **\_reactFireDatabaseCachedQueries**: `DatabaseQuery`[] -Defined in: [src/index.ts:7](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L7) +Defined in: [src/index.ts:7](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L7) *** @@ -24,7 +24,7 @@ Defined in: [src/index.ts:7](https://github.com/tyler-reitz/reactfire/blob/main/ > **\_reactFireFirestoreQueryCache**: `FirestoreQuery`[] -Defined in: [src/index.ts:8](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L8) +Defined in: [src/index.ts:8](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L8) *** @@ -32,4 +32,4 @@ Defined in: [src/index.ts:8](https://github.com/tyler-reitz/reactfire/blob/main/ > **\_reactFirePreloadedObservables**: `Map`\<`string`, `SuspenseSubject`\<`any`\>\> -Defined in: [src/index.ts:9](https://github.com/tyler-reitz/reactfire/blob/main/src/index.ts#L9) +Defined in: [src/index.ts:9](https://github.com/FirebaseExtended/reactfire/blob/main/src/index.ts#L9) diff --git a/docs/reference/type-aliases/SigninCheckResult.md b/docs/reference/type-aliases/SigninCheckResult.md index 5e25682e..bb80be74 100644 --- a/docs/reference/type-aliases/SigninCheckResult.md +++ b/docs/reference/type-aliases/SigninCheckResult.md @@ -8,4 +8,4 @@ > **SigninCheckResult** = \{ `errors`: \{ \}; `hasRequiredClaims`: `false`; `signedIn`: `false`; `user`: `null`; \} \| \{ `errors`: [`ClaimCheckErrors`](../interfaces/ClaimCheckErrors.md); `hasRequiredClaims`: `boolean`; `signedIn`: `true`; `user`: `User`; \} -Defined in: [src/auth.tsx:69](https://github.com/tyler-reitz/reactfire/blob/main/src/auth.tsx#L69) +Defined in: [src/auth.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L69) diff --git a/docs/reference/type-aliases/StorageImageProps.md b/docs/reference/type-aliases/StorageImageProps.md index f79d625b..b75fa337 100644 --- a/docs/reference/type-aliases/StorageImageProps.md +++ b/docs/reference/type-aliases/StorageImageProps.md @@ -8,7 +8,7 @@ > **StorageImageProps** = `object` -Defined in: [src/storage.tsx:36](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L36) +Defined in: [src/storage.tsx:36](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L36) ## Properties @@ -16,7 +16,7 @@ Defined in: [src/storage.tsx:36](https://github.com/tyler-reitz/reactfire/blob/m > `optional` **placeHolder?**: `React.ReactNode` -Defined in: [src/storage.tsx:40](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L40) +Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L40) *** @@ -24,7 +24,7 @@ Defined in: [src/storage.tsx:40](https://github.com/tyler-reitz/reactfire/blob/m > `optional` **storage?**: `FirebaseStorage` -Defined in: [src/storage.tsx:38](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L38) +Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L38) *** @@ -32,7 +32,7 @@ Defined in: [src/storage.tsx:38](https://github.com/tyler-reitz/reactfire/blob/m > **storagePath**: `string` -Defined in: [src/storage.tsx:37](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L37) +Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L37) *** @@ -40,4 +40,4 @@ Defined in: [src/storage.tsx:37](https://github.com/tyler-reitz/reactfire/blob/m > `optional` **suspense?**: `boolean` -Defined in: [src/storage.tsx:39](https://github.com/tyler-reitz/reactfire/blob/main/src/storage.tsx#L39) +Defined in: [src/storage.tsx:39](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L39) diff --git a/docs/reference/variables/AnalyticsProvider.md b/docs/reference/variables/AnalyticsProvider.md index 7e36d04c..67edf246 100644 --- a/docs/reference/variables/AnalyticsProvider.md +++ b/docs/reference/variables/AnalyticsProvider.md @@ -8,7 +8,7 @@ > `const` **AnalyticsProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:74](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L74) +Defined in: [src/sdk.tsx:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L74) ## Parameters diff --git a/docs/reference/variables/AnalyticsSdkContext.md b/docs/reference/variables/AnalyticsSdkContext.md index 483209d3..8d51b3f9 100644 --- a/docs/reference/variables/AnalyticsSdkContext.md +++ b/docs/reference/variables/AnalyticsSdkContext.md @@ -8,4 +8,4 @@ > `const` **AnalyticsSdkContext**: `Context`\<`Analytics` \| `undefined`\> -Defined in: [src/sdk.tsx:20](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L20) +Defined in: [src/sdk.tsx:20](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L20) diff --git a/docs/reference/variables/AppCheckProvider.md b/docs/reference/variables/AppCheckProvider.md index f8d2e847..ff42596a 100644 --- a/docs/reference/variables/AppCheckProvider.md +++ b/docs/reference/variables/AppCheckProvider.md @@ -8,7 +8,7 @@ > `const` **AppCheckProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:72](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L72) +Defined in: [src/sdk.tsx:72](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L72) ## Parameters diff --git a/docs/reference/variables/AppCheckSdkContext.md b/docs/reference/variables/AppCheckSdkContext.md index f016ac4c..311519af 100644 --- a/docs/reference/variables/AppCheckSdkContext.md +++ b/docs/reference/variables/AppCheckSdkContext.md @@ -8,4 +8,4 @@ > `const` **AppCheckSdkContext**: `Context`\<`AppCheck` \| `undefined`\> -Defined in: [src/sdk.tsx:18](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L18) +Defined in: [src/sdk.tsx:18](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L18) diff --git a/docs/reference/variables/AuthProvider.md b/docs/reference/variables/AuthProvider.md index 33889ce0..11ea5392 100644 --- a/docs/reference/variables/AuthProvider.md +++ b/docs/reference/variables/AuthProvider.md @@ -8,7 +8,7 @@ > `const` **AuthProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:73](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L73) +Defined in: [src/sdk.tsx:73](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L73) ## Parameters diff --git a/docs/reference/variables/AuthSdkContext.md b/docs/reference/variables/AuthSdkContext.md index 2ab5f3c8..22b522cb 100644 --- a/docs/reference/variables/AuthSdkContext.md +++ b/docs/reference/variables/AuthSdkContext.md @@ -8,4 +8,4 @@ > `const` **AuthSdkContext**: `Context`\<`Auth` \| `undefined`\> -Defined in: [src/sdk.tsx:19](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L19) +Defined in: [src/sdk.tsx:19](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L19) diff --git a/docs/reference/variables/DatabaseProvider.md b/docs/reference/variables/DatabaseProvider.md index f9371493..e8069948 100644 --- a/docs/reference/variables/DatabaseProvider.md +++ b/docs/reference/variables/DatabaseProvider.md @@ -8,7 +8,7 @@ > `const` **DatabaseProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:75](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L75) +Defined in: [src/sdk.tsx:75](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L75) ## Parameters diff --git a/docs/reference/variables/DatabaseSdkContext.md b/docs/reference/variables/DatabaseSdkContext.md index dcb795b2..09acae02 100644 --- a/docs/reference/variables/DatabaseSdkContext.md +++ b/docs/reference/variables/DatabaseSdkContext.md @@ -8,4 +8,4 @@ > `const` **DatabaseSdkContext**: `Context`\<`Database` \| `undefined`\> -Defined in: [src/sdk.tsx:21](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L21) +Defined in: [src/sdk.tsx:21](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L21) diff --git a/docs/reference/variables/FirestoreProvider.md b/docs/reference/variables/FirestoreProvider.md index d465802f..d689f31f 100644 --- a/docs/reference/variables/FirestoreProvider.md +++ b/docs/reference/variables/FirestoreProvider.md @@ -8,7 +8,7 @@ > `const` **FirestoreProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:76](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L76) +Defined in: [src/sdk.tsx:76](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L76) ## Parameters diff --git a/docs/reference/variables/FirestoreSdkContext.md b/docs/reference/variables/FirestoreSdkContext.md index 177e08ca..0fcb9ea2 100644 --- a/docs/reference/variables/FirestoreSdkContext.md +++ b/docs/reference/variables/FirestoreSdkContext.md @@ -8,4 +8,4 @@ > `const` **FirestoreSdkContext**: `Context`\<`Firestore` \| `undefined`\> -Defined in: [src/sdk.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L22) +Defined in: [src/sdk.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L22) diff --git a/docs/reference/variables/FunctionsProvider.md b/docs/reference/variables/FunctionsProvider.md index 392a159c..918b2609 100644 --- a/docs/reference/variables/FunctionsProvider.md +++ b/docs/reference/variables/FunctionsProvider.md @@ -8,7 +8,7 @@ > `const` **FunctionsProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:77](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L77) +Defined in: [src/sdk.tsx:77](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L77) ## Parameters diff --git a/docs/reference/variables/FunctionsSdkContext.md b/docs/reference/variables/FunctionsSdkContext.md index d46d84e8..fe59787f 100644 --- a/docs/reference/variables/FunctionsSdkContext.md +++ b/docs/reference/variables/FunctionsSdkContext.md @@ -8,4 +8,4 @@ > `const` **FunctionsSdkContext**: `Context`\<`Functions` \| `undefined`\> -Defined in: [src/sdk.tsx:23](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L23) +Defined in: [src/sdk.tsx:23](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L23) diff --git a/docs/reference/variables/PerformanceProvider.md b/docs/reference/variables/PerformanceProvider.md index 0f24ad2f..ee2fcc28 100644 --- a/docs/reference/variables/PerformanceProvider.md +++ b/docs/reference/variables/PerformanceProvider.md @@ -8,7 +8,7 @@ > `const` **PerformanceProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:78](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L78) +Defined in: [src/sdk.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L78) ## Parameters diff --git a/docs/reference/variables/PerformanceSdkContext.md b/docs/reference/variables/PerformanceSdkContext.md index 2d266faf..cff32f29 100644 --- a/docs/reference/variables/PerformanceSdkContext.md +++ b/docs/reference/variables/PerformanceSdkContext.md @@ -8,4 +8,4 @@ > `const` **PerformanceSdkContext**: `Context`\<`FirebasePerformance` \| `undefined`\> -Defined in: [src/sdk.tsx:25](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L25) +Defined in: [src/sdk.tsx:25](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L25) diff --git a/docs/reference/variables/RemoteConfigProvider.md b/docs/reference/variables/RemoteConfigProvider.md index 21e79a6e..8d3d3625 100644 --- a/docs/reference/variables/RemoteConfigProvider.md +++ b/docs/reference/variables/RemoteConfigProvider.md @@ -8,7 +8,7 @@ > `const` **RemoteConfigProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:80](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L80) +Defined in: [src/sdk.tsx:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L80) ## Parameters diff --git a/docs/reference/variables/RemoteConfigSdkContext.md b/docs/reference/variables/RemoteConfigSdkContext.md index e1d15288..00fbb0f7 100644 --- a/docs/reference/variables/RemoteConfigSdkContext.md +++ b/docs/reference/variables/RemoteConfigSdkContext.md @@ -8,4 +8,4 @@ > `const` **RemoteConfigSdkContext**: `Context`\<`RemoteConfig` \| `undefined`\> -Defined in: [src/sdk.tsx:26](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L26) +Defined in: [src/sdk.tsx:26](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L26) diff --git a/docs/reference/variables/StorageProvider.md b/docs/reference/variables/StorageProvider.md index 04d3612c..dbcb81c1 100644 --- a/docs/reference/variables/StorageProvider.md +++ b/docs/reference/variables/StorageProvider.md @@ -8,7 +8,7 @@ > `const` **StorageProvider**: (`props`) => `ReactElement` -Defined in: [src/sdk.tsx:79](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L79) +Defined in: [src/sdk.tsx:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L79) ## Parameters diff --git a/docs/reference/variables/StorageSdkContext.md b/docs/reference/variables/StorageSdkContext.md index 14c6cc7e..e921e113 100644 --- a/docs/reference/variables/StorageSdkContext.md +++ b/docs/reference/variables/StorageSdkContext.md @@ -8,4 +8,4 @@ > `const` **StorageSdkContext**: `Context`\<`FirebaseStorage` \| `undefined`\> -Defined in: [src/sdk.tsx:24](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L24) +Defined in: [src/sdk.tsx:24](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L24) diff --git a/docs/reference/variables/useInitAnalytics.md b/docs/reference/variables/useInitAnalytics.md index 56162094..80cddfb2 100644 --- a/docs/reference/variables/useInitAnalytics.md +++ b/docs/reference/variables/useInitAnalytics.md @@ -8,4 +8,4 @@ > `const` **useInitAnalytics**: `InitSdkHook`\<`Analytics`\> -Defined in: [src/sdk.tsx:99](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L99) +Defined in: [src/sdk.tsx:99](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L99) diff --git a/docs/reference/variables/useInitAppCheck.md b/docs/reference/variables/useInitAppCheck.md index 7a350d58..810fc3f0 100644 --- a/docs/reference/variables/useInitAppCheck.md +++ b/docs/reference/variables/useInitAppCheck.md @@ -8,4 +8,4 @@ > `const` **useInitAppCheck**: `InitSdkHook`\<`AppCheck`\> -Defined in: [src/sdk.tsx:97](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L97) +Defined in: [src/sdk.tsx:97](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L97) diff --git a/docs/reference/variables/useInitAuth.md b/docs/reference/variables/useInitAuth.md index 2ffd8888..bd29275b 100644 --- a/docs/reference/variables/useInitAuth.md +++ b/docs/reference/variables/useInitAuth.md @@ -8,4 +8,4 @@ > `const` **useInitAuth**: `InitSdkHook`\<`Auth`\> -Defined in: [src/sdk.tsx:98](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L98) +Defined in: [src/sdk.tsx:98](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L98) diff --git a/docs/reference/variables/useInitDatabase.md b/docs/reference/variables/useInitDatabase.md index 7876835b..4bb0de18 100644 --- a/docs/reference/variables/useInitDatabase.md +++ b/docs/reference/variables/useInitDatabase.md @@ -8,4 +8,4 @@ > `const` **useInitDatabase**: `InitSdkHook`\<`Database`\> -Defined in: [src/sdk.tsx:100](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L100) +Defined in: [src/sdk.tsx:100](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L100) diff --git a/docs/reference/variables/useInitFirestore.md b/docs/reference/variables/useInitFirestore.md index 99025829..5ef24c7e 100644 --- a/docs/reference/variables/useInitFirestore.md +++ b/docs/reference/variables/useInitFirestore.md @@ -8,4 +8,4 @@ > `const` **useInitFirestore**: `InitSdkHook`\<`Firestore`\> -Defined in: [src/sdk.tsx:101](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L101) +Defined in: [src/sdk.tsx:101](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L101) diff --git a/docs/reference/variables/useInitFunctions.md b/docs/reference/variables/useInitFunctions.md index 4e6e085f..63c7eed4 100644 --- a/docs/reference/variables/useInitFunctions.md +++ b/docs/reference/variables/useInitFunctions.md @@ -8,4 +8,4 @@ > `const` **useInitFunctions**: `InitSdkHook`\<`Functions`\> -Defined in: [src/sdk.tsx:102](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L102) +Defined in: [src/sdk.tsx:102](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L102) diff --git a/docs/reference/variables/useInitPerformance.md b/docs/reference/variables/useInitPerformance.md index 9f804a55..150cdfdd 100644 --- a/docs/reference/variables/useInitPerformance.md +++ b/docs/reference/variables/useInitPerformance.md @@ -8,4 +8,4 @@ > `const` **useInitPerformance**: `InitSdkHook`\<`FirebasePerformance`\> -Defined in: [src/sdk.tsx:103](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L103) +Defined in: [src/sdk.tsx:103](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L103) diff --git a/docs/reference/variables/useInitRemoteConfig.md b/docs/reference/variables/useInitRemoteConfig.md index 8f8e89b3..f9871886 100644 --- a/docs/reference/variables/useInitRemoteConfig.md +++ b/docs/reference/variables/useInitRemoteConfig.md @@ -8,4 +8,4 @@ > `const` **useInitRemoteConfig**: `InitSdkHook`\<`RemoteConfig`\> -Defined in: [src/sdk.tsx:105](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L105) +Defined in: [src/sdk.tsx:105](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L105) diff --git a/docs/reference/variables/useInitStorage.md b/docs/reference/variables/useInitStorage.md index bd4c75b1..a38823da 100644 --- a/docs/reference/variables/useInitStorage.md +++ b/docs/reference/variables/useInitStorage.md @@ -8,4 +8,4 @@ > `const` **useInitStorage**: `InitSdkHook`\<`FirebaseStorage`\> -Defined in: [src/sdk.tsx:107](https://github.com/tyler-reitz/reactfire/blob/main/src/sdk.tsx#L107) +Defined in: [src/sdk.tsx:107](https://github.com/FirebaseExtended/reactfire/blob/main/src/sdk.tsx#L107) diff --git a/docs/reference/variables/version.md b/docs/reference/variables/version.md index bb7d0e99..35c34d90 100644 --- a/docs/reference/variables/version.md +++ b/docs/reference/variables/version.md @@ -8,4 +8,4 @@ > `const` **version**: `string` -Defined in: [src/firebaseApp.tsx:22](https://github.com/tyler-reitz/reactfire/blob/main/src/firebaseApp.tsx#L22) +Defined in: [src/firebaseApp.tsx:22](https://github.com/FirebaseExtended/reactfire/blob/main/src/firebaseApp.tsx#L22) From c6ddca89279603ee33369555ec56234e7e9fc01c Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 10:09:41 -0700 Subject: [PATCH 08/13] =?UTF-8?q?fix:=20correct=20upgrade=20guide=20retry?= =?UTF-8?q?=20note=20=E2=80=94=20remount=20rejoins=20cached=20error=20stat?= =?UTF-8?q?e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/upgrade-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md index d4f0b263..9aa85b8b 100644 --- a/docs/upgrade-guide.md +++ b/docs/upgrade-guide.md @@ -18,7 +18,7 @@ if (status === 'error') throw error; // re-throw to reach your Error Boundary **If you already check `status` before using `data`**, no change is needed. -Note: once an observable errors there is no automatic retry. If you need retry behavior, unmount and remount the component. +Note: once an observable errors there is no automatic retry. The errored observable remains in the global cache under its `observableId`, so unmounting and remounting the same component rejoins the same errored state. Today the only workaround is to change the `observableId`. A proper retry mechanism is tracked as a follow-up issue. --- From e021670813aaba62b656d22fdbaefe18a54929a0 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 10:19:15 -0700 Subject: [PATCH 09/13] test: remove storage error test pending Firebase SDK rejection investigation --- test/storage.test.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/storage.test.tsx b/test/storage.test.tsx index bfea2297..0c052f34 100644 --- a/test/storage.test.tsx +++ b/test/storage.test.tsx @@ -58,7 +58,7 @@ describe('Storage', () => { }); describe('useStorageDownloadURL', () => { - it('returns the same value as getDownloadURL', async () => { +it('returns the same value as getDownloadURL', async () => { const someBytes = Uint8Array.from(Buffer.from(new ArrayBuffer(500_000))); const testFileRef = ref(storage, `${randomString()}/${randomString()}.txt`); From 0971021f9ff6d421c85d3f2d39d5c2c38f75f62a Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 10:42:22 -0700 Subject: [PATCH 10/13] fix: wrap getDownloadURL in defer to prevent redundant eager requests on re-renders --- src/storage.tsx | 3 ++- test/storage.test.tsx | 9 ++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/storage.tsx b/src/storage.tsx index 5a0299da..ea4e483f 100644 --- a/src/storage.tsx +++ b/src/storage.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import { getDownloadURL, fromTask } from 'rxfire/storage'; +import { defer } from 'rxjs'; import { ReactFireOptions, useObservable, ObservableStatus, useStorage } from './'; import { useSuspenseEnabledFromConfigAndContext } from './firebaseApp'; import { ref } from 'firebase/storage'; @@ -28,7 +29,7 @@ export function useStorageTask(task: UploadTask, ref: StorageRefere */ export function useStorageDownloadURL(ref: StorageReference, options?: ReactFireOptions): ObservableStatus { const observableId = `storage:downloadUrl:${ref.toString()}`; - const observable$ = getDownloadURL(ref); + const observable$ = defer(() => getDownloadURL(ref)); return useObservable(observableId, observable$, options); } diff --git a/test/storage.test.tsx b/test/storage.test.tsx index 0c052f34..ee331529 100644 --- a/test/storage.test.tsx +++ b/test/storage.test.tsx @@ -58,7 +58,14 @@ describe('Storage', () => { }); describe('useStorageDownloadURL', () => { -it('returns the same value as getDownloadURL', async () => { + it('surfaces storage/object-not-found as status: error for a nonexistent file', async () => { + const missingRef = ref(storage, `nonexistent/${randomString()}.txt`); + const { result } = renderHook(() => useStorageDownloadURL(missingRef), { wrapper: Provider }); + await waitFor(() => expect(result.current.status).toEqual('error')); + expect((result.current.error as any)?.code).toEqual('storage/object-not-found'); + }); + + it('returns the same value as getDownloadURL', async () => { const someBytes = Uint8Array.from(Buffer.from(new ArrayBuffer(500_000))); const testFileRef = ref(storage, `${randomString()}/${randomString()}.txt`); From 7286c57fee7652cf39190e417918ae399c4b8984 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 10:52:35 -0700 Subject: [PATCH 11/13] refactor: remove redundant isComplete override from ObservableStatusError --- src/useObservable.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/useObservable.ts b/src/useObservable.ts index 32af48b8..f98a2e1b 100644 --- a/src/useObservable.ts +++ b/src/useObservable.ts @@ -71,7 +71,6 @@ export interface ObservableStatusSuccess extends ObservableStatusBase { export interface ObservableStatusError extends ObservableStatusBase { status: 'error'; - isComplete: boolean; error: Error; } From 11286bf255821d403cc674685e68b2d6c4b41a64 Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 10:56:45 -0700 Subject: [PATCH 12/13] chore: regenerate reference docs --- docs/reference/functions/StorageImage.md | 2 +- docs/reference/functions/useObservable.md | 2 +- docs/reference/functions/useStorageDownloadURL.md | 2 +- docs/reference/functions/useStorageTask.md | 2 +- docs/reference/interfaces/ObservableStatusError.md | 6 +++--- docs/reference/interfaces/ObservableStatusLoading.md | 8 ++++---- docs/reference/type-aliases/ObservableStatus.md | 2 +- docs/reference/type-aliases/StorageImageProps.md | 10 +++++----- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/reference/functions/StorageImage.md b/docs/reference/functions/StorageImage.md index 24370e02..ea871ad4 100644 --- a/docs/reference/functions/StorageImage.md +++ b/docs/reference/functions/StorageImage.md @@ -8,7 +8,7 @@ > **StorageImage**(`props`): `Element` -Defined in: [src/storage.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L78) +Defined in: [src/storage.tsx:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L79) ## Parameters diff --git a/docs/reference/functions/useObservable.md b/docs/reference/functions/useObservable.md index 0044586e..996ab327 100644 --- a/docs/reference/functions/useObservable.md +++ b/docs/reference/functions/useObservable.md @@ -8,7 +8,7 @@ > **useObservable**\<`T`\>(`observableId`, `source`, `config?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T`\> -Defined in: [src/useObservable.ts:97](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L97) +Defined in: [src/useObservable.ts:96](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L96) Subscribe to an Observable and return its current status. diff --git a/docs/reference/functions/useStorageDownloadURL.md b/docs/reference/functions/useStorageDownloadURL.md index 2ab6fb3d..725952be 100644 --- a/docs/reference/functions/useStorageDownloadURL.md +++ b/docs/reference/functions/useStorageDownloadURL.md @@ -8,7 +8,7 @@ > **useStorageDownloadURL**\<`T`\>(`ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`string` \| `T`\> -Defined in: [src/storage.tsx:29](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L29) +Defined in: [src/storage.tsx:30](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L30) Subscribe to a storage ref's download URL diff --git a/docs/reference/functions/useStorageTask.md b/docs/reference/functions/useStorageTask.md index 2d462c71..99e494dc 100644 --- a/docs/reference/functions/useStorageTask.md +++ b/docs/reference/functions/useStorageTask.md @@ -8,7 +8,7 @@ > **useStorageTask**\<`T`\>(`task`, `ref`, `options?`): [`ObservableStatus`](../type-aliases/ObservableStatus.md)\<`T` \| `UploadTaskSnapshot`\> -Defined in: [src/storage.tsx:16](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L16) +Defined in: [src/storage.tsx:17](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L17) Subscribe to the progress of a storage task diff --git a/docs/reference/interfaces/ObservableStatusError.md b/docs/reference/interfaces/ObservableStatusError.md index 9d1f0f3e..87977b77 100644 --- a/docs/reference/interfaces/ObservableStatusError.md +++ b/docs/reference/interfaces/ObservableStatusError.md @@ -40,7 +40,7 @@ If `initialData` is passed in, the first value of `data` will be the valuea prov > **error**: `Error` -Defined in: [src/useObservable.ts:75](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L75) +Defined in: [src/useObservable.ts:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L74) Any error that may have occurred in the underlying observable @@ -84,11 +84,11 @@ If `initialData` is passed in, this will be `true`. > **isComplete**: `boolean` -Defined in: [src/useObservable.ts:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L74) +Defined in: [src/useObservable.ts:50](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L50) If this is `true`, the hook will be emitting no further items. -#### Overrides +#### Inherited from `ObservableStatusBase.isComplete` diff --git a/docs/reference/interfaces/ObservableStatusLoading.md b/docs/reference/interfaces/ObservableStatusLoading.md index f0bf2fcd..4744410c 100644 --- a/docs/reference/interfaces/ObservableStatusLoading.md +++ b/docs/reference/interfaces/ObservableStatusLoading.md @@ -6,7 +6,7 @@ # Interface: ObservableStatusLoading\ -Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L78) +Defined in: [src/useObservable.ts:77](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L77) ## Extends @@ -24,7 +24,7 @@ Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactf > **data**: `undefined` -Defined in: [src/useObservable.ts:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L80) +Defined in: [src/useObservable.ts:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L79) The most recent value. @@ -68,7 +68,7 @@ Promise that resolves after first emit from observable > **hasEmitted**: `false` -Defined in: [src/useObservable.ts:81](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L81) +Defined in: [src/useObservable.ts:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L80) Indicates whether the hook has emitted a value at some point @@ -98,7 +98,7 @@ If this is `true`, the hook will be emitting no further items. > **status**: `"loading"` -Defined in: [src/useObservable.ts:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L79) +Defined in: [src/useObservable.ts:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L78) The loading status. diff --git a/docs/reference/type-aliases/ObservableStatus.md b/docs/reference/type-aliases/ObservableStatus.md index bbf0276d..013ad25b 100644 --- a/docs/reference/type-aliases/ObservableStatus.md +++ b/docs/reference/type-aliases/ObservableStatus.md @@ -8,7 +8,7 @@ > **ObservableStatus**\<`T`\> = [`ObservableStatusLoading`](../interfaces/ObservableStatusLoading.md)\<`T`\> \| [`ObservableStatusError`](../interfaces/ObservableStatusError.md)\<`T`\> \| [`ObservableStatusSuccess`](../interfaces/ObservableStatusSuccess.md)\<`T`\> -Defined in: [src/useObservable.ts:84](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L84) +Defined in: [src/useObservable.ts:83](https://github.com/FirebaseExtended/reactfire/blob/main/src/useObservable.ts#L83) ## Type Parameters diff --git a/docs/reference/type-aliases/StorageImageProps.md b/docs/reference/type-aliases/StorageImageProps.md index b75fa337..f1206d9b 100644 --- a/docs/reference/type-aliases/StorageImageProps.md +++ b/docs/reference/type-aliases/StorageImageProps.md @@ -8,7 +8,7 @@ > **StorageImageProps** = `object` -Defined in: [src/storage.tsx:36](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L36) +Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L37) ## Properties @@ -16,7 +16,7 @@ Defined in: [src/storage.tsx:36](https://github.com/FirebaseExtended/reactfire/b > `optional` **placeHolder?**: `React.ReactNode` -Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L40) +Defined in: [src/storage.tsx:41](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L41) *** @@ -24,7 +24,7 @@ Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/b > `optional` **storage?**: `FirebaseStorage` -Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L38) +Defined in: [src/storage.tsx:39](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L39) *** @@ -32,7 +32,7 @@ Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/b > **storagePath**: `string` -Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L37) +Defined in: [src/storage.tsx:38](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L38) *** @@ -40,4 +40,4 @@ Defined in: [src/storage.tsx:37](https://github.com/FirebaseExtended/reactfire/b > `optional` **suspense?**: `boolean` -Defined in: [src/storage.tsx:39](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L39) +Defined in: [src/storage.tsx:40](https://github.com/FirebaseExtended/reactfire/blob/main/src/storage.tsx#L40) From 0fde812f19d0f132bdf20297fbfb72d987431efd Mon Sep 17 00:00:00 2001 From: Tyler Dixon Date: Thu, 16 Jul 2026 11:05:28 -0700 Subject: [PATCH 13/13] test: add FirebaseAppProvider suspense context path error test --- test/useObservable.test.tsx | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/test/useObservable.test.tsx b/test/useObservable.test.tsx index 3149efbd..b841e428 100644 --- a/test/useObservable.test.tsx +++ b/test/useObservable.test.tsx @@ -2,7 +2,9 @@ import '@testing-library/jest-dom/extend-expect'; import { act, cleanup, render, renderHook, waitFor } from '@testing-library/react'; import * as React from 'react'; import { of, Subject, BehaviorSubject, throwError } from 'rxjs'; -import { useObservable } from '../src/index'; +import { useObservable, FirebaseAppProvider } from '../src/index'; +import { initializeApp } from 'firebase/app'; +import { baseConfig } from './appConfig'; describe('useObservable', () => { afterEach(cleanup); @@ -364,5 +366,23 @@ describe('useObservable', () => { // if useObservable doesn't re-emit, the value here will still be "Jeff" expect(refreshedComp).toHaveTextContent('James'); }); + it('throws an error via FirebaseAppProvider suspense context path', () => { + const spy = vi.spyOn(console, 'error'); + spy.mockImplementation(() => {}); + + const app = initializeApp(baseConfig, 'suspense-context-test'); + const error = new Error('context-path error'); + const observable$ = throwError(error); + + const wrapper = ({ children }: { children: React.ReactNode }) => ( + + {children} + + ); + + expect(() => renderHook(() => useObservable('test-context-suspense-error', observable$), { wrapper })).toThrow(error); + + spy.mockRestore(); + }); }); });