From d1da698c3d8aaaff65544979993aa412e6a3ea0f Mon Sep 17 00:00:00 2001 From: Victor Pishuk Date: Mon, 31 Mar 2025 23:43:04 -0400 Subject: [PATCH] feat(react-native): improves interface for composite filters --- docs/modules.md | 2 +- .../analytics/functions/useAnalytics.md | 2 +- .../analytics/functions/useLogEvent.md | 2 +- .../useSetAnalyticsCollectionEnabled.md | 2 +- docs/react-native/auth/functions/useAuth.md | 2 +- .../auth/functions/useAuthStateReady.md | 25 +++++ ...seCreateUserWitEmailAndPasswordMutation.md | 2 +- .../auth/functions/useCurrentUser.md | 2 +- .../react-native/auth/functions/useIdToken.md | 2 +- .../useReauthenticateWitCredentialMutation.md | 2 +- .../useReauthenticateWitRedirectMutation.md | 2 +- .../useSendEmailVerificationMutation.md | 2 +- .../useSignInWitEmailAndPasswordMutation.md | 2 +- .../functions/useSignInWitRedirectMutation.md | 2 +- .../auth/functions/useSignOutMutation.md | 2 +- .../functions/useUpdateProfileMutation.md | 2 +- docs/react-native/auth/index.md | 1 + ...serWitEmailAndPasswordMutationVariables.md | 6 +- .../auth/type-aliases/UseIdTokenResult.md | 6 +- ...henticateWitCredentialMutationVariables.md | 6 +- ...uthenticateWitRedirectMutationVariables.md | 8 +- ...eSendEmailVerificationMutationVariables.md | 4 +- ...nInWitEmailAndPasswordMutationVariables.md | 6 +- .../UseSignInWitRedirectMutationVariables.md | 6 +- .../UseUpdateProfileMutationVariables.md | 6 +- ...ER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md | 2 +- ...THENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md | 2 +- ...AUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md | 2 +- .../SEND_EMAIL_VERIFICATION_MUTATION_KEY.md | 2 +- ...IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md | 2 +- .../SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md | 2 +- .../auth/variables/SIGN_OUT_MUTATION_KEY.md | 2 +- .../functions/buildCompositeFilter.md | 40 +++++--- .../functions/buildQueryConstraint.md | 2 +- .../firestore/functions/useAddDocMutation.md | 2 +- .../firestore/functions/useBatchWrite.md | 2 +- .../functions/useCollectionReference.md | 2 +- .../firestore/functions/useCompositeFilter.md | 42 +++++--- .../firestore/functions/useCountQuery.md | 47 +++++++-- .../functions/useDeleteDocMutation.md | 2 +- .../firestore/functions/useDocReference.md | 2 +- .../firestore/functions/useDocReferences.md | 2 +- .../firestore/functions/useFirestore.md | 2 +- .../firestore/functions/useGetDocData.md | 2 +- .../functions/useGetRealtimeDocData.md | 2 +- .../firestore/functions/useInfiniteQuery.md | 59 ++++++++++-- .../firestore/functions/useQuery.md | 55 +++++++++-- .../functions/useQueryConstraints.md | 2 +- .../firestore/functions/useRunTransaction.md | 2 +- .../firestore/functions/useSetDocMutation.md | 2 +- .../functions/useUpdateDocMutation.md | 2 +- docs/react-native/firestore/index.md | 11 ++- .../firestore/type-aliases/CompositeFilter.md | 16 ++-- .../firestore/type-aliases/QueryElement.md | 24 ++--- .../type-aliases/QueryFilterConstraint.md | 11 +++ .../type-aliases/UseAddDocMutationOptions.md | 6 +- .../type-aliases/UseAddDocMutationValues.md | 4 +- .../type-aliases/UseBatchWriteOptions.md | 4 +- .../type-aliases/UseBatchWriteVariables.md | 2 +- .../UseCollectionReferenceOptions.md | 8 +- .../type-aliases/UseCompositeFilter.md | 14 +-- .../UseDeleteDocMutationOptions.md | 6 +- .../UseDeleteDocMutationValues.md | 4 +- .../type-aliases/UseDocReferenceOptions.md | 8 +- .../type-aliases/UseDocReferencesOptions.md | 8 +- .../UseGetRealtimeDocDataOptions.md | 10 +- .../UseGetRealtimeDocDataResult.md | 10 +- .../type-aliases/UseQueryConstraints.md | 4 +- .../type-aliases/UseRunTransactionOptions.md | 4 +- .../type-aliases/UseRunTransactionValues.md | 2 +- .../type-aliases/UseSetDocMutationOptions.md | 6 +- .../type-aliases/UseSetDocMutationValues.md | 4 +- .../UseUpdateDocMutationOptions.md | 6 +- .../UseUpdateDocMutationValues.md | 4 +- .../functions/useFetchAndActivate.md | 2 +- .../remoteConfig/functions/useGetValue.md | 2 +- .../remoteConfig/functions/useRemoteConfig.md | 2 +- ...rebaseContextProviderAuthEmulatorConfig.md | 4 +- .../FirebaseContextProviderEmulators.md | 6 +- ...eContextProviderFirestoreEmulatorConfig.md | 6 +- .../FirebaseContextProviderProps.md | 12 +-- .../type-aliases/FirestoreSettings.md | 18 ++-- .../variables/FirebaseContextProvider.md | 3 +- docs/typedoc-sidebar.json | 2 +- docs/types/type-aliases/AppModel.md | 2 +- docs/types/type-aliases/EndConstraint.md | 8 +- docs/types/type-aliases/LimitConstraint.md | 6 +- .../type-aliases/NonFilterQueryConstraint.md | 2 +- docs/types/type-aliases/OrderByConstraint.md | 8 +- docs/types/type-aliases/StartConstraint.md | 6 +- docs/web/analytics/functions/useAnalytics.md | 2 +- docs/web/analytics/functions/useLogEvent.md | 2 +- .../useSetAnalyticsCollectionEnabled.md | 2 +- docs/web/auth/functions/useAuth.md | 2 +- docs/web/auth/functions/useAuthStateReady.md | 11 ++- ...seCreateUserWitEmailAndPasswordMutation.md | 2 +- docs/web/auth/functions/useCurrentUser.md | 2 +- docs/web/auth/functions/useIdToken.md | 2 +- .../useReauthenticateWitCredentialMutation.md | 2 +- .../useReauthenticateWitRedirectMutation.md | 2 +- .../useSendEmailVerificationMutation.md | 2 +- .../useSignInWitEmailAndPasswordMutation.md | 2 +- .../functions/useSignInWitRedirectMutation.md | 2 +- docs/web/auth/functions/useSignOutMutation.md | 2 +- .../functions/useUpdateProfileMutation.md | 2 +- docs/web/auth/index.md | 2 +- ...serWitEmailAndPasswordMutationVariables.md | 6 +- .../web/auth/type-aliases/UseIdTokenResult.md | 6 +- ...henticateWitCredentialMutationVariables.md | 6 +- ...uthenticateWitRedirectMutationVariables.md | 8 +- ...eSendEmailVerificationMutationVariables.md | 4 +- ...nInWitEmailAndPasswordMutationVariables.md | 6 +- .../UseSignInWitRedirectMutationVariables.md | 6 +- .../UseUpdateProfileMutationVariables.md | 6 +- ...ER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md | 2 +- ...THENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md | 2 +- ...AUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md | 2 +- .../SEND_EMAIL_VERIFICATION_MUTATION_KEY.md | 2 +- ...IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md | 2 +- .../SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md | 2 +- .../auth/variables/SIGN_OUT_MUTATION_KEY.md | 2 +- .../functions/buildCompositeFilter.md | 40 +++++--- .../functions/buildQueryConstraint.md | 2 +- .../firestore/functions/useAddDocMutation.md | 2 +- docs/web/firestore/functions/useBatchWrite.md | 2 +- .../functions/useCollectionReference.md | 2 +- .../firestore/functions/useCompositeFilter.md | 35 +++++-- docs/web/firestore/functions/useCountQuery.md | 49 ++++++++-- .../functions/useDeleteDocMutation.md | 2 +- .../firestore/functions/useDocReference.md | 2 +- .../firestore/functions/useDocReferences.md | 2 +- docs/web/firestore/functions/useFirestore.md | 2 +- docs/web/firestore/functions/useGetDocData.md | 2 +- .../functions/useGetRealtimeDocData.md | 2 +- .../firestore/functions/useInfiniteQuery.md | 55 +++++++++-- docs/web/firestore/functions/useQuery.md | 57 ++++++++--- .../functions/useQueryConstraints.md | 2 +- .../firestore/functions/useRunTransaction.md | 2 +- .../firestore/functions/useSetDocMutation.md | 2 +- .../functions/useUpdateDocMutation.md | 2 +- docs/web/firestore/index.md | 11 ++- .../firestore/type-aliases/CompositeFilter.md | 16 ++-- .../firestore/type-aliases/QueryElement.md | 24 ++--- .../type-aliases/QueryFilterConstraint.md | 9 ++ .../type-aliases/UseAddDocMutationOptions.md | 8 +- .../type-aliases/UseAddDocMutationValues.md | 4 +- .../type-aliases/UseBatchWriteOptions.md | 4 +- .../type-aliases/UseBatchWriteVariables.md | 2 +- .../UseCollectionReferenceOptions.md | 8 +- .../type-aliases/UseCompositeFilter.md | 14 +-- .../UseDeleteDocMutationOptions.md | 6 +- .../UseDeleteDocMutationValues.md | 4 +- .../type-aliases/UseDocReferenceOptions.md | 8 +- .../type-aliases/UseDocReferencesOptions.md | 8 +- .../UseGetRealtimeDocDataOptions.md | 10 +- .../UseGetRealtimeDocDataResult.md | 10 +- .../type-aliases/UseQueryConstraints.md | 4 +- .../type-aliases/UseRunTransactionOptions.md | 4 +- .../type-aliases/UseRunTransactionValues.md | 2 +- .../type-aliases/UseSetDocMutationOptions.md | 6 +- .../type-aliases/UseSetDocMutationValues.md | 4 +- .../UseUpdateDocMutationOptions.md | 8 +- .../UseUpdateDocMutationValues.md | 4 +- .../functions/useFetchAndActivate.md | 2 +- .../web/remoteConfig/functions/useGetValue.md | 2 +- .../remoteConfig/functions/useRemoteConfig.md | 2 +- ...rebaseContextProviderAuthEmulatorConfig.md | 4 +- .../FirebaseContextProviderEmulators.md | 6 +- ...eContextProviderFirestoreEmulatorConfig.md | 6 +- .../FirebaseContextProviderProps.md | 2 +- docs/web/variables/FirebaseContextProvider.md | 2 +- react-native/firestore/useCompositeFilter.ts | 95 +++++++++++++----- react-native/firestore/useCountQuery.ts | 52 +++++++--- react-native/firestore/useInfiniteQuery.ts | 55 +++++++++-- react-native/firestore/useQuery.ts | 54 ++++++++--- web/firestore/useCompositeFilter.ts | 96 ++++++++++++++----- web/firestore/useCountQuery.ts | 63 ++++++++---- web/firestore/useInfiniteQuery.ts | 74 +++++++++----- web/firestore/useQuery.ts | 76 +++++++++------ 179 files changed, 1190 insertions(+), 600 deletions(-) create mode 100644 docs/react-native/auth/functions/useAuthStateReady.md create mode 100644 docs/react-native/firestore/type-aliases/QueryFilterConstraint.md create mode 100644 docs/web/firestore/type-aliases/QueryFilterConstraint.md diff --git a/docs/modules.md b/docs/modules.md index 52637a6..cba3aae 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -1,4 +1,4 @@ -# react-query-firebase v2.0.3 +# react-query-firebase v2.1.4 ## Modules diff --git a/docs/react-native/analytics/functions/useAnalytics.md b/docs/react-native/analytics/functions/useAnalytics.md index c0946db..2755ca9 100644 --- a/docs/react-native/analytics/functions/useAnalytics.md +++ b/docs/react-native/analytics/functions/useAnalytics.md @@ -6,7 +6,7 @@ function useAnalytics(): Module ``` -Defined in: [react-native/analytics/useAnalytics.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/analytics/useAnalytics.ts#L9) +Defined in: [react-native/analytics/useAnalytics.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/analytics/useAnalytics.ts#L9) Hook to access Firebase analytics from the Firebase context. diff --git a/docs/react-native/analytics/functions/useLogEvent.md b/docs/react-native/analytics/functions/useLogEvent.md index fc21ab8..7ef0c76 100644 --- a/docs/react-native/analytics/functions/useLogEvent.md +++ b/docs/react-native/analytics/functions/useLogEvent.md @@ -6,7 +6,7 @@ function useLogEvent(options): object ``` -Defined in: [react-native/analytics/useLogEvent.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/analytics/useLogEvent.ts#L19) +Defined in: [react-native/analytics/useLogEvent.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/analytics/useLogEvent.ts#L19) Custom hook to create a log event function that logs an analytics event with specified parameters. diff --git a/docs/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md b/docs/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md index 809440e..1284ac3 100644 --- a/docs/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md +++ b/docs/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md @@ -6,7 +6,7 @@ function useSetAnalyticsCollectionEnabled(options): void ``` -Defined in: [react-native/analytics/useSetAnalyticsCollectionEnabled.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/analytics/useSetAnalyticsCollectionEnabled.ts#L14) +Defined in: [react-native/analytics/useSetAnalyticsCollectionEnabled.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/analytics/useSetAnalyticsCollectionEnabled.ts#L14) Custom hook to enable or disable analytics collection diff --git a/docs/react-native/auth/functions/useAuth.md b/docs/react-native/auth/functions/useAuth.md index ac21f0a..0b68500 100644 --- a/docs/react-native/auth/functions/useAuth.md +++ b/docs/react-native/auth/functions/useAuth.md @@ -6,7 +6,7 @@ function useAuth(): Module ``` -Defined in: [react-native/auth/useAuth.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useAuth.ts#L9) +Defined in: [react-native/auth/useAuth.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useAuth.ts#L9) Custom hook to retrieve the authentication object from the Firebase context. diff --git a/docs/react-native/auth/functions/useAuthStateReady.md b/docs/react-native/auth/functions/useAuthStateReady.md new file mode 100644 index 0000000..83ea625 --- /dev/null +++ b/docs/react-native/auth/functions/useAuthStateReady.md @@ -0,0 +1,25 @@ +[react-query-firebase](../../../modules.md) / [react-native/auth](../index.md) / useAuthStateReady + +# Function: useAuthStateReady() + +```ts +function useAuthStateReady(): boolean +``` + +Defined in: [react-native/auth/useAuthStateReady.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useAuthStateReady.ts#L20) + +A custom hook that determines if the Firebase authentication state is ready. +It uses Firebase authentication to check if the auth state is ready and updates the state accordingly. + +## Returns + +`boolean` + +## Example + +```jsx +export const MyComponent = () => { + const isAuthStateReady = useAuthStateReady(); + console.log(isAuthStateReady); +}; +``` diff --git a/docs/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md b/docs/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md index f51293d..d628aed 100644 --- a/docs/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md +++ b/docs/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md @@ -6,7 +6,7 @@ function useCreateUserWitEmailAndPasswordMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L19) +Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L19) Custom hook to initiate a user creation process using email and password with Firebase authentication. This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously. diff --git a/docs/react-native/auth/functions/useCurrentUser.md b/docs/react-native/auth/functions/useCurrentUser.md index 642f07c..a643e64 100644 --- a/docs/react-native/auth/functions/useCurrentUser.md +++ b/docs/react-native/auth/functions/useCurrentUser.md @@ -6,7 +6,7 @@ function useCurrentUser(): null | User ``` -Defined in: [react-native/auth/useCurrentUser.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useCurrentUser.ts#L9) +Defined in: [react-native/auth/useCurrentUser.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useCurrentUser.ts#L9) Hook that provides the current authenticated user from Firebase Auth. It listens for changes in the authentication state and updates the user accordingly. diff --git a/docs/react-native/auth/functions/useIdToken.md b/docs/react-native/auth/functions/useIdToken.md index 603461f..fcb079b 100644 --- a/docs/react-native/auth/functions/useIdToken.md +++ b/docs/react-native/auth/functions/useIdToken.md @@ -6,7 +6,7 @@ function useIdToken(): object ``` -Defined in: [react-native/auth/useIdToken.ts:36](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useIdToken.ts#L36) +Defined in: [react-native/auth/useIdToken.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useIdToken.ts#L36) A hook to manage the ID token. It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed. diff --git a/docs/react-native/auth/functions/useReauthenticateWitCredentialMutation.md b/docs/react-native/auth/functions/useReauthenticateWitCredentialMutation.md index be2896d..dd66b55 100644 --- a/docs/react-native/auth/functions/useReauthenticateWitCredentialMutation.md +++ b/docs/react-native/auth/functions/useReauthenticateWitCredentialMutation.md @@ -6,7 +6,7 @@ function useReauthenticateWitCredentialMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitCredentialMutation.ts#L19) +Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitCredentialMutation.ts#L19) Custom hook to create a mutation for re-authenticating a user with a given credential. This hook utilizes useMutation from React Query to manage the asynchronous re-authentication diff --git a/docs/react-native/auth/functions/useReauthenticateWitRedirectMutation.md b/docs/react-native/auth/functions/useReauthenticateWitRedirectMutation.md index d6ea624..4e200b4 100644 --- a/docs/react-native/auth/functions/useReauthenticateWitRedirectMutation.md +++ b/docs/react-native/auth/functions/useReauthenticateWitRedirectMutation.md @@ -6,7 +6,7 @@ function useReauthenticateWitRedirectMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:21](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitRedirectMutation.ts#L21) +Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:21](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitRedirectMutation.ts#L21) Custom hook that provides a mutation to reauthenticate a user with a given authentication provider using redirection. This hook uses the `useMutation` hook from the React Query library to handle async mutation logic. diff --git a/docs/react-native/auth/functions/useSendEmailVerificationMutation.md b/docs/react-native/auth/functions/useSendEmailVerificationMutation.md index 4d067d5..baacb9b 100644 --- a/docs/react-native/auth/functions/useSendEmailVerificationMutation.md +++ b/docs/react-native/auth/functions/useSendEmailVerificationMutation.md @@ -6,7 +6,7 @@ function useSendEmailVerificationMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSendEmailVerificationMutation.ts#L17) +Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSendEmailVerificationMutation.ts#L17) A custom hook to create a mutation for sending an email verification to a user using Firebase. This uses the `useMutation` hook from a query library and wraps it with specific configuration options. diff --git a/docs/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md b/docs/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md index 115cb63..5a1673b 100644 --- a/docs/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md +++ b/docs/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md @@ -6,7 +6,7 @@ function useSignInWitEmailAndPasswordMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L20) +Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L20) Custom hook to perform a sign-in operation using email and password with Firebase Authentication. It utilizes the `useMutation` hook to manage the asynchronous operation and its state. diff --git a/docs/react-native/auth/functions/useSignInWitRedirectMutation.md b/docs/react-native/auth/functions/useSignInWitRedirectMutation.md index 723dcb1..c1151c0 100644 --- a/docs/react-native/auth/functions/useSignInWitRedirectMutation.md +++ b/docs/react-native/auth/functions/useSignInWitRedirectMutation.md @@ -6,7 +6,7 @@ function useSignInWitRedirectMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitRedirectMutation.ts#L19) +Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitRedirectMutation.ts#L19) Custom hook for handling Firebase authentication using sign-in with redirect functionality. This hook utilizes the `useMutation` mechanism to perform the sign-in operation. diff --git a/docs/react-native/auth/functions/useSignOutMutation.md b/docs/react-native/auth/functions/useSignOutMutation.md index ff4ea82..45457e3 100644 --- a/docs/react-native/auth/functions/useSignOutMutation.md +++ b/docs/react-native/auth/functions/useSignOutMutation.md @@ -6,7 +6,7 @@ function useSignOutMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useSignOutMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignOutMutation.ts#L15) +Defined in: [react-native/auth/useSignOutMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignOutMutation.ts#L15) Custom hook for handling the sign-out mutation using Firebase authentication. It wraps the useMutation hook to provide a sign-out function with Firebase. diff --git a/docs/react-native/auth/functions/useUpdateProfileMutation.md b/docs/react-native/auth/functions/useUpdateProfileMutation.md index d7f0a1f..54ef3ba 100644 --- a/docs/react-native/auth/functions/useUpdateProfileMutation.md +++ b/docs/react-native/auth/functions/useUpdateProfileMutation.md @@ -6,7 +6,7 @@ function useUpdateProfileMutation(options): UseMutationResult ``` -Defined in: [react-native/auth/useUpdateProfileMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useUpdateProfileMutation.ts#L18) +Defined in: [react-native/auth/useUpdateProfileMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useUpdateProfileMutation.ts#L18) Custom hook to manage the mutation for updating a user's profile. Utilizes Firebase for updating the user's display name. diff --git a/docs/react-native/auth/index.md b/docs/react-native/auth/index.md index 69c26bb..201e0d5 100644 --- a/docs/react-native/auth/index.md +++ b/docs/react-native/auth/index.md @@ -38,4 +38,5 @@ ## Hook +- [useAuthStateReady](functions/useAuthStateReady.md) - [useIdToken](functions/useIdToken.md) diff --git a/docs/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md b/docs/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md index 2d50a21..4929692 100644 --- a/docs/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md @@ -6,7 +6,7 @@ type UseCreateUserWitEmailAndPasswordMutationVariables = object; ``` -Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L7) +Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L7) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](ht email: string; ``` -Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L8) +Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L8) *** @@ -26,4 +26,4 @@ Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](ht password: string; ``` -Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L9) +Defined in: [react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useCreateUserWitEmailAndPasswordMutation.ts#L9) diff --git a/docs/react-native/auth/type-aliases/UseIdTokenResult.md b/docs/react-native/auth/type-aliases/UseIdTokenResult.md index ffab3e2..9f68658 100644 --- a/docs/react-native/auth/type-aliases/UseIdTokenResult.md +++ b/docs/react-native/auth/type-aliases/UseIdTokenResult.md @@ -6,7 +6,7 @@ type UseIdTokenResult = object; ``` -Defined in: [react-native/auth/useIdToken.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useIdToken.ts#L9) +Defined in: [react-native/auth/useIdToken.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useIdToken.ts#L9) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useIdToken.ts:9](https://github.com/vpishuk/react idToken: string; ``` -Defined in: [react-native/auth/useIdToken.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useIdToken.ts#L10) +Defined in: [react-native/auth/useIdToken.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useIdToken.ts#L10) *** @@ -26,7 +26,7 @@ Defined in: [react-native/auth/useIdToken.ts:10](https://github.com/vpishuk/reac refresh: () => Promise; ``` -Defined in: [react-native/auth/useIdToken.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useIdToken.ts#L11) +Defined in: [react-native/auth/useIdToken.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useIdToken.ts#L11) #### Returns diff --git a/docs/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md b/docs/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md index 7038486..31fc530 100644 --- a/docs/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md @@ -6,7 +6,7 @@ type UseReauthenticateWitCredentialMutationVariables = object; ``` -Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitCredentialMutation.ts#L6) +Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitCredentialMutation.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:6](http credential: FirebaseAuthTypes.AuthCredential; ``` -Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitCredentialMutation.ts#L7) +Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitCredentialMutation.ts#L7) *** @@ -26,4 +26,4 @@ Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:7](http user: FirebaseAuthTypes.User; ``` -Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitCredentialMutation.ts#L8) +Defined in: [react-native/auth/useReauthenticateWitCredentialMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitCredentialMutation.ts#L8) diff --git a/docs/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md b/docs/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md index de3ff4b..d032560 100644 --- a/docs/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md @@ -6,7 +6,7 @@ type UseReauthenticateWitRedirectMutationVariables = object; ``` -Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitRedirectMutation.ts#L7) +Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitRedirectMutation.ts#L7) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:7](https: authProvider: FirebaseAuthTypes.AuthProvider; ``` -Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitRedirectMutation.ts#L8) +Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitRedirectMutation.ts#L8) *** @@ -26,7 +26,7 @@ Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:8](https: optional popupRedirectResolver: PopupRedirectResolver; ``` -Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitRedirectMutation.ts#L9) +Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitRedirectMutation.ts#L9) *** @@ -36,4 +36,4 @@ Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:9](https: user: FirebaseAuthTypes.User; ``` -Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useReauthenticateWitRedirectMutation.ts#L10) +Defined in: [react-native/auth/useReauthenticateWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useReauthenticateWitRedirectMutation.ts#L10) diff --git a/docs/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md b/docs/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md index 0727c75..d1bcddb 100644 --- a/docs/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md @@ -6,7 +6,7 @@ type UseSendEmailVerificationMutationVariables = object; ``` -Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSendEmailVerificationMutation.ts#L7) +Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSendEmailVerificationMutation.ts#L7) ## Properties @@ -16,4 +16,4 @@ Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:7](https://gi user: FirebaseAuthTypes.User; ``` -Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSendEmailVerificationMutation.ts#L8) +Defined in: [react-native/auth/useSendEmailVerificationMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSendEmailVerificationMutation.ts#L8) diff --git a/docs/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md b/docs/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md index 0e41f02..7575cef 100644 --- a/docs/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md @@ -6,7 +6,7 @@ type UseSignInWitEmailAndPasswordMutationVariables = object; ``` -Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L8) +Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L8) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:8](https: email: string; ``` -Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L9) +Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L9) *** @@ -26,4 +26,4 @@ Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:9](https: password: string; ``` -Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L10) +Defined in: [react-native/auth/useSignInWitEmailAndPasswordMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitEmailAndPasswordMutation.ts#L10) diff --git a/docs/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md b/docs/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md index e6c06fb..39f667e 100644 --- a/docs/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md @@ -6,7 +6,7 @@ type UseSignInWitRedirectMutationVariables = object; ``` -Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitRedirectMutation.ts#L8) +Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitRedirectMutation.ts#L8) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:8](https://github authProvider: FirebaseAuthTypes.AuthProvider; ``` -Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitRedirectMutation.ts#L9) +Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitRedirectMutation.ts#L9) *** @@ -26,4 +26,4 @@ Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:9](https://github optional popupRedirectResolver: PopupRedirectResolver; ``` -Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useSignInWitRedirectMutation.ts#L10) +Defined in: [react-native/auth/useSignInWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useSignInWitRedirectMutation.ts#L10) diff --git a/docs/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md b/docs/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md index 9c9cd04..b44cd01 100644 --- a/docs/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md +++ b/docs/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md @@ -6,7 +6,7 @@ type UseUpdateProfileMutationVariables = object; ``` -Defined in: [react-native/auth/useUpdateProfileMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useUpdateProfileMutation.ts#L6) +Defined in: [react-native/auth/useUpdateProfileMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useUpdateProfileMutation.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/auth/useUpdateProfileMutation.ts:6](https://github.com optional displayName: string; ``` -Defined in: [react-native/auth/useUpdateProfileMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useUpdateProfileMutation.ts#L7) +Defined in: [react-native/auth/useUpdateProfileMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useUpdateProfileMutation.ts#L7) *** @@ -26,4 +26,4 @@ Defined in: [react-native/auth/useUpdateProfileMutation.ts:7](https://github.com user: FirebaseAuthTypes.User; ``` -Defined in: [react-native/auth/useUpdateProfileMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/useUpdateProfileMutation.ts#L8) +Defined in: [react-native/auth/useUpdateProfileMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/useUpdateProfileMutation.ts#L8) diff --git a/docs/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md b/docs/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md index d46811b..2bd4af2 100644 --- a/docs/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md @@ -6,4 +6,4 @@ const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:1](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L1) +Defined in: [react-native/auth/mutation-keys.ts:1](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L1) diff --git a/docs/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md b/docs/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md index f395417..a18da5c 100644 --- a/docs/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md @@ -6,4 +6,4 @@ const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_CREDENTIAL"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L15) +Defined in: [react-native/auth/mutation-keys.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L15) diff --git a/docs/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md b/docs/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md index bbefe1c..7610e81 100644 --- a/docs/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L14) +Defined in: [react-native/auth/mutation-keys.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L14) diff --git a/docs/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md b/docs/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md index 388ab6f..8f1cd4d 100644 --- a/docs/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L6) +Defined in: [react-native/auth/mutation-keys.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L6) diff --git a/docs/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md b/docs/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md index 18f26a8..e18d173 100644 --- a/docs/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L7) +Defined in: [react-native/auth/mutation-keys.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L7) diff --git a/docs/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md b/docs/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md index 39b7524..1ffc296 100644 --- a/docs/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_IN_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L12) +Defined in: [react-native/auth/mutation-keys.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L12) diff --git a/docs/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md b/docs/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md index e2d986d..99bb1f2 100644 --- a/docs/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md +++ b/docs/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"]; ``` -Defined in: [react-native/auth/mutation-keys.ts:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/auth/mutation-keys.ts#L13) +Defined in: [react-native/auth/mutation-keys.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/auth/mutation-keys.ts#L13) diff --git a/docs/react-native/firestore/functions/buildCompositeFilter.md b/docs/react-native/firestore/functions/buildCompositeFilter.md index bd34f98..74df364 100644 --- a/docs/react-native/firestore/functions/buildCompositeFilter.md +++ b/docs/react-native/firestore/functions/buildCompositeFilter.md @@ -3,30 +3,48 @@ # Function: buildCompositeFilter() ```ts -function buildCompositeFilter(query): null | QueryFilterConstraint +function buildCompositeFilter(query): + | null + | QueryFilterConstraint ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:31](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L31) +Defined in: [react-native/firestore/useCompositeFilter.ts:57](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L57) -Constructs a composite query filter based on the provided query structure. +Constructs a composite or where query filter based on the provided query structure. It recursively builds query constraints using logical "or" or "and" operators. ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### query -[`QueryElement`](../type-aliases/QueryElement.md)\<`DbModelType`\> - -The query element or structure to be evaluated and transformed into filter constraints. +[`QueryElement`](../type-aliases/QueryElement.md)\<`AppModelType`\> ## Returns -`null` \| `QueryFilterConstraint` - -A constructed query filter constraint based on the input query, or null if no valid constraints can be derived. + \| `null` + \| [`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +## Example + +```jsx +export const MyComponent = () => { + const filter = buildCompositeFilter({ + operator: "AND", + children: [ + { + field: "field", + value: "value", + op: "==" + }, + ...(query ? [query] : []) + ] + }); + console.log(filter); +}; +``` diff --git a/docs/react-native/firestore/functions/buildQueryConstraint.md b/docs/react-native/firestore/functions/buildQueryConstraint.md index f3352bf..f4076b8 100644 --- a/docs/react-native/firestore/functions/buildQueryConstraint.md +++ b/docs/react-native/firestore/functions/buildQueryConstraint.md @@ -6,7 +6,7 @@ function buildQueryConstraint(constraint): QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint ``` -Defined in: react-native/firestore/useQueryConstraints.ts:36 +Defined in: [react-native/firestore/useQueryConstraints.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useQueryConstraints.ts#L36) A generic mothod to build query constraints for firebase diff --git a/docs/react-native/firestore/functions/useAddDocMutation.md b/docs/react-native/firestore/functions/useAddDocMutation.md index 2be9e3b..1e258e4 100644 --- a/docs/react-native/firestore/functions/useAddDocMutation.md +++ b/docs/react-native/firestore/functions/useAddDocMutation.md @@ -6,7 +6,7 @@ function useAddDocMutation(options): UseMutationResult, TContext> ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:37](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L37) +Defined in: [react-native/firestore/useAddDocMutation.ts:37](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L37) Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`. It handles addition and optional conversion of the document data in Firestore. diff --git a/docs/react-native/firestore/functions/useBatchWrite.md b/docs/react-native/firestore/functions/useBatchWrite.md index 25bda00..b69a203 100644 --- a/docs/react-native/firestore/functions/useBatchWrite.md +++ b/docs/react-native/firestore/functions/useBatchWrite.md @@ -6,7 +6,7 @@ function useBatchWrite(options): UseMutationResult ``` -Defined in: [react-native/firestore/useBatchWrite.ts:23](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useBatchWrite.ts#L23) +Defined in: [react-native/firestore/useBatchWrite.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useBatchWrite.ts#L23) Custom hook to perform batch write operations using Firestore. Utilizes a mutation to carry out the batch write transaction. diff --git a/docs/react-native/firestore/functions/useCollectionReference.md b/docs/react-native/firestore/functions/useCollectionReference.md index 8b4b8dc..32f3ace 100644 --- a/docs/react-native/firestore/functions/useCollectionReference.md +++ b/docs/react-native/firestore/functions/useCollectionReference.md @@ -6,7 +6,7 @@ function useCollectionReference(options): CollectionReference ``` -Defined in: [react-native/firestore/useCollectionReference.ts:27](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCollectionReference.ts#L27) +Defined in: [react-native/firestore/useCollectionReference.ts:27](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCollectionReference.ts#L27) Creates a reference to a Firestore collection based on the provided path, reference, and path segments. diff --git a/docs/react-native/firestore/functions/useCompositeFilter.md b/docs/react-native/firestore/functions/useCompositeFilter.md index b69baf7..5909416 100644 --- a/docs/react-native/firestore/functions/useCompositeFilter.md +++ b/docs/react-native/firestore/functions/useCompositeFilter.md @@ -3,30 +3,50 @@ # Function: useCompositeFilter() ```ts -function useCompositeFilter(query): undefined | QueryCompositeFilterConstraint +function useCompositeFilter(query): + | undefined + | QueryFilterConstraint ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:65](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L65) +Defined in: [react-native/firestore/useCompositeFilter.ts:113](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L113) -A custom hook that generates a composite filter for database queries, using the provided query configuration. -It applies either an 'OR' or 'AND' logical operation based on the type specified in the query. +A custom hook that constructs a composite or where query filter based on the provided query structure. +It recursively builds query constraints using logical "or" or "and" operators. ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### query -[`UseCompositeFilter`](../type-aliases/UseCompositeFilter.md)\<`DbModelType`\> +#### query? -The query configuration object that contains subqueries and a type for logical combination. +[`CompositeFilter`](../type-aliases/CompositeFilter.md)\<`AppModelType`\> ## Returns -`undefined` \| `QueryCompositeFilterConstraint` - -A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints. + \| `undefined` + \| [`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +## Example + +```jsx +export const MyComponent = () => { + const filter = useCompositeFilter({ + operator: "AND", + children: [ + { + field: "field", + value: "value", + op: "==" + }, + ...(query ? [query] : []) + ] + }); + console.log(filter); +}; +``` diff --git a/docs/react-native/firestore/functions/useCountQuery.md b/docs/react-native/firestore/functions/useCountQuery.md index 0364bbd..53d3f48 100644 --- a/docs/react-native/firestore/functions/useCountQuery.md +++ b/docs/react-native/firestore/functions/useCountQuery.md @@ -6,29 +6,62 @@ function useCountQuery(options): UseQueryResult ``` -Defined in: [react-native/firestore/useCountQuery.ts:39](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCountQuery.ts#L39) +Defined in: [react-native/firestore/useCountQuery.ts:65](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCountQuery.ts#L65) Executes a query with specified constraints and returns the count of matched documents. -This function utilizes React Query to asynchronously fetch the count of documents from a server database -that match the provided query constraints and an optional composite filter. - ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### options -`UseCountQueryOptions`\<`AppModelType`\> - Configuration options for the query. +#### collectionReference + +`CollectionReference`\<`AppModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +Composite filter + +#### options + +`Omit`\<`UseQueryOptions`\<`number`, `Error`, `number`, `QueryKey`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseQueryOptions`\<`number`, `Error`, `number`, `QueryKey`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where + ## Returns `UseQueryResult`\<`number`\> An object containing the number of documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const count = useCountQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(count); +}; +``` diff --git a/docs/react-native/firestore/functions/useDeleteDocMutation.md b/docs/react-native/firestore/functions/useDeleteDocMutation.md index 8e1ce41..1ee4c3c 100644 --- a/docs/react-native/firestore/functions/useDeleteDocMutation.md +++ b/docs/react-native/firestore/functions/useDeleteDocMutation.md @@ -6,7 +6,7 @@ function useDeleteDocMutation(options): UseMutationResult ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:29](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L29) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:29](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L29) A custom hook that provides a mutation function to delete a document from the database. diff --git a/docs/react-native/firestore/functions/useDocReference.md b/docs/react-native/firestore/functions/useDocReference.md index 3cb28bb..c339550 100644 --- a/docs/react-native/firestore/functions/useDocReference.md +++ b/docs/react-native/firestore/functions/useDocReference.md @@ -6,7 +6,7 @@ function useDocReference(options): DocumentReference ``` -Defined in: [react-native/firestore/useDocReference.ts:51](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReference.ts#L51) +Defined in: [react-native/firestore/useDocReference.ts:51](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReference.ts#L51) Custom hook to generate and manage a Firestore document reference. This hook facilitates the retrieval of a Firestore document reference based on given options such as path and reference data. diff --git a/docs/react-native/firestore/functions/useDocReferences.md b/docs/react-native/firestore/functions/useDocReferences.md index 9e7e7f4..736b13e 100644 --- a/docs/react-native/firestore/functions/useDocReferences.md +++ b/docs/react-native/firestore/functions/useDocReferences.md @@ -6,7 +6,7 @@ function useDocReferences(references): DocumentReference[] ``` -Defined in: [react-native/firestore/useDocReferences.ts:32](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReferences.ts#L32) +Defined in: [react-native/firestore/useDocReferences.ts:32](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReferences.ts#L32) A custom hook to generate document references for Firebase Firestore documents using given reference options. diff --git a/docs/react-native/firestore/functions/useFirestore.md b/docs/react-native/firestore/functions/useFirestore.md index 5224f96..56e76f2 100644 --- a/docs/react-native/firestore/functions/useFirestore.md +++ b/docs/react-native/firestore/functions/useFirestore.md @@ -6,7 +6,7 @@ function useFirestore(): Module ``` -Defined in: [react-native/firestore/useFirestore.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useFirestore.ts#L10) +Defined in: [react-native/firestore/useFirestore.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useFirestore.ts#L10) Provides a hook to access the Firestore instance from the Firebase context. It extracts the Firestore object from the Firebase context, allowing components to interact with Firestore services. diff --git a/docs/react-native/firestore/functions/useGetDocData.md b/docs/react-native/firestore/functions/useGetDocData.md index 3b9d0c4..fd483d6 100644 --- a/docs/react-native/firestore/functions/useGetDocData.md +++ b/docs/react-native/firestore/functions/useGetDocData.md @@ -6,7 +6,7 @@ function useGetDocData(__namedParameters): UseQueryResult ``` -Defined in: [react-native/firestore/useGetDocData.ts:26](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetDocData.ts#L26) +Defined in: [react-native/firestore/useGetDocData.ts:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetDocData.ts#L26) Custom React Hook to retrieve document data from Firestore using specified parameters. diff --git a/docs/react-native/firestore/functions/useGetRealtimeDocData.md b/docs/react-native/firestore/functions/useGetRealtimeDocData.md index f6193e3..733b2e9 100644 --- a/docs/react-native/firestore/functions/useGetRealtimeDocData.md +++ b/docs/react-native/firestore/functions/useGetRealtimeDocData.md @@ -6,7 +6,7 @@ function useGetRealtimeDocData(options): object ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:67](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L67) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:67](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L67) A hook to get realtime updates to a firestore document. diff --git a/docs/react-native/firestore/functions/useInfiniteQuery.md b/docs/react-native/firestore/functions/useInfiniteQuery.md index 178705e..804ad2c 100644 --- a/docs/react-native/firestore/functions/useInfiniteQuery.md +++ b/docs/react-native/firestore/functions/useInfiniteQuery.md @@ -3,30 +3,73 @@ # Function: useInfiniteQuery() ```ts -function useInfiniteQuery(options): UseInfiniteQueryResult> +function useInfiniteQuery(options): UseInfiniteQueryResult> ``` -Defined in: [react-native/firestore/useInfiniteQuery.ts:58](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useInfiniteQuery.ts#L58) +Defined in: [react-native/firestore/useInfiniteQuery.ts:93](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useInfiniteQuery.ts#L93) -Custom hook that creates an infinite query using Firestore, allowing for query constraints, composite filters, and converters. -It fetches data in pages and can load more as required. +Executes an infinite query on a Firestore data source and returns the resulting documents as an array. ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) + +### TQueryKey + +`TQueryKey` *extends* `QueryKey` = `QueryKey` + +### TPageParam + +`TPageParam` = `unknown` ## Parameters ### options -`UseInfiniteQueryOptions`\<`AppModelType`\> +Configuration options for the query. + +#### collectionReference + +`CollectionReference`\<`AppModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) -Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter. +Composite filter + +#### options + +`Omit`\<`UseInfiniteQueryOptions`\<`AppModelType`[], `Error`, `InfiniteData`\<`AppModelType`[], `unknown`\>, `AppModelType`[], `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseInfiniteQueryOptions`\<`AppModelType`[], `Error`, `InfiniteData`\<`AppModelType`[], `unknown`\>, `AppModelType`[], `TQueryKey`, `TPageParam`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where ## Returns `UseInfiniteQueryResult`\<`InfiniteData`\<`AppModelType`[], `unknown`\>\> -Result object containing the infinite data and methods for fetching more pages. +An object containing documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const docs = useInfiniteQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(docs); +}; +``` diff --git a/docs/react-native/firestore/functions/useQuery.md b/docs/react-native/firestore/functions/useQuery.md index d54c96a..7e96694 100644 --- a/docs/react-native/firestore/functions/useQuery.md +++ b/docs/react-native/firestore/functions/useQuery.md @@ -3,30 +3,65 @@ # Function: useQuery() ```ts -function useQuery(__namedParameters): UseQueryResult +function useQuery(options): UseQueryResult ``` -Defined in: [react-native/firestore/useQuery.ts:37](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useQuery.ts#L37) +Defined in: [react-native/firestore/useQuery.ts:65](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useQuery.ts#L65) -Executes a query on a Firestore-like data source and returns the resulting documents as an array. - -This hook utilizes an abstraction over React Query to asynchronously fetch data based on the provided query -reference and constraints. It supports optional filtering, conversion, and additional query constraints. +Executes a query on a Firestore data source and returns the resulting documents as an array. ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters -### \_\_namedParameters +### options + +Configuration options for the query. + +#### collectionReference + +`CollectionReference`\<`AppModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +Composite filter -`UseQueryOptions`\<`AppModelType`\> +#### options + +`Omit`\<`UseQueryOptions`\<`AppModelType`[], `Error`, `AppModelType`[], `QueryKey`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseQueryOptions`\<`AppModelType`[], `Error`, `AppModelType`[], `QueryKey`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where ## Returns `UseQueryResult`\<`AppModelType`[]\> -Result containing an array of documents that match the query criteria. +An object containing documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const docs = useQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(docs); +}; +``` diff --git a/docs/react-native/firestore/functions/useQueryConstraints.md b/docs/react-native/firestore/functions/useQueryConstraints.md index 9735157..8c5c8c7 100644 --- a/docs/react-native/firestore/functions/useQueryConstraints.md +++ b/docs/react-native/firestore/functions/useQueryConstraints.md @@ -6,7 +6,7 @@ function useQueryConstraints(options): (QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint)[] ``` -Defined in: react-native/firestore/useQueryConstraints.ts:78 +Defined in: [react-native/firestore/useQueryConstraints.ts:78](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useQueryConstraints.ts#L78) A hook to build a list of non-filter query constraints for firebase queries. It uses buildQueryConstraint method and useMemo hook. diff --git a/docs/react-native/firestore/functions/useRunTransaction.md b/docs/react-native/firestore/functions/useRunTransaction.md index 29b2fff..b2402ac 100644 --- a/docs/react-native/firestore/functions/useRunTransaction.md +++ b/docs/react-native/firestore/functions/useRunTransaction.md @@ -6,7 +6,7 @@ function useRunTransaction(options): UseMutationResult ``` -Defined in: [react-native/firestore/useRunTransaction.ts:25](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useRunTransaction.ts#L25) +Defined in: [react-native/firestore/useRunTransaction.ts:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useRunTransaction.ts#L25) Custom hook to execute a Firestore transaction using the useMutation hook. diff --git a/docs/react-native/firestore/functions/useSetDocMutation.md b/docs/react-native/firestore/functions/useSetDocMutation.md index 365d4eb..f533147 100644 --- a/docs/react-native/firestore/functions/useSetDocMutation.md +++ b/docs/react-native/firestore/functions/useSetDocMutation.md @@ -6,7 +6,7 @@ function useSetDocMutation(param0): UseMutationResult, TContext> ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:36](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L36) +Defined in: [react-native/firestore/useSetDocMutation.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L36) Custom hook to create a mutation for setting a document in a Firestore-like database. The mutation can be configured with options and reference to specific document path. diff --git a/docs/react-native/firestore/functions/useUpdateDocMutation.md b/docs/react-native/firestore/functions/useUpdateDocMutation.md index 69a8be5..1a93eb3 100644 --- a/docs/react-native/firestore/functions/useUpdateDocMutation.md +++ b/docs/react-native/firestore/functions/useUpdateDocMutation.md @@ -6,7 +6,7 @@ function useUpdateDocMutation(options): UseMutationResult, TContext> ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:46](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L46) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:46](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L46) Custom hook that sets up a mutation for updating a document in a Firestore database. diff --git a/docs/react-native/firestore/index.md b/docs/react-native/firestore/index.md index 4400f31..75f03a4 100644 --- a/docs/react-native/firestore/index.md +++ b/docs/react-native/firestore/index.md @@ -6,6 +6,7 @@ - [CompositeFilter](type-aliases/CompositeFilter.md) - [QueryElement](type-aliases/QueryElement.md) +- [QueryFilterConstraint](type-aliases/QueryFilterConstraint.md) - [UseAddDocMutationOptions](type-aliases/UseAddDocMutationOptions.md) - [UseAddDocMutationValues](type-aliases/UseAddDocMutationValues.md) - [UseBatchWriteOptions](type-aliases/UseBatchWriteOptions.md) @@ -28,28 +29,28 @@ ## Functions -- [buildCompositeFilter](functions/buildCompositeFilter.md) - [useAddDocMutation](functions/useAddDocMutation.md) - [useBatchWrite](functions/useBatchWrite.md) - [useCollectionReference](functions/useCollectionReference.md) -- [useCompositeFilter](functions/useCompositeFilter.md) -- [useCountQuery](functions/useCountQuery.md) - [useDeleteDocMutation](functions/useDeleteDocMutation.md) - [useDocReference](functions/useDocReference.md) - [useDocReferences](functions/useDocReferences.md) - [useFirestore](functions/useFirestore.md) - [useGetDocData](functions/useGetDocData.md) -- [useInfiniteQuery](functions/useInfiniteQuery.md) -- [useQuery](functions/useQuery.md) - [useRunTransaction](functions/useRunTransaction.md) - [useSetDocMutation](functions/useSetDocMutation.md) - [useUpdateDocMutation](functions/useUpdateDocMutation.md) ## Hook +- [useCompositeFilter](functions/useCompositeFilter.md) +- [useCountQuery](functions/useCountQuery.md) - [useGetRealtimeDocData](functions/useGetRealtimeDocData.md) +- [useInfiniteQuery](functions/useInfiniteQuery.md) +- [useQuery](functions/useQuery.md) - [useQueryConstraints](functions/useQueryConstraints.md) ## Utility +- [buildCompositeFilter](functions/buildCompositeFilter.md) - [buildQueryConstraint](functions/buildQueryConstraint.md) diff --git a/docs/react-native/firestore/type-aliases/CompositeFilter.md b/docs/react-native/firestore/type-aliases/CompositeFilter.md index bf7aafc..0dfd942 100644 --- a/docs/react-native/firestore/type-aliases/CompositeFilter.md +++ b/docs/react-native/firestore/type-aliases/CompositeFilter.md @@ -1,28 +1,28 @@ [react-query-firebase](../../../modules.md) / [react-native/firestore](../index.md) / CompositeFilter -# Type Alias: CompositeFilter\ +# Type Alias: CompositeFilter\ ```ts -type CompositeFilter = object; +type CompositeFilter = object; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L14) +Defined in: [react-native/firestore/useCompositeFilter.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L17) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties ### children ```ts -children: QueryElement[]; +children: QueryElement[]; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L16) +Defined in: [react-native/firestore/useCompositeFilter.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L19) *** @@ -32,4 +32,4 @@ Defined in: [react-native/firestore/useCompositeFilter.ts:16](https://github.com operator: "OR" | "AND"; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L15) +Defined in: [react-native/firestore/useCompositeFilter.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L18) diff --git a/docs/react-native/firestore/type-aliases/QueryElement.md b/docs/react-native/firestore/type-aliases/QueryElement.md index f27c173..53b59dc 100644 --- a/docs/react-native/firestore/type-aliases/QueryElement.md +++ b/docs/react-native/firestore/type-aliases/QueryElement.md @@ -1,18 +1,18 @@ [react-query-firebase](../../../modules.md) / [react-native/firestore](../index.md) / QueryElement -# Type Alias: QueryElement\ +# Type Alias: QueryElement\ ```ts -type QueryElement = object; +type QueryElement = object; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L6) +Defined in: [react-native/firestore/useCompositeFilter.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L9) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties @@ -22,17 +22,17 @@ Defined in: [react-native/firestore/useCompositeFilter.ts:6](https://github.com/ optional children: QueryElement[]; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L8) +Defined in: [react-native/firestore/useCompositeFilter.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L11) *** ### field? ```ts -optional field: keyof DbModelType & object; +optional field: keyof AppModelType & object; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L9) +Defined in: [react-native/firestore/useCompositeFilter.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L12) *** @@ -42,7 +42,7 @@ Defined in: [react-native/firestore/useCompositeFilter.ts:9](https://github.com/ optional op: FirebaseFirestoreTypes.WhereFilterOp; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L11) +Defined in: [react-native/firestore/useCompositeFilter.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L14) *** @@ -52,14 +52,14 @@ Defined in: [react-native/firestore/useCompositeFilter.ts:11](https://github.com optional operator: "OR" | "AND"; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L7) +Defined in: [react-native/firestore/useCompositeFilter.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L10) *** ### value? ```ts -optional value: DbModelType[keyof DbModelType]; +optional value: AppModelType[keyof AppModelType]; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L10) +Defined in: [react-native/firestore/useCompositeFilter.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L13) diff --git a/docs/react-native/firestore/type-aliases/QueryFilterConstraint.md b/docs/react-native/firestore/type-aliases/QueryFilterConstraint.md new file mode 100644 index 0000000..317792a --- /dev/null +++ b/docs/react-native/firestore/type-aliases/QueryFilterConstraint.md @@ -0,0 +1,11 @@ +[react-query-firebase](../../../modules.md) / [react-native/firestore](../index.md) / QueryFilterConstraint + +# Type Alias: QueryFilterConstraint + +```ts +type QueryFilterConstraint = + | FirebaseFirestoreTypes.QueryCompositeFilterConstraint + | FirebaseFirestoreTypes.QueryFilterConstraint; +``` + +Defined in: [react-native/firestore/useCompositeFilter.ts:5](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L5) diff --git a/docs/react-native/firestore/type-aliases/UseAddDocMutationOptions.md b/docs/react-native/firestore/type-aliases/UseAddDocMutationOptions.md index ecb7ed0..a5ab219 100644 --- a/docs/react-native/firestore/type-aliases/UseAddDocMutationOptions.md +++ b/docs/react-native/firestore/type-aliases/UseAddDocMutationOptions.md @@ -6,7 +6,7 @@ type UseAddDocMutationOptions = object; ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L11) +Defined in: [react-native/firestore/useAddDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L11) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [react-native/firestore/useAddDocMutation.ts:11](https://github.com/ optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L16) +Defined in: [react-native/firestore/useAddDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L16) *** @@ -36,4 +36,4 @@ Defined in: [react-native/firestore/useAddDocMutation.ts:16](https://github.com/ reference: FirebaseFirestoreTypes.CollectionReference; ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L15) +Defined in: [react-native/firestore/useAddDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L15) diff --git a/docs/react-native/firestore/type-aliases/UseAddDocMutationValues.md b/docs/react-native/firestore/type-aliases/UseAddDocMutationValues.md index 54668a3..db28ca5 100644 --- a/docs/react-native/firestore/type-aliases/UseAddDocMutationValues.md +++ b/docs/react-native/firestore/type-aliases/UseAddDocMutationValues.md @@ -6,7 +6,7 @@ type UseAddDocMutationValues = object; ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L7) +Defined in: [react-native/firestore/useAddDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [react-native/firestore/useAddDocMutation.ts:7](https://github.com/v data: WithFieldValue; ``` -Defined in: [react-native/firestore/useAddDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useAddDocMutation.ts#L8) +Defined in: [react-native/firestore/useAddDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useAddDocMutation.ts#L8) diff --git a/docs/react-native/firestore/type-aliases/UseBatchWriteOptions.md b/docs/react-native/firestore/type-aliases/UseBatchWriteOptions.md index 654db0a..1b3d606 100644 --- a/docs/react-native/firestore/type-aliases/UseBatchWriteOptions.md +++ b/docs/react-native/firestore/type-aliases/UseBatchWriteOptions.md @@ -6,7 +6,7 @@ type UseBatchWriteOptions = object; ``` -Defined in: [react-native/firestore/useBatchWrite.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useBatchWrite.ts#L9) +Defined in: [react-native/firestore/useBatchWrite.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useBatchWrite.ts#L9) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [react-native/firestore/useBatchWrite.ts:9](https://github.com/vpish optional options: Omit, "mutationFn">; ``` -Defined in: [react-native/firestore/useBatchWrite.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useBatchWrite.ts#L10) +Defined in: [react-native/firestore/useBatchWrite.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useBatchWrite.ts#L10) diff --git a/docs/react-native/firestore/type-aliases/UseBatchWriteVariables.md b/docs/react-native/firestore/type-aliases/UseBatchWriteVariables.md index 6dc2ef0..f1e6ab7 100644 --- a/docs/react-native/firestore/type-aliases/UseBatchWriteVariables.md +++ b/docs/react-native/firestore/type-aliases/UseBatchWriteVariables.md @@ -6,7 +6,7 @@ type UseBatchWriteVariables = (batch) => Promise | void; ``` -Defined in: [react-native/firestore/useBatchWrite.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useBatchWrite.ts#L7) +Defined in: [react-native/firestore/useBatchWrite.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useBatchWrite.ts#L7) ## Parameters diff --git a/docs/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md b/docs/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md index 74a959c..56dbaff 100644 --- a/docs/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md +++ b/docs/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md @@ -6,7 +6,7 @@ type UseCollectionReferenceOptions = object; ``` -Defined in: [react-native/firestore/useCollectionReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCollectionReference.ts#L6) +Defined in: [react-native/firestore/useCollectionReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCollectionReference.ts#L6) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [react-native/firestore/useCollectionReference.ts:6](https://github. path: string; ``` -Defined in: [react-native/firestore/useCollectionReference.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCollectionReference.ts#L12) +Defined in: [react-native/firestore/useCollectionReference.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCollectionReference.ts#L12) *** @@ -32,7 +32,7 @@ Defined in: [react-native/firestore/useCollectionReference.ts:12](https://github optional pathSegments: string[]; ``` -Defined in: [react-native/firestore/useCollectionReference.ts:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCollectionReference.ts#L13) +Defined in: [react-native/firestore/useCollectionReference.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCollectionReference.ts#L13) *** @@ -44,4 +44,4 @@ optional reference: | FirebaseFirestoreTypes.DocumentReference; ``` -Defined in: [react-native/firestore/useCollectionReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCollectionReference.ts#L9) +Defined in: [react-native/firestore/useCollectionReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCollectionReference.ts#L9) diff --git a/docs/react-native/firestore/type-aliases/UseCompositeFilter.md b/docs/react-native/firestore/type-aliases/UseCompositeFilter.md index 5c5cc76..0072652 100644 --- a/docs/react-native/firestore/type-aliases/UseCompositeFilter.md +++ b/docs/react-native/firestore/type-aliases/UseCompositeFilter.md @@ -1,25 +1,25 @@ [react-query-firebase](../../../modules.md) / [react-native/firestore](../index.md) / UseCompositeFilter -# Type Alias: UseCompositeFilter\ +# Type Alias: UseCompositeFilter\ ```ts -type UseCompositeFilter = object; +type UseCompositeFilter = object; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L19) +Defined in: [react-native/firestore/useCompositeFilter.ts:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L25) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties ### query? ```ts -optional query: CompositeFilter; +optional query: CompositeFilter; ``` -Defined in: [react-native/firestore/useCompositeFilter.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useCompositeFilter.ts#L20) +Defined in: [react-native/firestore/useCompositeFilter.ts:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useCompositeFilter.ts#L26) diff --git a/docs/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md b/docs/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md index 077e08d..0e02c16 100644 --- a/docs/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md +++ b/docs/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md @@ -6,7 +6,7 @@ type UseDeleteDocMutationOptions = object; ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L11) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L11) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [react-native/firestore/useDeleteDocMutation.ts:11](https://github.c optional options: Omit, "mutationFn" | "mutationKey">; ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L16) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L16) *** @@ -36,4 +36,4 @@ Defined in: [react-native/firestore/useDeleteDocMutation.ts:16](https://github.c reference: FirebaseFirestoreTypes.DocumentReference | null; ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L15) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L15) diff --git a/docs/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md b/docs/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md index 048d2dc..73bc7f0 100644 --- a/docs/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md +++ b/docs/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md @@ -6,7 +6,7 @@ type UseDeleteDocMutationValues = object; ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L7) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [react-native/firestore/useDeleteDocMutation.ts:7](https://github.co data: WithFieldValue; ``` -Defined in: [react-native/firestore/useDeleteDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDeleteDocMutation.ts#L8) +Defined in: [react-native/firestore/useDeleteDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDeleteDocMutation.ts#L8) diff --git a/docs/react-native/firestore/type-aliases/UseDocReferenceOptions.md b/docs/react-native/firestore/type-aliases/UseDocReferenceOptions.md index efe408d..f4d9740 100644 --- a/docs/react-native/firestore/type-aliases/UseDocReferenceOptions.md +++ b/docs/react-native/firestore/type-aliases/UseDocReferenceOptions.md @@ -6,7 +6,7 @@ type UseDocReferenceOptions = object; ``` -Defined in: [react-native/firestore/useDocReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReference.ts#L6) +Defined in: [react-native/firestore/useDocReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReference.ts#L6) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [react-native/firestore/useDocReference.ts:6](https://github.com/vpi optional path: string; ``` -Defined in: [react-native/firestore/useDocReference.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReference.ts#L12) +Defined in: [react-native/firestore/useDocReference.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReference.ts#L12) *** @@ -32,7 +32,7 @@ Defined in: [react-native/firestore/useDocReference.ts:12](https://github.com/vp optional pathSegments: string[]; ``` -Defined in: [react-native/firestore/useDocReference.ts:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReference.ts#L13) +Defined in: [react-native/firestore/useDocReference.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReference.ts#L13) *** @@ -44,4 +44,4 @@ optional reference: | FirebaseFirestoreTypes.DocumentReference; ``` -Defined in: [react-native/firestore/useDocReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReference.ts#L9) +Defined in: [react-native/firestore/useDocReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReference.ts#L9) diff --git a/docs/react-native/firestore/type-aliases/UseDocReferencesOptions.md b/docs/react-native/firestore/type-aliases/UseDocReferencesOptions.md index 8cfd25b..4bee14d 100644 --- a/docs/react-native/firestore/type-aliases/UseDocReferencesOptions.md +++ b/docs/react-native/firestore/type-aliases/UseDocReferencesOptions.md @@ -6,7 +6,7 @@ type UseDocReferencesOptions = object; ``` -Defined in: [react-native/firestore/useDocReferences.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReferences.ts#L6) +Defined in: [react-native/firestore/useDocReferences.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReferences.ts#L6) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [react-native/firestore/useDocReferences.ts:6](https://github.com/vp path: string; ``` -Defined in: [react-native/firestore/useDocReferences.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReferences.ts#L12) +Defined in: [react-native/firestore/useDocReferences.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReferences.ts#L12) *** @@ -32,7 +32,7 @@ Defined in: [react-native/firestore/useDocReferences.ts:12](https://github.com/v optional pathSegments: string[]; ``` -Defined in: [react-native/firestore/useDocReferences.ts:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReferences.ts#L13) +Defined in: [react-native/firestore/useDocReferences.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReferences.ts#L13) *** @@ -44,4 +44,4 @@ optional reference: | FirebaseFirestoreTypes.DocumentReference; ``` -Defined in: [react-native/firestore/useDocReferences.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useDocReferences.ts#L9) +Defined in: [react-native/firestore/useDocReferences.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useDocReferences.ts#L9) diff --git a/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md b/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md index fedaddc..fa286d5 100644 --- a/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md +++ b/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md @@ -6,7 +6,7 @@ type UseGetRealtimeDocDataOptions = object; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L10) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L10) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [react-native/firestore/useGetRealtimeDocData.ts:10](https://github. optional onError: (error) => unknown; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:32](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L32) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:32](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L32) A callback to be called if the listen fails or is cancelled. No further callbacks will occur. @@ -45,7 +45,7 @@ cancelled. No further callbacks will occur. optional path: string; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L16) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L16) A slash-separated path to a document. Has to be omitted to use @@ -57,7 +57,7 @@ A slash-separated path to a document. Has to be omitted to use optional pathSegments: string[]; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:27](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L27) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:27](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L27) Additional path segments that will be applied relative to the first argument. @@ -72,6 +72,6 @@ optional reference: | FirebaseFirestoreTypes.DocumentReference; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L20) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L20) A reference to a collection. diff --git a/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md b/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md index b89489e..b3240ce 100644 --- a/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md +++ b/docs/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md @@ -6,7 +6,7 @@ type UseGetRealtimeDocDataResult = object; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:38](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L38) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:38](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L38) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [react-native/firestore/useGetRealtimeDocData.ts:38](https://github. data: AppModelType | null; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:39](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L39) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:39](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L39) *** @@ -32,7 +32,7 @@ Defined in: [react-native/firestore/useGetRealtimeDocData.ts:39](https://github. error: ReactNativeFirebase.NativeFirebaseError | Error | null; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:41](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L41) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:41](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L41) *** @@ -42,7 +42,7 @@ Defined in: [react-native/firestore/useGetRealtimeDocData.ts:41](https://github. isError: boolean; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:40](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L40) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:40](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L40) *** @@ -52,4 +52,4 @@ Defined in: [react-native/firestore/useGetRealtimeDocData.ts:40](https://github. isFetching: boolean; ``` -Defined in: [react-native/firestore/useGetRealtimeDocData.ts:42](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useGetRealtimeDocData.ts#L42) +Defined in: [react-native/firestore/useGetRealtimeDocData.ts:42](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useGetRealtimeDocData.ts#L42) diff --git a/docs/react-native/firestore/type-aliases/UseQueryConstraints.md b/docs/react-native/firestore/type-aliases/UseQueryConstraints.md index b02b567..b8ca188 100644 --- a/docs/react-native/firestore/type-aliases/UseQueryConstraints.md +++ b/docs/react-native/firestore/type-aliases/UseQueryConstraints.md @@ -6,7 +6,7 @@ type UseQueryConstraints = object; ``` -Defined in: react-native/firestore/useQueryConstraints.ts:9 +Defined in: [react-native/firestore/useQueryConstraints.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useQueryConstraints.ts#L9) ## Type Parameters @@ -22,6 +22,6 @@ Defined in: react-native/firestore/useQueryConstraints.ts:9 constraints: NonFilterQueryConstraint[]; ``` -Defined in: react-native/firestore/useQueryConstraints.ts:13 +Defined in: [react-native/firestore/useQueryConstraints.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useQueryConstraints.ts#L13) A list of constraints such as limit, order, offset. diff --git a/docs/react-native/firestore/type-aliases/UseRunTransactionOptions.md b/docs/react-native/firestore/type-aliases/UseRunTransactionOptions.md index 9b2b079..6ead4bd 100644 --- a/docs/react-native/firestore/type-aliases/UseRunTransactionOptions.md +++ b/docs/react-native/firestore/type-aliases/UseRunTransactionOptions.md @@ -6,7 +6,7 @@ type UseRunTransactionOptions = object; ``` -Defined in: [react-native/firestore/useRunTransaction.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useRunTransaction.ts#L11) +Defined in: [react-native/firestore/useRunTransaction.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useRunTransaction.ts#L11) ## Type Parameters @@ -26,4 +26,4 @@ Defined in: [react-native/firestore/useRunTransaction.ts:11](https://github.com/ optional options: Omit, "mutationFn">; ``` -Defined in: [react-native/firestore/useRunTransaction.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useRunTransaction.ts#L12) +Defined in: [react-native/firestore/useRunTransaction.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useRunTransaction.ts#L12) diff --git a/docs/react-native/firestore/type-aliases/UseRunTransactionValues.md b/docs/react-native/firestore/type-aliases/UseRunTransactionValues.md index f9b2ca8..bbe6f5b 100644 --- a/docs/react-native/firestore/type-aliases/UseRunTransactionValues.md +++ b/docs/react-native/firestore/type-aliases/UseRunTransactionValues.md @@ -6,7 +6,7 @@ type UseRunTransactionValues = (transaction) => AppModelType; ``` -Defined in: [react-native/firestore/useRunTransaction.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useRunTransaction.ts#L7) +Defined in: [react-native/firestore/useRunTransaction.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useRunTransaction.ts#L7) ## Type Parameters diff --git a/docs/react-native/firestore/type-aliases/UseSetDocMutationOptions.md b/docs/react-native/firestore/type-aliases/UseSetDocMutationOptions.md index 0cfef92..c2a9672 100644 --- a/docs/react-native/firestore/type-aliases/UseSetDocMutationOptions.md +++ b/docs/react-native/firestore/type-aliases/UseSetDocMutationOptions.md @@ -6,7 +6,7 @@ type UseSetDocMutationOptions = object; ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L11) +Defined in: [react-native/firestore/useSetDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L11) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [react-native/firestore/useSetDocMutation.ts:11](https://github.com/ optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L16) +Defined in: [react-native/firestore/useSetDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L16) *** @@ -36,4 +36,4 @@ Defined in: [react-native/firestore/useSetDocMutation.ts:16](https://github.com/ reference: FirebaseFirestoreTypes.DocumentReference | null; ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L15) +Defined in: [react-native/firestore/useSetDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L15) diff --git a/docs/react-native/firestore/type-aliases/UseSetDocMutationValues.md b/docs/react-native/firestore/type-aliases/UseSetDocMutationValues.md index 8bd533c..dca548f 100644 --- a/docs/react-native/firestore/type-aliases/UseSetDocMutationValues.md +++ b/docs/react-native/firestore/type-aliases/UseSetDocMutationValues.md @@ -6,7 +6,7 @@ type UseSetDocMutationValues = object; ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L7) +Defined in: [react-native/firestore/useSetDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [react-native/firestore/useSetDocMutation.ts:7](https://github.com/v data: WithFieldValue; ``` -Defined in: [react-native/firestore/useSetDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useSetDocMutation.ts#L8) +Defined in: [react-native/firestore/useSetDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useSetDocMutation.ts#L8) diff --git a/docs/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md b/docs/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md index d46afb0..f1413cf 100644 --- a/docs/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md +++ b/docs/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md @@ -6,7 +6,7 @@ type UseUpdateDocMutationOptions = object; ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L11) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L11) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [react-native/firestore/useUpdateDocMutation.ts:11](https://github.c optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L16) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L16) *** @@ -36,4 +36,4 @@ Defined in: [react-native/firestore/useUpdateDocMutation.ts:16](https://github.c reference: FirebaseFirestoreTypes.DocumentReference | null; ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L15) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L15) diff --git a/docs/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md b/docs/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md index f93efcc..b049567 100644 --- a/docs/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md +++ b/docs/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md @@ -6,7 +6,7 @@ type UseUpdateDocMutationValues = object; ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L7) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [react-native/firestore/useUpdateDocMutation.ts:7](https://github.co data: UpdateData; ``` -Defined in: [react-native/firestore/useUpdateDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/firestore/useUpdateDocMutation.ts#L8) +Defined in: [react-native/firestore/useUpdateDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/firestore/useUpdateDocMutation.ts#L8) diff --git a/docs/react-native/remoteConfig/functions/useFetchAndActivate.md b/docs/react-native/remoteConfig/functions/useFetchAndActivate.md index e585f2d..6da4f0e 100644 --- a/docs/react-native/remoteConfig/functions/useFetchAndActivate.md +++ b/docs/react-native/remoteConfig/functions/useFetchAndActivate.md @@ -6,7 +6,7 @@ function useFetchAndActivate(): object ``` -Defined in: [react-native/remoteConfig/useFetchAndActivate.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/remoteConfig/useFetchAndActivate.ts#L12) +Defined in: [react-native/remoteConfig/useFetchAndActivate.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/remoteConfig/useFetchAndActivate.ts#L12) Custom hook to fetch and activate remote configuration settings. Initializes remote configuration, fetches, activates it, and tracks the fetch status. diff --git a/docs/react-native/remoteConfig/functions/useGetValue.md b/docs/react-native/remoteConfig/functions/useGetValue.md index 5d16601..4493ae3 100644 --- a/docs/react-native/remoteConfig/functions/useGetValue.md +++ b/docs/react-native/remoteConfig/functions/useGetValue.md @@ -6,7 +6,7 @@ function useGetValue(key): null | ConfigValue ``` -Defined in: [react-native/remoteConfig/useGetValue.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/remoteConfig/useGetValue.ts#L11) +Defined in: [react-native/remoteConfig/useGetValue.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/remoteConfig/useGetValue.ts#L11) Custom hook to retrieve a value associated with a specified key from remote configuration. Utilizes memoization to optimize performance by recalculating the result only if dependencies change. diff --git a/docs/react-native/remoteConfig/functions/useRemoteConfig.md b/docs/react-native/remoteConfig/functions/useRemoteConfig.md index 4bbc9ae..d6945e2 100644 --- a/docs/react-native/remoteConfig/functions/useRemoteConfig.md +++ b/docs/react-native/remoteConfig/functions/useRemoteConfig.md @@ -6,7 +6,7 @@ function useRemoteConfig(): Module ``` -Defined in: [react-native/remoteConfig/useRemoteConfig.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/remoteConfig/useRemoteConfig.ts#L8) +Defined in: [react-native/remoteConfig/useRemoteConfig.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/remoteConfig/useRemoteConfig.ts#L8) Hook to access the Firebase Remote Config instance from the context. diff --git a/docs/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md b/docs/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md index 55b1b9d..d7270dd 100644 --- a/docs/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md +++ b/docs/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md @@ -6,7 +6,7 @@ type FirebaseContextProviderAuthEmulatorConfig = object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:45](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L45) +Defined in: [react-native/context/FirebaseContextProvider.tsx:49](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L49) ## Properties @@ -16,6 +16,6 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:45](https://github host: string; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:49](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L49) +Defined in: [react-native/context/FirebaseContextProvider.tsx:53](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L53) Host to connect to Firebase Auth Emulator diff --git a/docs/react-native/type-aliases/FirebaseContextProviderEmulators.md b/docs/react-native/type-aliases/FirebaseContextProviderEmulators.md index 7566ff7..1750493 100644 --- a/docs/react-native/type-aliases/FirebaseContextProviderEmulators.md +++ b/docs/react-native/type-aliases/FirebaseContextProviderEmulators.md @@ -6,7 +6,7 @@ type FirebaseContextProviderEmulators = object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:55](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L55) +Defined in: [react-native/context/FirebaseContextProvider.tsx:59](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L59) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:55](https://github optional auth: object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:63](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L63) +Defined in: [react-native/context/FirebaseContextProvider.tsx:67](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L67) Defines configuration for Firebase Auth emulator. Optional @@ -36,7 +36,7 @@ Host to connect to Firebase Auth Emulator optional firestore: object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:59](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L59) +Defined in: [react-native/context/FirebaseContextProvider.tsx:63](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L63) Defines configuration for Firebase Firestore emulator. Optional. diff --git a/docs/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md b/docs/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md index dbb6c3d..041f5ab 100644 --- a/docs/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md +++ b/docs/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md @@ -6,7 +6,7 @@ type FirebaseContextProviderFirestoreEmulatorConfig = object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:31](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L31) +Defined in: [react-native/context/FirebaseContextProvider.tsx:35](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L35) ## Properties @@ -16,7 +16,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:31](https://github host: string; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:35](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L35) +Defined in: [react-native/context/FirebaseContextProvider.tsx:39](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L39) Host to connect to Firebase Firestore Emulator @@ -28,6 +28,6 @@ Host to connect to Firebase Firestore Emulator port: number; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:39](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L39) +Defined in: [react-native/context/FirebaseContextProvider.tsx:43](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L43) Port to connect to Firebase Firestore Emulator diff --git a/docs/react-native/type-aliases/FirebaseContextProviderProps.md b/docs/react-native/type-aliases/FirebaseContextProviderProps.md index b8e8bae..a1276b1 100644 --- a/docs/react-native/type-aliases/FirebaseContextProviderProps.md +++ b/docs/react-native/type-aliases/FirebaseContextProviderProps.md @@ -6,7 +6,7 @@ type FirebaseContextProviderProps = PropsWithChildren & object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:69](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L69) +Defined in: [react-native/context/FirebaseContextProvider.tsx:73](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L73) ## Type declaration @@ -188,20 +188,14 @@ kind: "memory" | "persistent"; optional ssl: boolean; ``` -### options +### options? ```ts -options: ReactNativeFirebase.FirebaseAppOptions; +optional options: ReactNativeFirebase.FirebaseAppOptions; ``` Configuration options for Firebase initialization. [Learn about the Firebase config object](https://firebase.google.com/docs/web/setup#config-object) -### platform - -```ts -platform: "Web" | "ReactNative"; -``` - ### remoteConfigDefaults? ```ts diff --git a/docs/react-native/type-aliases/FirestoreSettings.md b/docs/react-native/type-aliases/FirestoreSettings.md index a7cd4ba..9a231de 100644 --- a/docs/react-native/type-aliases/FirestoreSettings.md +++ b/docs/react-native/type-aliases/FirestoreSettings.md @@ -6,7 +6,7 @@ type FirestoreSettings = object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L13) +Defined in: [react-native/context/FirebaseContextProvider.tsx:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L17) ## See @@ -20,7 +20,7 @@ https://firebase.google.com/docs/reference/js/firestore_.firestoresettings optional cacheSizeBytes: number; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L14) +Defined in: [react-native/context/FirebaseContextProvider.tsx:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L18) *** @@ -30,7 +30,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:14](https://github optional experimentalAutoDetectLongPolling: boolean; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L15) +Defined in: [react-native/context/FirebaseContextProvider.tsx:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L19) *** @@ -40,7 +40,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:15](https://github optional experimentalForceLongPolling: boolean; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L16) +Defined in: [react-native/context/FirebaseContextProvider.tsx:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L20) *** @@ -50,7 +50,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:16](https://github optional experimentalLongPollingOptions: object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:17](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L17) +Defined in: [react-native/context/FirebaseContextProvider.tsx:21](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L21) #### timeoutSeconds @@ -66,7 +66,7 @@ timeoutSeconds: number; optional host: string; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L20) +Defined in: [react-native/context/FirebaseContextProvider.tsx:24](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L24) *** @@ -76,7 +76,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:20](https://github optional ignoreUndefinedProperties: boolean; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:21](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L21) +Defined in: [react-native/context/FirebaseContextProvider.tsx:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L25) *** @@ -86,7 +86,7 @@ Defined in: [react-native/context/FirebaseContextProvider.tsx:21](https://github optional localCache: object; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:22](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L22) +Defined in: [react-native/context/FirebaseContextProvider.tsx:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L26) #### kind @@ -102,4 +102,4 @@ kind: "memory" | "persistent"; optional ssl: boolean; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:25](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L25) +Defined in: [react-native/context/FirebaseContextProvider.tsx:29](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L29) diff --git a/docs/react-native/variables/FirebaseContextProvider.md b/docs/react-native/variables/FirebaseContextProvider.md index df86023..9cfdb1c 100644 --- a/docs/react-native/variables/FirebaseContextProvider.md +++ b/docs/react-native/variables/FirebaseContextProvider.md @@ -33,14 +33,13 @@ const FirebaseContextProvider: React.FC<{ ssl: boolean; }; options: FirebaseAppOptions; - platform: "Web" | "ReactNative"; remoteConfigDefaults: {}; remoteConfigEnabled: boolean; remoteConfigSettings: ConfigSettings; }>; ``` -Defined in: [react-native/context/FirebaseContextProvider.tsx:152](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/react-native/context/FirebaseContextProvider.tsx#L152) +Defined in: [react-native/context/FirebaseContextProvider.tsx:155](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/react-native/context/FirebaseContextProvider.tsx#L155) FirebaseContextProvider component configures and provides Firebase services to its children. Initializes Firebase app and enables optional Firebase services such as Firestore, Auth, Analytics, diff --git a/docs/typedoc-sidebar.json b/docs/typedoc-sidebar.json index c90ff04..29b7dd0 100644 --- a/docs/typedoc-sidebar.json +++ b/docs/typedoc-sidebar.json @@ -1 +1 @@ -[{"text":"react-native","link":"/react-native/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"FirebaseContextProviderAuthEmulatorConfig","link":"/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md"},{"text":"FirebaseContextProviderEmulators","link":"/react-native/type-aliases/FirebaseContextProviderEmulators.md"},{"text":"FirebaseContextProviderFirestoreEmulatorConfig","link":"/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md"},{"text":"FirebaseContextProviderProps","link":"/react-native/type-aliases/FirebaseContextProviderProps.md"},{"text":"FirestoreSettings","link":"/react-native/type-aliases/FirestoreSettings.md"}]},{"text":"Component","collapsed":true,"items":[{"text":"FirebaseContextProvider","link":"/react-native/variables/FirebaseContextProvider.md"}]},{"text":"analytics","link":"/react-native/analytics/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useAnalytics","link":"/react-native/analytics/functions/useAnalytics.md"},{"text":"useLogEvent","link":"/react-native/analytics/functions/useLogEvent.md"},{"text":"useSetAnalyticsCollectionEnabled","link":"/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md"}]}]},{"text":"auth","link":"/react-native/auth/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"UseCreateUserWitEmailAndPasswordMutationVariables","link":"/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md"},{"text":"UseIdTokenResult","link":"/react-native/auth/type-aliases/UseIdTokenResult.md"},{"text":"UseReauthenticateWitCredentialMutationVariables","link":"/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md"},{"text":"UseReauthenticateWitRedirectMutationVariables","link":"/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md"},{"text":"UseSendEmailVerificationMutationVariables","link":"/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md"},{"text":"UseSignInWitEmailAndPasswordMutationVariables","link":"/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md"},{"text":"UseSignInWitRedirectMutationVariables","link":"/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md"},{"text":"UseUpdateProfileMutationVariables","link":"/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY","link":"/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY","link":"/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SEND_EMAIL_VERIFICATION_MUTATION_KEY","link":"/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_REDIRECT_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SIGN_OUT_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAuth","link":"/react-native/auth/functions/useAuth.md"},{"text":"useCreateUserWitEmailAndPasswordMutation","link":"/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md"},{"text":"useCurrentUser","link":"/react-native/auth/functions/useCurrentUser.md"},{"text":"useReauthenticateWitCredentialMutation","link":"/react-native/auth/functions/useReauthenticateWitCredentialMutation.md"},{"text":"useReauthenticateWitRedirectMutation","link":"/react-native/auth/functions/useReauthenticateWitRedirectMutation.md"},{"text":"useSendEmailVerificationMutation","link":"/react-native/auth/functions/useSendEmailVerificationMutation.md"},{"text":"useSignInWitEmailAndPasswordMutation","link":"/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md"},{"text":"useSignInWitRedirectMutation","link":"/react-native/auth/functions/useSignInWitRedirectMutation.md"},{"text":"useSignOutMutation","link":"/react-native/auth/functions/useSignOutMutation.md"},{"text":"useUpdateProfileMutation","link":"/react-native/auth/functions/useUpdateProfileMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useIdToken","link":"/react-native/auth/functions/useIdToken.md"}]}]},{"text":"firestore","link":"/react-native/firestore/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"CompositeFilter","link":"/react-native/firestore/type-aliases/CompositeFilter.md"},{"text":"QueryElement","link":"/react-native/firestore/type-aliases/QueryElement.md"},{"text":"UseAddDocMutationOptions","link":"/react-native/firestore/type-aliases/UseAddDocMutationOptions.md"},{"text":"UseAddDocMutationValues","link":"/react-native/firestore/type-aliases/UseAddDocMutationValues.md"},{"text":"UseBatchWriteOptions","link":"/react-native/firestore/type-aliases/UseBatchWriteOptions.md"},{"text":"UseBatchWriteVariables","link":"/react-native/firestore/type-aliases/UseBatchWriteVariables.md"},{"text":"UseCollectionReferenceOptions","link":"/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md"},{"text":"UseCompositeFilter","link":"/react-native/firestore/type-aliases/UseCompositeFilter.md"},{"text":"UseDeleteDocMutationOptions","link":"/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md"},{"text":"UseDeleteDocMutationValues","link":"/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md"},{"text":"UseDocReferenceOptions","link":"/react-native/firestore/type-aliases/UseDocReferenceOptions.md"},{"text":"UseDocReferencesOptions","link":"/react-native/firestore/type-aliases/UseDocReferencesOptions.md"},{"text":"UseGetRealtimeDocDataOptions","link":"/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md"},{"text":"UseGetRealtimeDocDataResult","link":"/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md"},{"text":"UseQueryConstraints","link":"/react-native/firestore/type-aliases/UseQueryConstraints.md"},{"text":"UseRunTransactionOptions","link":"/react-native/firestore/type-aliases/UseRunTransactionOptions.md"},{"text":"UseRunTransactionValues","link":"/react-native/firestore/type-aliases/UseRunTransactionValues.md"},{"text":"UseSetDocMutationOptions","link":"/react-native/firestore/type-aliases/UseSetDocMutationOptions.md"},{"text":"UseSetDocMutationValues","link":"/react-native/firestore/type-aliases/UseSetDocMutationValues.md"},{"text":"UseUpdateDocMutationOptions","link":"/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md"},{"text":"UseUpdateDocMutationValues","link":"/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildCompositeFilter","link":"/react-native/firestore/functions/buildCompositeFilter.md"},{"text":"useAddDocMutation","link":"/react-native/firestore/functions/useAddDocMutation.md"},{"text":"useBatchWrite","link":"/react-native/firestore/functions/useBatchWrite.md"},{"text":"useCollectionReference","link":"/react-native/firestore/functions/useCollectionReference.md"},{"text":"useCompositeFilter","link":"/react-native/firestore/functions/useCompositeFilter.md"},{"text":"useCountQuery","link":"/react-native/firestore/functions/useCountQuery.md"},{"text":"useDeleteDocMutation","link":"/react-native/firestore/functions/useDeleteDocMutation.md"},{"text":"useDocReference","link":"/react-native/firestore/functions/useDocReference.md"},{"text":"useDocReferences","link":"/react-native/firestore/functions/useDocReferences.md"},{"text":"useFirestore","link":"/react-native/firestore/functions/useFirestore.md"},{"text":"useGetDocData","link":"/react-native/firestore/functions/useGetDocData.md"},{"text":"useInfiniteQuery","link":"/react-native/firestore/functions/useInfiniteQuery.md"},{"text":"useQuery","link":"/react-native/firestore/functions/useQuery.md"},{"text":"useRunTransaction","link":"/react-native/firestore/functions/useRunTransaction.md"},{"text":"useSetDocMutation","link":"/react-native/firestore/functions/useSetDocMutation.md"},{"text":"useUpdateDocMutation","link":"/react-native/firestore/functions/useUpdateDocMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useGetRealtimeDocData","link":"/react-native/firestore/functions/useGetRealtimeDocData.md"},{"text":"useQueryConstraints","link":"/react-native/firestore/functions/useQueryConstraints.md"}]},{"text":"Utility","collapsed":true,"items":[{"text":"buildQueryConstraint","link":"/react-native/firestore/functions/buildQueryConstraint.md"}]}]},{"text":"remoteConfig","link":"/react-native/remoteConfig/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useFetchAndActivate","link":"/react-native/remoteConfig/functions/useFetchAndActivate.md"},{"text":"useGetValue","link":"/react-native/remoteConfig/functions/useGetValue.md"},{"text":"useRemoteConfig","link":"/react-native/remoteConfig/functions/useRemoteConfig.md"}]}]}]},{"text":"types","link":"/types/","collapsed":true,"items":[{"text":"Models","collapsed":true,"items":[{"text":"AppModel","link":"/types/type-aliases/AppModel.md"}]},{"text":"Query Constraints","collapsed":true,"items":[{"text":"EndConstraint","link":"/types/type-aliases/EndConstraint.md"},{"text":"LimitConstraint","link":"/types/type-aliases/LimitConstraint.md"},{"text":"NonFilterQueryConstraint","link":"/types/type-aliases/NonFilterQueryConstraint.md"},{"text":"OrderByConstraint","link":"/types/type-aliases/OrderByConstraint.md"},{"text":"StartConstraint","link":"/types/type-aliases/StartConstraint.md"}]}]},{"text":"web","link":"/web/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"FirebaseContextProviderAuthEmulatorConfig","link":"/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md"},{"text":"FirebaseContextProviderEmulators","link":"/web/type-aliases/FirebaseContextProviderEmulators.md"},{"text":"FirebaseContextProviderFirestoreEmulatorConfig","link":"/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md"},{"text":"FirebaseContextProviderProps","link":"/web/type-aliases/FirebaseContextProviderProps.md"}]},{"text":"Component","collapsed":true,"items":[{"text":"FirebaseContextProvider","link":"/web/variables/FirebaseContextProvider.md"}]},{"text":"analytics","link":"/web/analytics/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useAnalytics","link":"/web/analytics/functions/useAnalytics.md"},{"text":"useLogEvent","link":"/web/analytics/functions/useLogEvent.md"},{"text":"useSetAnalyticsCollectionEnabled","link":"/web/analytics/functions/useSetAnalyticsCollectionEnabled.md"}]}]},{"text":"auth","link":"/web/auth/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"UseCreateUserWitEmailAndPasswordMutationVariables","link":"/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md"},{"text":"UseIdTokenResult","link":"/web/auth/type-aliases/UseIdTokenResult.md"},{"text":"UseReauthenticateWitCredentialMutationVariables","link":"/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md"},{"text":"UseReauthenticateWitRedirectMutationVariables","link":"/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md"},{"text":"UseSendEmailVerificationMutationVariables","link":"/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md"},{"text":"UseSignInWitEmailAndPasswordMutationVariables","link":"/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md"},{"text":"UseSignInWitRedirectMutationVariables","link":"/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md"},{"text":"UseUpdateProfileMutationVariables","link":"/web/auth/type-aliases/UseUpdateProfileMutationVariables.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY","link":"/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY","link":"/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SEND_EMAIL_VERIFICATION_MUTATION_KEY","link":"/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_REDIRECT_MUTATION_KEY","link":"/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SIGN_OUT_MUTATION_KEY","link":"/web/auth/variables/SIGN_OUT_MUTATION_KEY.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAuth","link":"/web/auth/functions/useAuth.md"},{"text":"useAuthStateReady","link":"/web/auth/functions/useAuthStateReady.md"},{"text":"useCreateUserWitEmailAndPasswordMutation","link":"/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md"},{"text":"useCurrentUser","link":"/web/auth/functions/useCurrentUser.md"},{"text":"useReauthenticateWitCredentialMutation","link":"/web/auth/functions/useReauthenticateWitCredentialMutation.md"},{"text":"useReauthenticateWitRedirectMutation","link":"/web/auth/functions/useReauthenticateWitRedirectMutation.md"},{"text":"useSendEmailVerificationMutation","link":"/web/auth/functions/useSendEmailVerificationMutation.md"},{"text":"useSignInWitEmailAndPasswordMutation","link":"/web/auth/functions/useSignInWitEmailAndPasswordMutation.md"},{"text":"useSignInWitRedirectMutation","link":"/web/auth/functions/useSignInWitRedirectMutation.md"},{"text":"useSignOutMutation","link":"/web/auth/functions/useSignOutMutation.md"},{"text":"useUpdateProfileMutation","link":"/web/auth/functions/useUpdateProfileMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useIdToken","link":"/web/auth/functions/useIdToken.md"}]}]},{"text":"firestore","link":"/web/firestore/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"CompositeFilter","link":"/web/firestore/type-aliases/CompositeFilter.md"},{"text":"QueryElement","link":"/web/firestore/type-aliases/QueryElement.md"},{"text":"UseAddDocMutationOptions","link":"/web/firestore/type-aliases/UseAddDocMutationOptions.md"},{"text":"UseAddDocMutationValues","link":"/web/firestore/type-aliases/UseAddDocMutationValues.md"},{"text":"UseBatchWriteOptions","link":"/web/firestore/type-aliases/UseBatchWriteOptions.md"},{"text":"UseBatchWriteVariables","link":"/web/firestore/type-aliases/UseBatchWriteVariables.md"},{"text":"UseCollectionReferenceOptions","link":"/web/firestore/type-aliases/UseCollectionReferenceOptions.md"},{"text":"UseCompositeFilter","link":"/web/firestore/type-aliases/UseCompositeFilter.md"},{"text":"UseDeleteDocMutationOptions","link":"/web/firestore/type-aliases/UseDeleteDocMutationOptions.md"},{"text":"UseDeleteDocMutationValues","link":"/web/firestore/type-aliases/UseDeleteDocMutationValues.md"},{"text":"UseDocReferenceOptions","link":"/web/firestore/type-aliases/UseDocReferenceOptions.md"},{"text":"UseDocReferencesOptions","link":"/web/firestore/type-aliases/UseDocReferencesOptions.md"},{"text":"UseGetRealtimeDocDataOptions","link":"/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md"},{"text":"UseGetRealtimeDocDataResult","link":"/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md"},{"text":"UseQueryConstraints","link":"/web/firestore/type-aliases/UseQueryConstraints.md"},{"text":"UseRunTransactionOptions","link":"/web/firestore/type-aliases/UseRunTransactionOptions.md"},{"text":"UseRunTransactionValues","link":"/web/firestore/type-aliases/UseRunTransactionValues.md"},{"text":"UseSetDocMutationOptions","link":"/web/firestore/type-aliases/UseSetDocMutationOptions.md"},{"text":"UseSetDocMutationValues","link":"/web/firestore/type-aliases/UseSetDocMutationValues.md"},{"text":"UseUpdateDocMutationOptions","link":"/web/firestore/type-aliases/UseUpdateDocMutationOptions.md"},{"text":"UseUpdateDocMutationValues","link":"/web/firestore/type-aliases/UseUpdateDocMutationValues.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildCompositeFilter","link":"/web/firestore/functions/buildCompositeFilter.md"},{"text":"useAddDocMutation","link":"/web/firestore/functions/useAddDocMutation.md"},{"text":"useBatchWrite","link":"/web/firestore/functions/useBatchWrite.md"},{"text":"useCollectionReference","link":"/web/firestore/functions/useCollectionReference.md"},{"text":"useCompositeFilter","link":"/web/firestore/functions/useCompositeFilter.md"},{"text":"useCountQuery","link":"/web/firestore/functions/useCountQuery.md"},{"text":"useDeleteDocMutation","link":"/web/firestore/functions/useDeleteDocMutation.md"},{"text":"useDocReference","link":"/web/firestore/functions/useDocReference.md"},{"text":"useDocReferences","link":"/web/firestore/functions/useDocReferences.md"},{"text":"useFirestore","link":"/web/firestore/functions/useFirestore.md"},{"text":"useGetDocData","link":"/web/firestore/functions/useGetDocData.md"},{"text":"useInfiniteQuery","link":"/web/firestore/functions/useInfiniteQuery.md"},{"text":"useQuery","link":"/web/firestore/functions/useQuery.md"},{"text":"useRunTransaction","link":"/web/firestore/functions/useRunTransaction.md"},{"text":"useSetDocMutation","link":"/web/firestore/functions/useSetDocMutation.md"},{"text":"useUpdateDocMutation","link":"/web/firestore/functions/useUpdateDocMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useGetRealtimeDocData","link":"/web/firestore/functions/useGetRealtimeDocData.md"},{"text":"useQueryConstraints","link":"/web/firestore/functions/useQueryConstraints.md"}]},{"text":"Utility","collapsed":true,"items":[{"text":"buildQueryConstraint","link":"/web/firestore/functions/buildQueryConstraint.md"}]}]},{"text":"remoteConfig","link":"/web/remoteConfig/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useFetchAndActivate","link":"/web/remoteConfig/functions/useFetchAndActivate.md"},{"text":"useGetValue","link":"/web/remoteConfig/functions/useGetValue.md"},{"text":"useRemoteConfig","link":"/web/remoteConfig/functions/useRemoteConfig.md"}]}]}]}] \ No newline at end of file +[{"text":"react-native","link":"/react-native/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"FirebaseContextProviderAuthEmulatorConfig","link":"/react-native/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md"},{"text":"FirebaseContextProviderEmulators","link":"/react-native/type-aliases/FirebaseContextProviderEmulators.md"},{"text":"FirebaseContextProviderFirestoreEmulatorConfig","link":"/react-native/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md"},{"text":"FirebaseContextProviderProps","link":"/react-native/type-aliases/FirebaseContextProviderProps.md"},{"text":"FirestoreSettings","link":"/react-native/type-aliases/FirestoreSettings.md"}]},{"text":"Component","collapsed":true,"items":[{"text":"FirebaseContextProvider","link":"/react-native/variables/FirebaseContextProvider.md"}]},{"text":"analytics","link":"/react-native/analytics/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useAnalytics","link":"/react-native/analytics/functions/useAnalytics.md"},{"text":"useLogEvent","link":"/react-native/analytics/functions/useLogEvent.md"},{"text":"useSetAnalyticsCollectionEnabled","link":"/react-native/analytics/functions/useSetAnalyticsCollectionEnabled.md"}]}]},{"text":"auth","link":"/react-native/auth/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"UseCreateUserWitEmailAndPasswordMutationVariables","link":"/react-native/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md"},{"text":"UseIdTokenResult","link":"/react-native/auth/type-aliases/UseIdTokenResult.md"},{"text":"UseReauthenticateWitCredentialMutationVariables","link":"/react-native/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md"},{"text":"UseReauthenticateWitRedirectMutationVariables","link":"/react-native/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md"},{"text":"UseSendEmailVerificationMutationVariables","link":"/react-native/auth/type-aliases/UseSendEmailVerificationMutationVariables.md"},{"text":"UseSignInWitEmailAndPasswordMutationVariables","link":"/react-native/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md"},{"text":"UseSignInWitRedirectMutationVariables","link":"/react-native/auth/type-aliases/UseSignInWitRedirectMutationVariables.md"},{"text":"UseUpdateProfileMutationVariables","link":"/react-native/auth/type-aliases/UseUpdateProfileMutationVariables.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/react-native/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY","link":"/react-native/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY","link":"/react-native/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SEND_EMAIL_VERIFICATION_MUTATION_KEY","link":"/react-native/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_REDIRECT_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SIGN_OUT_MUTATION_KEY","link":"/react-native/auth/variables/SIGN_OUT_MUTATION_KEY.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAuth","link":"/react-native/auth/functions/useAuth.md"},{"text":"useCreateUserWitEmailAndPasswordMutation","link":"/react-native/auth/functions/useCreateUserWitEmailAndPasswordMutation.md"},{"text":"useCurrentUser","link":"/react-native/auth/functions/useCurrentUser.md"},{"text":"useReauthenticateWitCredentialMutation","link":"/react-native/auth/functions/useReauthenticateWitCredentialMutation.md"},{"text":"useReauthenticateWitRedirectMutation","link":"/react-native/auth/functions/useReauthenticateWitRedirectMutation.md"},{"text":"useSendEmailVerificationMutation","link":"/react-native/auth/functions/useSendEmailVerificationMutation.md"},{"text":"useSignInWitEmailAndPasswordMutation","link":"/react-native/auth/functions/useSignInWitEmailAndPasswordMutation.md"},{"text":"useSignInWitRedirectMutation","link":"/react-native/auth/functions/useSignInWitRedirectMutation.md"},{"text":"useSignOutMutation","link":"/react-native/auth/functions/useSignOutMutation.md"},{"text":"useUpdateProfileMutation","link":"/react-native/auth/functions/useUpdateProfileMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useAuthStateReady","link":"/react-native/auth/functions/useAuthStateReady.md"},{"text":"useIdToken","link":"/react-native/auth/functions/useIdToken.md"}]}]},{"text":"firestore","link":"/react-native/firestore/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"CompositeFilter","link":"/react-native/firestore/type-aliases/CompositeFilter.md"},{"text":"QueryElement","link":"/react-native/firestore/type-aliases/QueryElement.md"},{"text":"QueryFilterConstraint","link":"/react-native/firestore/type-aliases/QueryFilterConstraint.md"},{"text":"UseAddDocMutationOptions","link":"/react-native/firestore/type-aliases/UseAddDocMutationOptions.md"},{"text":"UseAddDocMutationValues","link":"/react-native/firestore/type-aliases/UseAddDocMutationValues.md"},{"text":"UseBatchWriteOptions","link":"/react-native/firestore/type-aliases/UseBatchWriteOptions.md"},{"text":"UseBatchWriteVariables","link":"/react-native/firestore/type-aliases/UseBatchWriteVariables.md"},{"text":"UseCollectionReferenceOptions","link":"/react-native/firestore/type-aliases/UseCollectionReferenceOptions.md"},{"text":"UseCompositeFilter","link":"/react-native/firestore/type-aliases/UseCompositeFilter.md"},{"text":"UseDeleteDocMutationOptions","link":"/react-native/firestore/type-aliases/UseDeleteDocMutationOptions.md"},{"text":"UseDeleteDocMutationValues","link":"/react-native/firestore/type-aliases/UseDeleteDocMutationValues.md"},{"text":"UseDocReferenceOptions","link":"/react-native/firestore/type-aliases/UseDocReferenceOptions.md"},{"text":"UseDocReferencesOptions","link":"/react-native/firestore/type-aliases/UseDocReferencesOptions.md"},{"text":"UseGetRealtimeDocDataOptions","link":"/react-native/firestore/type-aliases/UseGetRealtimeDocDataOptions.md"},{"text":"UseGetRealtimeDocDataResult","link":"/react-native/firestore/type-aliases/UseGetRealtimeDocDataResult.md"},{"text":"UseQueryConstraints","link":"/react-native/firestore/type-aliases/UseQueryConstraints.md"},{"text":"UseRunTransactionOptions","link":"/react-native/firestore/type-aliases/UseRunTransactionOptions.md"},{"text":"UseRunTransactionValues","link":"/react-native/firestore/type-aliases/UseRunTransactionValues.md"},{"text":"UseSetDocMutationOptions","link":"/react-native/firestore/type-aliases/UseSetDocMutationOptions.md"},{"text":"UseSetDocMutationValues","link":"/react-native/firestore/type-aliases/UseSetDocMutationValues.md"},{"text":"UseUpdateDocMutationOptions","link":"/react-native/firestore/type-aliases/UseUpdateDocMutationOptions.md"},{"text":"UseUpdateDocMutationValues","link":"/react-native/firestore/type-aliases/UseUpdateDocMutationValues.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAddDocMutation","link":"/react-native/firestore/functions/useAddDocMutation.md"},{"text":"useBatchWrite","link":"/react-native/firestore/functions/useBatchWrite.md"},{"text":"useCollectionReference","link":"/react-native/firestore/functions/useCollectionReference.md"},{"text":"useDeleteDocMutation","link":"/react-native/firestore/functions/useDeleteDocMutation.md"},{"text":"useDocReference","link":"/react-native/firestore/functions/useDocReference.md"},{"text":"useDocReferences","link":"/react-native/firestore/functions/useDocReferences.md"},{"text":"useFirestore","link":"/react-native/firestore/functions/useFirestore.md"},{"text":"useGetDocData","link":"/react-native/firestore/functions/useGetDocData.md"},{"text":"useRunTransaction","link":"/react-native/firestore/functions/useRunTransaction.md"},{"text":"useSetDocMutation","link":"/react-native/firestore/functions/useSetDocMutation.md"},{"text":"useUpdateDocMutation","link":"/react-native/firestore/functions/useUpdateDocMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useCompositeFilter","link":"/react-native/firestore/functions/useCompositeFilter.md"},{"text":"useCountQuery","link":"/react-native/firestore/functions/useCountQuery.md"},{"text":"useGetRealtimeDocData","link":"/react-native/firestore/functions/useGetRealtimeDocData.md"},{"text":"useInfiniteQuery","link":"/react-native/firestore/functions/useInfiniteQuery.md"},{"text":"useQuery","link":"/react-native/firestore/functions/useQuery.md"},{"text":"useQueryConstraints","link":"/react-native/firestore/functions/useQueryConstraints.md"}]},{"text":"Utility","collapsed":true,"items":[{"text":"buildCompositeFilter","link":"/react-native/firestore/functions/buildCompositeFilter.md"},{"text":"buildQueryConstraint","link":"/react-native/firestore/functions/buildQueryConstraint.md"}]}]},{"text":"remoteConfig","link":"/react-native/remoteConfig/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useFetchAndActivate","link":"/react-native/remoteConfig/functions/useFetchAndActivate.md"},{"text":"useGetValue","link":"/react-native/remoteConfig/functions/useGetValue.md"},{"text":"useRemoteConfig","link":"/react-native/remoteConfig/functions/useRemoteConfig.md"}]}]}]},{"text":"types","link":"/types/","collapsed":true,"items":[{"text":"Models","collapsed":true,"items":[{"text":"AppModel","link":"/types/type-aliases/AppModel.md"}]},{"text":"Query Constraints","collapsed":true,"items":[{"text":"EndConstraint","link":"/types/type-aliases/EndConstraint.md"},{"text":"LimitConstraint","link":"/types/type-aliases/LimitConstraint.md"},{"text":"NonFilterQueryConstraint","link":"/types/type-aliases/NonFilterQueryConstraint.md"},{"text":"OrderByConstraint","link":"/types/type-aliases/OrderByConstraint.md"},{"text":"StartConstraint","link":"/types/type-aliases/StartConstraint.md"}]}]},{"text":"web","link":"/web/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"FirebaseContextProviderAuthEmulatorConfig","link":"/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md"},{"text":"FirebaseContextProviderEmulators","link":"/web/type-aliases/FirebaseContextProviderEmulators.md"},{"text":"FirebaseContextProviderFirestoreEmulatorConfig","link":"/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md"},{"text":"FirebaseContextProviderProps","link":"/web/type-aliases/FirebaseContextProviderProps.md"}]},{"text":"Component","collapsed":true,"items":[{"text":"FirebaseContextProvider","link":"/web/variables/FirebaseContextProvider.md"}]},{"text":"analytics","link":"/web/analytics/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useAnalytics","link":"/web/analytics/functions/useAnalytics.md"},{"text":"useLogEvent","link":"/web/analytics/functions/useLogEvent.md"},{"text":"useSetAnalyticsCollectionEnabled","link":"/web/analytics/functions/useSetAnalyticsCollectionEnabled.md"}]}]},{"text":"auth","link":"/web/auth/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"UseCreateUserWitEmailAndPasswordMutationVariables","link":"/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md"},{"text":"UseIdTokenResult","link":"/web/auth/type-aliases/UseIdTokenResult.md"},{"text":"UseReauthenticateWitCredentialMutationVariables","link":"/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md"},{"text":"UseReauthenticateWitRedirectMutationVariables","link":"/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md"},{"text":"UseSendEmailVerificationMutationVariables","link":"/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md"},{"text":"UseSignInWitEmailAndPasswordMutationVariables","link":"/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md"},{"text":"UseSignInWitRedirectMutationVariables","link":"/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md"},{"text":"UseUpdateProfileMutationVariables","link":"/web/auth/type-aliases/UseUpdateProfileMutationVariables.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY","link":"/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md"},{"text":"REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY","link":"/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SEND_EMAIL_VERIFICATION_MUTATION_KEY","link":"/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY","link":"/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md"},{"text":"SIGN_IN_WITH_REDIRECT_MUTATION_KEY","link":"/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md"},{"text":"SIGN_OUT_MUTATION_KEY","link":"/web/auth/variables/SIGN_OUT_MUTATION_KEY.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAuth","link":"/web/auth/functions/useAuth.md"},{"text":"useCreateUserWitEmailAndPasswordMutation","link":"/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md"},{"text":"useCurrentUser","link":"/web/auth/functions/useCurrentUser.md"},{"text":"useReauthenticateWitCredentialMutation","link":"/web/auth/functions/useReauthenticateWitCredentialMutation.md"},{"text":"useReauthenticateWitRedirectMutation","link":"/web/auth/functions/useReauthenticateWitRedirectMutation.md"},{"text":"useSendEmailVerificationMutation","link":"/web/auth/functions/useSendEmailVerificationMutation.md"},{"text":"useSignInWitEmailAndPasswordMutation","link":"/web/auth/functions/useSignInWitEmailAndPasswordMutation.md"},{"text":"useSignInWitRedirectMutation","link":"/web/auth/functions/useSignInWitRedirectMutation.md"},{"text":"useSignOutMutation","link":"/web/auth/functions/useSignOutMutation.md"},{"text":"useUpdateProfileMutation","link":"/web/auth/functions/useUpdateProfileMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useAuthStateReady","link":"/web/auth/functions/useAuthStateReady.md"},{"text":"useIdToken","link":"/web/auth/functions/useIdToken.md"}]}]},{"text":"firestore","link":"/web/firestore/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"CompositeFilter","link":"/web/firestore/type-aliases/CompositeFilter.md"},{"text":"QueryElement","link":"/web/firestore/type-aliases/QueryElement.md"},{"text":"QueryFilterConstraint","link":"/web/firestore/type-aliases/QueryFilterConstraint.md"},{"text":"UseAddDocMutationOptions","link":"/web/firestore/type-aliases/UseAddDocMutationOptions.md"},{"text":"UseAddDocMutationValues","link":"/web/firestore/type-aliases/UseAddDocMutationValues.md"},{"text":"UseBatchWriteOptions","link":"/web/firestore/type-aliases/UseBatchWriteOptions.md"},{"text":"UseBatchWriteVariables","link":"/web/firestore/type-aliases/UseBatchWriteVariables.md"},{"text":"UseCollectionReferenceOptions","link":"/web/firestore/type-aliases/UseCollectionReferenceOptions.md"},{"text":"UseCompositeFilter","link":"/web/firestore/type-aliases/UseCompositeFilter.md"},{"text":"UseDeleteDocMutationOptions","link":"/web/firestore/type-aliases/UseDeleteDocMutationOptions.md"},{"text":"UseDeleteDocMutationValues","link":"/web/firestore/type-aliases/UseDeleteDocMutationValues.md"},{"text":"UseDocReferenceOptions","link":"/web/firestore/type-aliases/UseDocReferenceOptions.md"},{"text":"UseDocReferencesOptions","link":"/web/firestore/type-aliases/UseDocReferencesOptions.md"},{"text":"UseGetRealtimeDocDataOptions","link":"/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md"},{"text":"UseGetRealtimeDocDataResult","link":"/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md"},{"text":"UseQueryConstraints","link":"/web/firestore/type-aliases/UseQueryConstraints.md"},{"text":"UseRunTransactionOptions","link":"/web/firestore/type-aliases/UseRunTransactionOptions.md"},{"text":"UseRunTransactionValues","link":"/web/firestore/type-aliases/UseRunTransactionValues.md"},{"text":"UseSetDocMutationOptions","link":"/web/firestore/type-aliases/UseSetDocMutationOptions.md"},{"text":"UseSetDocMutationValues","link":"/web/firestore/type-aliases/UseSetDocMutationValues.md"},{"text":"UseUpdateDocMutationOptions","link":"/web/firestore/type-aliases/UseUpdateDocMutationOptions.md"},{"text":"UseUpdateDocMutationValues","link":"/web/firestore/type-aliases/UseUpdateDocMutationValues.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"useAddDocMutation","link":"/web/firestore/functions/useAddDocMutation.md"},{"text":"useBatchWrite","link":"/web/firestore/functions/useBatchWrite.md"},{"text":"useCollectionReference","link":"/web/firestore/functions/useCollectionReference.md"},{"text":"useDeleteDocMutation","link":"/web/firestore/functions/useDeleteDocMutation.md"},{"text":"useDocReference","link":"/web/firestore/functions/useDocReference.md"},{"text":"useDocReferences","link":"/web/firestore/functions/useDocReferences.md"},{"text":"useFirestore","link":"/web/firestore/functions/useFirestore.md"},{"text":"useGetDocData","link":"/web/firestore/functions/useGetDocData.md"},{"text":"useRunTransaction","link":"/web/firestore/functions/useRunTransaction.md"},{"text":"useSetDocMutation","link":"/web/firestore/functions/useSetDocMutation.md"},{"text":"useUpdateDocMutation","link":"/web/firestore/functions/useUpdateDocMutation.md"}]},{"text":"Hook","collapsed":true,"items":[{"text":"useCompositeFilter","link":"/web/firestore/functions/useCompositeFilter.md"},{"text":"useCountQuery","link":"/web/firestore/functions/useCountQuery.md"},{"text":"useGetRealtimeDocData","link":"/web/firestore/functions/useGetRealtimeDocData.md"},{"text":"useInfiniteQuery","link":"/web/firestore/functions/useInfiniteQuery.md"},{"text":"useQuery","link":"/web/firestore/functions/useQuery.md"},{"text":"useQueryConstraints","link":"/web/firestore/functions/useQueryConstraints.md"}]},{"text":"Utility","collapsed":true,"items":[{"text":"buildCompositeFilter","link":"/web/firestore/functions/buildCompositeFilter.md"},{"text":"buildQueryConstraint","link":"/web/firestore/functions/buildQueryConstraint.md"}]}]},{"text":"remoteConfig","link":"/web/remoteConfig/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"useFetchAndActivate","link":"/web/remoteConfig/functions/useFetchAndActivate.md"},{"text":"useGetValue","link":"/web/remoteConfig/functions/useGetValue.md"},{"text":"useRemoteConfig","link":"/web/remoteConfig/functions/useRemoteConfig.md"}]}]}]}] \ No newline at end of file diff --git a/docs/types/type-aliases/AppModel.md b/docs/types/type-aliases/AppModel.md index 2fd16fe..36fe2ee 100644 --- a/docs/types/type-aliases/AppModel.md +++ b/docs/types/type-aliases/AppModel.md @@ -6,7 +6,7 @@ type AppModel = object; ``` -Defined in: types/AppModel.ts:5 +Defined in: [types/AppModel.ts:5](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/AppModel.ts#L5) Generic definition for a data model diff --git a/docs/types/type-aliases/EndConstraint.md b/docs/types/type-aliases/EndConstraint.md index 6be36bb..5b1738b 100644 --- a/docs/types/type-aliases/EndConstraint.md +++ b/docs/types/type-aliases/EndConstraint.md @@ -6,7 +6,7 @@ type EndConstraint = object; ``` -Defined in: types/QueryConstraints.ts:35 +Defined in: [types/QueryConstraints.ts:35](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L35) End by value constraint @@ -18,7 +18,7 @@ End by value constraint optional key: string; ``` -Defined in: types/QueryConstraints.ts:38 +Defined in: [types/QueryConstraints.ts:38](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L38) *** @@ -28,7 +28,7 @@ Defined in: types/QueryConstraints.ts:38 type: "endAt" | "endBefore"; ``` -Defined in: types/QueryConstraints.ts:36 +Defined in: [types/QueryConstraints.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L36) *** @@ -38,4 +38,4 @@ Defined in: types/QueryConstraints.ts:36 value: number | string | boolean | null; ``` -Defined in: types/QueryConstraints.ts:37 +Defined in: [types/QueryConstraints.ts:37](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L37) diff --git a/docs/types/type-aliases/LimitConstraint.md b/docs/types/type-aliases/LimitConstraint.md index 85977bc..594e4f2 100644 --- a/docs/types/type-aliases/LimitConstraint.md +++ b/docs/types/type-aliases/LimitConstraint.md @@ -6,7 +6,7 @@ type LimitConstraint = object; ``` -Defined in: types/QueryConstraints.ts:45 +Defined in: [types/QueryConstraints.ts:45](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L45) Limit constraint @@ -18,7 +18,7 @@ Limit constraint limit: number; ``` -Defined in: types/QueryConstraints.ts:47 +Defined in: [types/QueryConstraints.ts:47](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L47) *** @@ -28,4 +28,4 @@ Defined in: types/QueryConstraints.ts:47 type: "limitToLast" | "limit"; ``` -Defined in: types/QueryConstraints.ts:46 +Defined in: [types/QueryConstraints.ts:46](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L46) diff --git a/docs/types/type-aliases/NonFilterQueryConstraint.md b/docs/types/type-aliases/NonFilterQueryConstraint.md index 56fee71..0252bbd 100644 --- a/docs/types/type-aliases/NonFilterQueryConstraint.md +++ b/docs/types/type-aliases/NonFilterQueryConstraint.md @@ -10,7 +10,7 @@ type NonFilterQueryConstraint = | LimitConstraint; ``` -Defined in: types/QueryConstraints.ts:54 +Defined in: [types/QueryConstraints.ts:54](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L54) Non filtering query constaints diff --git a/docs/types/type-aliases/OrderByConstraint.md b/docs/types/type-aliases/OrderByConstraint.md index 1f27ac5..7f3b275 100644 --- a/docs/types/type-aliases/OrderByConstraint.md +++ b/docs/types/type-aliases/OrderByConstraint.md @@ -6,7 +6,7 @@ type OrderByConstraint = object; ``` -Defined in: types/QueryConstraints.ts:7 +Defined in: [types/QueryConstraints.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L7) Order by constraint @@ -24,7 +24,7 @@ Order by constraint directionStr: "asc" | "desc"; ``` -Defined in: types/QueryConstraints.ts:19 +Defined in: [types/QueryConstraints.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L19) Direction of ordering: asc or desc @@ -36,7 +36,7 @@ Direction of ordering: asc or desc fieldPath: keyof AppModelType; ``` -Defined in: types/QueryConstraints.ts:15 +Defined in: [types/QueryConstraints.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L15) Field path to use for ordering @@ -48,6 +48,6 @@ Field path to use for ordering type: "orderBy"; ``` -Defined in: types/QueryConstraints.ts:11 +Defined in: [types/QueryConstraints.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L11) Type of a constraint diff --git a/docs/types/type-aliases/StartConstraint.md b/docs/types/type-aliases/StartConstraint.md index fdc6b80..a390a40 100644 --- a/docs/types/type-aliases/StartConstraint.md +++ b/docs/types/type-aliases/StartConstraint.md @@ -6,7 +6,7 @@ type StartConstraint = object; ``` -Defined in: types/QueryConstraints.ts:26 +Defined in: [types/QueryConstraints.ts:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L26) Start from value constraint @@ -18,7 +18,7 @@ Start from value constraint arguments: unknown[]; ``` -Defined in: types/QueryConstraints.ts:28 +Defined in: [types/QueryConstraints.ts:28](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L28) *** @@ -28,4 +28,4 @@ Defined in: types/QueryConstraints.ts:28 type: "startAt" | "startAfter"; ``` -Defined in: types/QueryConstraints.ts:27 +Defined in: [types/QueryConstraints.ts:27](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/types/QueryConstraints.ts#L27) diff --git a/docs/web/analytics/functions/useAnalytics.md b/docs/web/analytics/functions/useAnalytics.md index f6d6d0d..bc3f44a 100644 --- a/docs/web/analytics/functions/useAnalytics.md +++ b/docs/web/analytics/functions/useAnalytics.md @@ -6,7 +6,7 @@ function useAnalytics(): Analytics ``` -Defined in: [web/analytics/useAnalytics.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/analytics/useAnalytics.ts#L9) +Defined in: [web/analytics/useAnalytics.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/analytics/useAnalytics.ts#L9) Hook to access Firebase analytics from the Firebase context. diff --git a/docs/web/analytics/functions/useLogEvent.md b/docs/web/analytics/functions/useLogEvent.md index cead2ce..f52c36a 100644 --- a/docs/web/analytics/functions/useLogEvent.md +++ b/docs/web/analytics/functions/useLogEvent.md @@ -6,7 +6,7 @@ function useLogEvent(options): object ``` -Defined in: [web/analytics/useLogEvent.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/analytics/useLogEvent.ts#L19) +Defined in: [web/analytics/useLogEvent.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/analytics/useLogEvent.ts#L19) Custom hook to create a log event function that logs an analytics event with specified parameters. diff --git a/docs/web/analytics/functions/useSetAnalyticsCollectionEnabled.md b/docs/web/analytics/functions/useSetAnalyticsCollectionEnabled.md index 97c4bc1..536f76a 100644 --- a/docs/web/analytics/functions/useSetAnalyticsCollectionEnabled.md +++ b/docs/web/analytics/functions/useSetAnalyticsCollectionEnabled.md @@ -6,7 +6,7 @@ function useSetAnalyticsCollectionEnabled(options): void ``` -Defined in: [web/analytics/useSetAnalyticsCollectionEnabled.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/analytics/useSetAnalyticsCollectionEnabled.ts#L14) +Defined in: [web/analytics/useSetAnalyticsCollectionEnabled.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/analytics/useSetAnalyticsCollectionEnabled.ts#L14) Custom hook to enable or disable analytics collection diff --git a/docs/web/auth/functions/useAuth.md b/docs/web/auth/functions/useAuth.md index bb97d5e..4e0e873 100644 --- a/docs/web/auth/functions/useAuth.md +++ b/docs/web/auth/functions/useAuth.md @@ -6,7 +6,7 @@ function useAuth(): Auth ``` -Defined in: [web/auth/useAuth.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useAuth.ts#L9) +Defined in: [web/auth/useAuth.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useAuth.ts#L9) Custom hook to retrieve the authentication object from the Firebase context. diff --git a/docs/web/auth/functions/useAuthStateReady.md b/docs/web/auth/functions/useAuthStateReady.md index a4069c7..d763640 100644 --- a/docs/web/auth/functions/useAuthStateReady.md +++ b/docs/web/auth/functions/useAuthStateReady.md @@ -6,7 +6,7 @@ function useAuthStateReady(): boolean ``` -Defined in: [web/auth/useAuthStateReady.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useAuthStateReady.ts#L9) +Defined in: [web/auth/useAuthStateReady.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useAuthStateReady.ts#L20) A custom hook that determines if the Firebase authentication state is ready. It uses Firebase authentication to check if the auth state is ready and updates the state accordingly. @@ -15,4 +15,11 @@ It uses Firebase authentication to check if the auth state is ready and updates `boolean` -Indicates whether the authentication state is ready. +## Example + +```jsx +export const MyComponent = () => { + const isAuthStateReady = useAuthStateReady(); + console.log(isAuthStateReady); +}; +``` diff --git a/docs/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md b/docs/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md index a870bfe..7e9cb82 100644 --- a/docs/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md +++ b/docs/web/auth/functions/useCreateUserWitEmailAndPasswordMutation.md @@ -6,7 +6,7 @@ function useCreateUserWitEmailAndPasswordMutation(options): UseMutationResult ``` -Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L19) +Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L19) Custom hook to initiate a user creation process using email and password with Firebase authentication. This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously. diff --git a/docs/web/auth/functions/useCurrentUser.md b/docs/web/auth/functions/useCurrentUser.md index ba75603..f2d7fac 100644 --- a/docs/web/auth/functions/useCurrentUser.md +++ b/docs/web/auth/functions/useCurrentUser.md @@ -6,7 +6,7 @@ function useCurrentUser(): null | User ``` -Defined in: [web/auth/useCurrentUser.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useCurrentUser.ts#L9) +Defined in: [web/auth/useCurrentUser.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useCurrentUser.ts#L9) Hook that provides the current authenticated user from Firebase Auth. It listens for changes in the authentication state and updates the user accordingly. diff --git a/docs/web/auth/functions/useIdToken.md b/docs/web/auth/functions/useIdToken.md index 2beed37..d4cb4dc 100644 --- a/docs/web/auth/functions/useIdToken.md +++ b/docs/web/auth/functions/useIdToken.md @@ -6,7 +6,7 @@ function useIdToken(): object ``` -Defined in: [web/auth/useIdToken.ts:36](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useIdToken.ts#L36) +Defined in: [web/auth/useIdToken.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useIdToken.ts#L36) A hook to manage the ID token. It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed. diff --git a/docs/web/auth/functions/useReauthenticateWitCredentialMutation.md b/docs/web/auth/functions/useReauthenticateWitCredentialMutation.md index a7ec942..46f1576 100644 --- a/docs/web/auth/functions/useReauthenticateWitCredentialMutation.md +++ b/docs/web/auth/functions/useReauthenticateWitCredentialMutation.md @@ -6,7 +6,7 @@ function useReauthenticateWitCredentialMutation(options): UseMutationResult ``` -Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitCredentialMutation.ts#L19) +Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitCredentialMutation.ts#L19) Custom hook to create a mutation for re-authenticating a user with a given credential. This hook utilizes useMutation from React Query to manage the asynchronous re-authentication diff --git a/docs/web/auth/functions/useReauthenticateWitRedirectMutation.md b/docs/web/auth/functions/useReauthenticateWitRedirectMutation.md index eae77e6..3e730fa 100644 --- a/docs/web/auth/functions/useReauthenticateWitRedirectMutation.md +++ b/docs/web/auth/functions/useReauthenticateWitRedirectMutation.md @@ -6,7 +6,7 @@ function useReauthenticateWitRedirectMutation(options): UseMutationResult ``` -Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:21](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitRedirectMutation.ts#L21) +Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:21](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitRedirectMutation.ts#L21) Custom hook that provides a mutation to reauthenticate a user with a given authentication provider using redirection. This hook uses the `useMutation` hook from the React Query library to handle async mutation logic. diff --git a/docs/web/auth/functions/useSendEmailVerificationMutation.md b/docs/web/auth/functions/useSendEmailVerificationMutation.md index bf18814..c750503 100644 --- a/docs/web/auth/functions/useSendEmailVerificationMutation.md +++ b/docs/web/auth/functions/useSendEmailVerificationMutation.md @@ -6,7 +6,7 @@ function useSendEmailVerificationMutation(options): UseMutationResult ``` -Defined in: [web/auth/useSendEmailVerificationMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSendEmailVerificationMutation.ts#L17) +Defined in: [web/auth/useSendEmailVerificationMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSendEmailVerificationMutation.ts#L17) A custom hook to create a mutation for sending an email verification to a user using Firebase. This uses the `useMutation` hook from a query library and wraps it with specific configuration options. diff --git a/docs/web/auth/functions/useSignInWitEmailAndPasswordMutation.md b/docs/web/auth/functions/useSignInWitEmailAndPasswordMutation.md index 718bc69..0f270f5 100644 --- a/docs/web/auth/functions/useSignInWitEmailAndPasswordMutation.md +++ b/docs/web/auth/functions/useSignInWitEmailAndPasswordMutation.md @@ -6,7 +6,7 @@ function useSignInWitEmailAndPasswordMutation(options): UseMutationResult ``` -Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitEmailAndPasswordMutation.ts#L20) +Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitEmailAndPasswordMutation.ts#L20) Custom hook to perform a sign-in operation using email and password with Firebase Authentication. It utilizes the `useMutation` hook to manage the asynchronous operation and its state. diff --git a/docs/web/auth/functions/useSignInWitRedirectMutation.md b/docs/web/auth/functions/useSignInWitRedirectMutation.md index 13e495c..06fc7cf 100644 --- a/docs/web/auth/functions/useSignInWitRedirectMutation.md +++ b/docs/web/auth/functions/useSignInWitRedirectMutation.md @@ -6,7 +6,7 @@ function useSignInWitRedirectMutation(options): UseMutationResult ``` -Defined in: [web/auth/useSignInWitRedirectMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitRedirectMutation.ts#L19) +Defined in: [web/auth/useSignInWitRedirectMutation.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitRedirectMutation.ts#L19) Custom hook for handling Firebase authentication using sign-in with redirect functionality. This hook utilizes the `useMutation` mechanism to perform the sign-in operation. diff --git a/docs/web/auth/functions/useSignOutMutation.md b/docs/web/auth/functions/useSignOutMutation.md index 837c4d5..6247ce9 100644 --- a/docs/web/auth/functions/useSignOutMutation.md +++ b/docs/web/auth/functions/useSignOutMutation.md @@ -6,7 +6,7 @@ function useSignOutMutation(options): UseMutationResult ``` -Defined in: [web/auth/useSignOutMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignOutMutation.ts#L15) +Defined in: [web/auth/useSignOutMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignOutMutation.ts#L15) Custom hook for handling the sign-out mutation using Firebase authentication. It wraps the useMutation hook to provide a sign-out function with Firebase. diff --git a/docs/web/auth/functions/useUpdateProfileMutation.md b/docs/web/auth/functions/useUpdateProfileMutation.md index d9f4119..fe1e329 100644 --- a/docs/web/auth/functions/useUpdateProfileMutation.md +++ b/docs/web/auth/functions/useUpdateProfileMutation.md @@ -6,7 +6,7 @@ function useUpdateProfileMutation(options): UseMutationResult ``` -Defined in: [web/auth/useUpdateProfileMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useUpdateProfileMutation.ts#L18) +Defined in: [web/auth/useUpdateProfileMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useUpdateProfileMutation.ts#L18) Custom hook to manage the mutation for updating a user's profile. Utilizes Firebase for updating the user's display name. diff --git a/docs/web/auth/index.md b/docs/web/auth/index.md index 5a1185a..6db402a 100644 --- a/docs/web/auth/index.md +++ b/docs/web/auth/index.md @@ -26,7 +26,6 @@ ## Functions - [useAuth](functions/useAuth.md) -- [useAuthStateReady](functions/useAuthStateReady.md) - [useCreateUserWitEmailAndPasswordMutation](functions/useCreateUserWitEmailAndPasswordMutation.md) - [useCurrentUser](functions/useCurrentUser.md) - [useReauthenticateWitCredentialMutation](functions/useReauthenticateWitCredentialMutation.md) @@ -39,4 +38,5 @@ ## Hook +- [useAuthStateReady](functions/useAuthStateReady.md) - [useIdToken](functions/useIdToken.md) diff --git a/docs/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md b/docs/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md index 6f99a6b..6f66492 100644 --- a/docs/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md +++ b/docs/web/auth/type-aliases/UseCreateUserWitEmailAndPasswordMutationVariables.md @@ -6,7 +6,7 @@ type UseCreateUserWitEmailAndPasswordMutationVariables = object; ``` -Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L7) +Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L7) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:7](https://git email: string; ``` -Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L8) +Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L8) *** @@ -26,4 +26,4 @@ Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:8](https://git password: string; ``` -Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L9) +Defined in: [web/auth/useCreateUserWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useCreateUserWitEmailAndPasswordMutation.ts#L9) diff --git a/docs/web/auth/type-aliases/UseIdTokenResult.md b/docs/web/auth/type-aliases/UseIdTokenResult.md index 33d34fd..55d026d 100644 --- a/docs/web/auth/type-aliases/UseIdTokenResult.md +++ b/docs/web/auth/type-aliases/UseIdTokenResult.md @@ -6,7 +6,7 @@ type UseIdTokenResult = object; ``` -Defined in: [web/auth/useIdToken.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useIdToken.ts#L9) +Defined in: [web/auth/useIdToken.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useIdToken.ts#L9) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useIdToken.ts:9](https://github.com/vpishuk/react-query-fi idToken: string; ``` -Defined in: [web/auth/useIdToken.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useIdToken.ts#L10) +Defined in: [web/auth/useIdToken.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useIdToken.ts#L10) *** @@ -26,7 +26,7 @@ Defined in: [web/auth/useIdToken.ts:10](https://github.com/vpishuk/react-query-f refresh: () => Promise; ``` -Defined in: [web/auth/useIdToken.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useIdToken.ts#L11) +Defined in: [web/auth/useIdToken.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useIdToken.ts#L11) #### Returns diff --git a/docs/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md b/docs/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md index 20284de..8ab1717 100644 --- a/docs/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md +++ b/docs/web/auth/type-aliases/UseReauthenticateWitCredentialMutationVariables.md @@ -6,7 +6,7 @@ type UseReauthenticateWitCredentialMutationVariables = object; ``` -Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitCredentialMutation.ts#L6) +Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitCredentialMutation.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:6](https://githu credential: AuthCredential; ``` -Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitCredentialMutation.ts#L7) +Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitCredentialMutation.ts#L7) *** @@ -26,4 +26,4 @@ Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:7](https://githu user: User; ``` -Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitCredentialMutation.ts#L8) +Defined in: [web/auth/useReauthenticateWitCredentialMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitCredentialMutation.ts#L8) diff --git a/docs/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md b/docs/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md index f0ea842..0db33b0 100644 --- a/docs/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md +++ b/docs/web/auth/type-aliases/UseReauthenticateWitRedirectMutationVariables.md @@ -6,7 +6,7 @@ type UseReauthenticateWitRedirectMutationVariables = object; ``` -Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitRedirectMutation.ts#L7) +Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitRedirectMutation.ts#L7) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:7](https://github. authProvider: AuthProvider; ``` -Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitRedirectMutation.ts#L8) +Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitRedirectMutation.ts#L8) *** @@ -26,7 +26,7 @@ Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:8](https://github. optional popupRedirectResolver: PopupRedirectResolver; ``` -Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitRedirectMutation.ts#L9) +Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitRedirectMutation.ts#L9) *** @@ -36,4 +36,4 @@ Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:9](https://github. user: User; ``` -Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useReauthenticateWitRedirectMutation.ts#L10) +Defined in: [web/auth/useReauthenticateWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useReauthenticateWitRedirectMutation.ts#L10) diff --git a/docs/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md b/docs/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md index 19f5b8e..758a533 100644 --- a/docs/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md +++ b/docs/web/auth/type-aliases/UseSendEmailVerificationMutationVariables.md @@ -6,7 +6,7 @@ type UseSendEmailVerificationMutationVariables = object; ``` -Defined in: [web/auth/useSendEmailVerificationMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSendEmailVerificationMutation.ts#L7) +Defined in: [web/auth/useSendEmailVerificationMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSendEmailVerificationMutation.ts#L7) ## Properties @@ -16,4 +16,4 @@ Defined in: [web/auth/useSendEmailVerificationMutation.ts:7](https://github.com/ user: User; ``` -Defined in: [web/auth/useSendEmailVerificationMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSendEmailVerificationMutation.ts#L8) +Defined in: [web/auth/useSendEmailVerificationMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSendEmailVerificationMutation.ts#L8) diff --git a/docs/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md b/docs/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md index 6bc056d..c9e14d2 100644 --- a/docs/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md +++ b/docs/web/auth/type-aliases/UseSignInWitEmailAndPasswordMutationVariables.md @@ -6,7 +6,7 @@ type UseSignInWitEmailAndPasswordMutationVariables = object; ``` -Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitEmailAndPasswordMutation.ts#L8) +Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitEmailAndPasswordMutation.ts#L8) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:8](https://github. email: string; ``` -Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitEmailAndPasswordMutation.ts#L9) +Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitEmailAndPasswordMutation.ts#L9) *** @@ -26,4 +26,4 @@ Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:9](https://github. password: string; ``` -Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitEmailAndPasswordMutation.ts#L10) +Defined in: [web/auth/useSignInWitEmailAndPasswordMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitEmailAndPasswordMutation.ts#L10) diff --git a/docs/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md b/docs/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md index 11113b3..5d061b9 100644 --- a/docs/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md +++ b/docs/web/auth/type-aliases/UseSignInWitRedirectMutationVariables.md @@ -6,7 +6,7 @@ type UseSignInWitRedirectMutationVariables = object; ``` -Defined in: [web/auth/useSignInWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitRedirectMutation.ts#L8) +Defined in: [web/auth/useSignInWitRedirectMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitRedirectMutation.ts#L8) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useSignInWitRedirectMutation.ts:8](https://github.com/vpis authProvider: AuthProvider; ``` -Defined in: [web/auth/useSignInWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitRedirectMutation.ts#L9) +Defined in: [web/auth/useSignInWitRedirectMutation.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitRedirectMutation.ts#L9) *** @@ -26,4 +26,4 @@ Defined in: [web/auth/useSignInWitRedirectMutation.ts:9](https://github.com/vpis optional popupRedirectResolver: PopupRedirectResolver; ``` -Defined in: [web/auth/useSignInWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useSignInWitRedirectMutation.ts#L10) +Defined in: [web/auth/useSignInWitRedirectMutation.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useSignInWitRedirectMutation.ts#L10) diff --git a/docs/web/auth/type-aliases/UseUpdateProfileMutationVariables.md b/docs/web/auth/type-aliases/UseUpdateProfileMutationVariables.md index 8ea8149..45de2f9 100644 --- a/docs/web/auth/type-aliases/UseUpdateProfileMutationVariables.md +++ b/docs/web/auth/type-aliases/UseUpdateProfileMutationVariables.md @@ -6,7 +6,7 @@ type UseUpdateProfileMutationVariables = object; ``` -Defined in: [web/auth/useUpdateProfileMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useUpdateProfileMutation.ts#L6) +Defined in: [web/auth/useUpdateProfileMutation.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useUpdateProfileMutation.ts#L6) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/auth/useUpdateProfileMutation.ts:6](https://github.com/vpishuk/ optional displayName: string; ``` -Defined in: [web/auth/useUpdateProfileMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useUpdateProfileMutation.ts#L7) +Defined in: [web/auth/useUpdateProfileMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useUpdateProfileMutation.ts#L7) *** @@ -26,4 +26,4 @@ Defined in: [web/auth/useUpdateProfileMutation.ts:7](https://github.com/vpishuk/ user: User; ``` -Defined in: [web/auth/useUpdateProfileMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/useUpdateProfileMutation.ts#L8) +Defined in: [web/auth/useUpdateProfileMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/useUpdateProfileMutation.ts#L8) diff --git a/docs/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md b/docs/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md index 6bf90c6..b03149b 100644 --- a/docs/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md +++ b/docs/web/auth/variables/CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md @@ -6,4 +6,4 @@ const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"]; ``` -Defined in: [web/auth/mutation-keys.ts:1](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L1) +Defined in: [web/auth/mutation-keys.ts:1](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L1) diff --git a/docs/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md b/docs/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md index 0af86f9..7e2dfba 100644 --- a/docs/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md +++ b/docs/web/auth/variables/REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY.md @@ -6,4 +6,4 @@ const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_CREDENTIAL"]; ``` -Defined in: [web/auth/mutation-keys.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L15) +Defined in: [web/auth/mutation-keys.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L15) diff --git a/docs/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md b/docs/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md index bef40e9..aecc3b1 100644 --- a/docs/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md +++ b/docs/web/auth/variables/REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"]; ``` -Defined in: [web/auth/mutation-keys.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L14) +Defined in: [web/auth/mutation-keys.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L14) diff --git a/docs/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md b/docs/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md index 586b956..44450b7 100644 --- a/docs/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md +++ b/docs/web/auth/variables/SEND_EMAIL_VERIFICATION_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"]; ``` -Defined in: [web/auth/mutation-keys.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L6) +Defined in: [web/auth/mutation-keys.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L6) diff --git a/docs/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md b/docs/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md index dcb04c8..85c5949 100644 --- a/docs/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md +++ b/docs/web/auth/variables/SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"]; ``` -Defined in: [web/auth/mutation-keys.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L7) +Defined in: [web/auth/mutation-keys.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L7) diff --git a/docs/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md b/docs/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md index 0d8127d..da53282 100644 --- a/docs/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md +++ b/docs/web/auth/variables/SIGN_IN_WITH_REDIRECT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_IN_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"]; ``` -Defined in: [web/auth/mutation-keys.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L12) +Defined in: [web/auth/mutation-keys.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L12) diff --git a/docs/web/auth/variables/SIGN_OUT_MUTATION_KEY.md b/docs/web/auth/variables/SIGN_OUT_MUTATION_KEY.md index 43019c1..04b7e1c 100644 --- a/docs/web/auth/variables/SIGN_OUT_MUTATION_KEY.md +++ b/docs/web/auth/variables/SIGN_OUT_MUTATION_KEY.md @@ -6,4 +6,4 @@ const SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"]; ``` -Defined in: [web/auth/mutation-keys.ts:13](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/auth/mutation-keys.ts#L13) +Defined in: [web/auth/mutation-keys.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/auth/mutation-keys.ts#L13) diff --git a/docs/web/firestore/functions/buildCompositeFilter.md b/docs/web/firestore/functions/buildCompositeFilter.md index 17d3514..3b33a58 100644 --- a/docs/web/firestore/functions/buildCompositeFilter.md +++ b/docs/web/firestore/functions/buildCompositeFilter.md @@ -3,30 +3,48 @@ # Function: buildCompositeFilter() ```ts -function buildCompositeFilter(query): null | QueryFilterConstraint +function buildCompositeFilter(query): + | null + | QueryFilterConstraint ``` -Defined in: [web/firestore/useCompositeFilter.ts:31](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L31) +Defined in: [web/firestore/useCompositeFilter.ts:63](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L63) -Constructs a composite query filter based on the provided query structure. +Constructs a composite or where query filter based on the provided query structure. It recursively builds query constraints using logical "or" or "and" operators. ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### query -[`QueryElement`](../type-aliases/QueryElement.md)\<`DbModelType`\> - -The query element or structure to be evaluated and transformed into filter constraints. +[`QueryElement`](../type-aliases/QueryElement.md)\<`AppModelType`\> ## Returns -`null` \| `QueryFilterConstraint` - -A constructed query filter constraint based on the input query, or null if no valid constraints can be derived. + \| `null` + \| [`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +## Example + +```jsx +export const MyComponent = () => { + const filter = buildCompositeFilter({ + operator: "AND", + children: [ + { + field: "field", + value: "value", + op: "==" + }, + ...(query ? [query] : []) + ] + }); + console.log(filter); +}; +``` diff --git a/docs/web/firestore/functions/buildQueryConstraint.md b/docs/web/firestore/functions/buildQueryConstraint.md index c8e0ef1..3682f3f 100644 --- a/docs/web/firestore/functions/buildQueryConstraint.md +++ b/docs/web/firestore/functions/buildQueryConstraint.md @@ -6,7 +6,7 @@ function buildQueryConstraint(constraint): QueryNonFilterConstraint ``` -Defined in: web/firestore/useQueryConstraints.ts:45 +Defined in: [web/firestore/useQueryConstraints.ts:45](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useQueryConstraints.ts#L45) A generic mothod to build query constraints for firebase diff --git a/docs/web/firestore/functions/useAddDocMutation.md b/docs/web/firestore/functions/useAddDocMutation.md index b614a27..22b2eaa 100644 --- a/docs/web/firestore/functions/useAddDocMutation.md +++ b/docs/web/firestore/functions/useAddDocMutation.md @@ -6,7 +6,7 @@ function useAddDocMutation(options): UseMutationResult, TContext> ``` -Defined in: [web/firestore/useAddDocMutation.ts:42](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L42) +Defined in: [web/firestore/useAddDocMutation.ts:42](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L42) Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`. It handles addition and optional conversion of the document data in Firestore. diff --git a/docs/web/firestore/functions/useBatchWrite.md b/docs/web/firestore/functions/useBatchWrite.md index 7ede5bb..f86d2c4 100644 --- a/docs/web/firestore/functions/useBatchWrite.md +++ b/docs/web/firestore/functions/useBatchWrite.md @@ -6,7 +6,7 @@ function useBatchWrite(options): UseMutationResult ``` -Defined in: [web/firestore/useBatchWrite.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useBatchWrite.ts#L20) +Defined in: [web/firestore/useBatchWrite.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useBatchWrite.ts#L20) Custom hook to perform batch write operations using Firestore. Utilizes a mutation to carry out the batch write transaction. diff --git a/docs/web/firestore/functions/useCollectionReference.md b/docs/web/firestore/functions/useCollectionReference.md index 8734fb5..d1fd893 100644 --- a/docs/web/firestore/functions/useCollectionReference.md +++ b/docs/web/firestore/functions/useCollectionReference.md @@ -6,7 +6,7 @@ function useCollectionReference(options): CollectionReference ``` -Defined in: [web/firestore/useCollectionReference.ts:23](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCollectionReference.ts#L23) +Defined in: [web/firestore/useCollectionReference.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCollectionReference.ts#L23) Creates a reference to a Firestore collection based on the provided path, reference, and path segments. diff --git a/docs/web/firestore/functions/useCompositeFilter.md b/docs/web/firestore/functions/useCompositeFilter.md index 231628a..a5afd3f 100644 --- a/docs/web/firestore/functions/useCompositeFilter.md +++ b/docs/web/firestore/functions/useCompositeFilter.md @@ -3,30 +3,47 @@ # Function: useCompositeFilter() ```ts -function useCompositeFilter(query): undefined | QueryCompositeFilterConstraint +function useCompositeFilter(query): undefined | QueryCompositeFilterConstraint ``` -Defined in: [web/firestore/useCompositeFilter.ts:61](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L61) +Defined in: [web/firestore/useCompositeFilter.ts:111](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L111) -A custom hook that generates a composite filter for database queries, using the provided query configuration. -It applies either an 'OR' or 'AND' logical operation based on the type specified in the query. +A custom hook that constructs a composite or where query filter based on the provided query structure. +It recursively builds query constraints using logical "or" or "and" operators. ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### query -[`UseCompositeFilter`](../type-aliases/UseCompositeFilter.md)\<`DbModelType`\> +#### query? -The query configuration object that contains subqueries and a type for logical combination. +[`CompositeFilter`](../type-aliases/CompositeFilter.md)\<`AppModelType`\> ## Returns `undefined` \| `QueryCompositeFilterConstraint` -A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints. +## Example + +```jsx +export const MyComponent = () => { + const filter = useCompositeFilter({ + operator: "AND", + children: [ + { + field: "field", + value: "value", + op: "==" + }, + ...(query ? [query] : []) + ] + }); + console.log(filter); +}; +``` diff --git a/docs/web/firestore/functions/useCountQuery.md b/docs/web/firestore/functions/useCountQuery.md index 9357236..cf12984 100644 --- a/docs/web/firestore/functions/useCountQuery.md +++ b/docs/web/firestore/functions/useCountQuery.md @@ -6,33 +6,66 @@ function useCountQuery(options): UseQueryResult ``` -Defined in: [web/firestore/useCountQuery.ts:42](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCountQuery.ts#L42) +Defined in: [web/firestore/useCountQuery.ts:66](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCountQuery.ts#L66) Executes a query with specified constraints and returns the count of matched documents. -This function utilizes React Query to asynchronously fetch the count of documents from a server database -that match the provided query constraints and an optional composite filter. - ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ### DbModelType -`DbModelType` *extends* `DocumentData` = `DocumentData` +`DbModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Parameters ### options -`UseCountQueryOptions`\<`AppModelType`, `DbModelType`\> - Configuration options for the query. +#### collectionReference + +`CollectionReference`\<`AppModelType`, `DbModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +Composite filter + +#### options + +`Omit`\<`UseQueryOptions`\<`number`, `Error`, `number`, `QueryKey`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseQueryOptions`\<`number`, `Error`, `number`, `QueryKey`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where + ## Returns `UseQueryResult`\<`number`\> An object containing the number of documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const count = useCountQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(count); +}; +``` diff --git a/docs/web/firestore/functions/useDeleteDocMutation.md b/docs/web/firestore/functions/useDeleteDocMutation.md index cbdcbbb..b7ccf59 100644 --- a/docs/web/firestore/functions/useDeleteDocMutation.md +++ b/docs/web/firestore/functions/useDeleteDocMutation.md @@ -6,7 +6,7 @@ function useDeleteDocMutation(options): UseMutationResult ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:27](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L27) +Defined in: [web/firestore/useDeleteDocMutation.ts:27](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L27) A custom hook that provides a mutation function to delete a document from the database. diff --git a/docs/web/firestore/functions/useDocReference.md b/docs/web/firestore/functions/useDocReference.md index 82bb33d..11777a1 100644 --- a/docs/web/firestore/functions/useDocReference.md +++ b/docs/web/firestore/functions/useDocReference.md @@ -6,7 +6,7 @@ function useDocReference(options): null | DocumentReference ``` -Defined in: [web/firestore/useDocReference.ts:53](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReference.ts#L53) +Defined in: [web/firestore/useDocReference.ts:53](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReference.ts#L53) Custom hook to generate and manage a Firestore document reference. This hook facilitates the retrieval of a Firestore document reference based on given options such as path and reference data. diff --git a/docs/web/firestore/functions/useDocReferences.md b/docs/web/firestore/functions/useDocReferences.md index 1485b21..03419ad 100644 --- a/docs/web/firestore/functions/useDocReferences.md +++ b/docs/web/firestore/functions/useDocReferences.md @@ -6,7 +6,7 @@ function useDocReferences(references): DocumentReference[] ``` -Defined in: [web/firestore/useDocReferences.ts:28](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReferences.ts#L28) +Defined in: [web/firestore/useDocReferences.ts:28](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReferences.ts#L28) A custom hook to generate document references for Firebase Firestore documents using given reference options. diff --git a/docs/web/firestore/functions/useFirestore.md b/docs/web/firestore/functions/useFirestore.md index 817b36c..5afddae 100644 --- a/docs/web/firestore/functions/useFirestore.md +++ b/docs/web/firestore/functions/useFirestore.md @@ -6,7 +6,7 @@ function useFirestore(): Firestore ``` -Defined in: [web/firestore/useFirestore.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useFirestore.ts#L10) +Defined in: [web/firestore/useFirestore.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useFirestore.ts#L10) Provides a hook to access the Firestore instance from the Firebase context. It extracts the Firestore object from the Firebase context, allowing components to interact with Firestore services. diff --git a/docs/web/firestore/functions/useGetDocData.md b/docs/web/firestore/functions/useGetDocData.md index 74d333b..2388dbb 100644 --- a/docs/web/firestore/functions/useGetDocData.md +++ b/docs/web/firestore/functions/useGetDocData.md @@ -6,7 +6,7 @@ function useGetDocData(__namedParameters): UseQueryResult ``` -Defined in: [web/firestore/useGetDocData.ts:26](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetDocData.ts#L26) +Defined in: [web/firestore/useGetDocData.ts:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetDocData.ts#L26) Custom React Hook to retrieve document data from Firestore using specified parameters. diff --git a/docs/web/firestore/functions/useGetRealtimeDocData.md b/docs/web/firestore/functions/useGetRealtimeDocData.md index 63b638d..9ec3a01 100644 --- a/docs/web/firestore/functions/useGetRealtimeDocData.md +++ b/docs/web/firestore/functions/useGetRealtimeDocData.md @@ -6,7 +6,7 @@ function useGetRealtimeDocData(options): object ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:63](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L63) +Defined in: [web/firestore/useGetRealtimeDocData.ts:63](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L63) A hook to get realtime updates to a firestore document. diff --git a/docs/web/firestore/functions/useInfiniteQuery.md b/docs/web/firestore/functions/useInfiniteQuery.md index 1f65058..d1bd5d0 100644 --- a/docs/web/firestore/functions/useInfiniteQuery.md +++ b/docs/web/firestore/functions/useInfiniteQuery.md @@ -3,34 +3,69 @@ # Function: useInfiniteQuery() ```ts -function useInfiniteQuery(options): UseInfiniteQueryResult> +function useInfiniteQuery(options): UseInfiniteQueryResult> ``` -Defined in: [web/firestore/useInfiniteQuery.ts:62](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useInfiniteQuery.ts#L62) +Defined in: [web/firestore/useInfiniteQuery.ts:90](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useInfiniteQuery.ts#L90) -Custom hook that creates an infinite query using Firestore, allowing for query constraints, composite filters, and converters. -It fetches data in pages and can load more as required. +Executes an infinite query on a Firestore data source and returns the resulting documents as an array. ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) -### DbModelType +### TQueryKey -`DbModelType` *extends* `DocumentData` = `DocumentData` +`TQueryKey` *extends* `QueryKey` = `QueryKey` ## Parameters ### options -`UseInfiniteQueryOptions`\<`AppModelType`, `DbModelType`\> +Configuration options for the query. -Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter. +#### collectionReference + +`CollectionReference`\<`AppModelType`, `AppModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) + +Composite filter + +#### options + +`Omit`\<`UseInfiniteQueryOptions`\<`AppModelType`[], `Error`, `InfiniteData`\<`AppModelType`[], `unknown`\>, `AppModelType`[], `TQueryKey`, `QueryConstraint`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseInfiniteQueryOptions`\<`AppModelType`[], `Error`, `InfiniteData`\<`AppModelType`[], `unknown`\>, `AppModelType`[], `TQueryKey`, `QueryConstraint`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where ## Returns `UseInfiniteQueryResult`\<`InfiniteData`\<`AppModelType`[], `unknown`\>\> -Result object containing the infinite data and methods for fetching more pages. +An object containing documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const docs = useInfiniteQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(docs); +}; +``` diff --git a/docs/web/firestore/functions/useQuery.md b/docs/web/firestore/functions/useQuery.md index 17e7ea9..35c62e5 100644 --- a/docs/web/firestore/functions/useQuery.md +++ b/docs/web/firestore/functions/useQuery.md @@ -3,34 +3,65 @@ # Function: useQuery() ```ts -function useQuery(__namedParameters): UseQueryResult +function useQuery(options): UseQueryResult ``` -Defined in: [web/firestore/useQuery.ts:44](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useQuery.ts#L44) +Defined in: [web/firestore/useQuery.ts:66](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useQuery.ts#L66) -Executes a query on a Firestore-like data source and returns the resulting documents as an array. - -This hook utilizes an abstraction over React Query to asynchronously fetch data based on the provided query -reference and constraints. It supports optional filtering, conversion, and additional query constraints. +Executes a query on a Firestore data source and returns the resulting documents as an array. ## Type Parameters ### AppModelType -`AppModelType` *extends* `DocumentData` = `DocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) + +## Parameters -### DbModelType +### options -`DbModelType` *extends* `DocumentData` = `DocumentData` +Configuration options for the query. -## Parameters +#### collectionReference + +`CollectionReference`\<`AppModelType`, `AppModelType`\> + +Reference to a Firestore collection + +#### compositeFilter? + +[`QueryFilterConstraint`](../type-aliases/QueryFilterConstraint.md) -### \_\_namedParameters +Composite filter -`UseQueryOptions`\<`AppModelType`, `DbModelType`\> +#### options + +`Omit`\<`UseQueryOptions`\<`AppModelType`[], `Error`, `AppModelType`[], `QueryKey`\>, `"queryFn"`\> & `Required`\<`Pick`\<`UseQueryOptions`\<`AppModelType`[], `Error`, `AppModelType`[], `QueryKey`\>, `"queryKey"`\>\> + +Reqct-query options that must include queryKey and shall not define queryFn + +#### queryConstraints? + +`QueryConstraint`[] \| `QueryNonFilterConstraint`[] = `[]` + +Non composite filter constraints such as limit, order, where ## Returns `UseQueryResult`\<`AppModelType`[]\> -Result containing an array of documents that match the query criteria. +An object containing documents that match the query. + +## Example + +```jsx +export const MyComponent = () => { + const docs = useQuery({ + options: { + queryKey: ['key'] + }, + collectionReference: collection(), + }); + console.log(docs); +}; +``` diff --git a/docs/web/firestore/functions/useQueryConstraints.md b/docs/web/firestore/functions/useQueryConstraints.md index c251a2c..20a0337 100644 --- a/docs/web/firestore/functions/useQueryConstraints.md +++ b/docs/web/firestore/functions/useQueryConstraints.md @@ -6,7 +6,7 @@ function useQueryConstraints(constraints): QueryNonFilterConstraint[] ``` -Defined in: web/firestore/useQueryConstraints.ts:87 +Defined in: [web/firestore/useQueryConstraints.ts:87](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useQueryConstraints.ts#L87) A hook to build a list of non-filter query constraints for firebase queries. It uses buildQueryConstraint method and useMemo hook. diff --git a/docs/web/firestore/functions/useRunTransaction.md b/docs/web/firestore/functions/useRunTransaction.md index 3993573..5caa5d8 100644 --- a/docs/web/firestore/functions/useRunTransaction.md +++ b/docs/web/firestore/functions/useRunTransaction.md @@ -6,7 +6,7 @@ function useRunTransaction(options): UseMutationResult ``` -Defined in: [web/firestore/useRunTransaction.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useRunTransaction.ts#L20) +Defined in: [web/firestore/useRunTransaction.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useRunTransaction.ts#L20) Custom hook to execute a Firestore transaction using the useMutation hook. diff --git a/docs/web/firestore/functions/useSetDocMutation.md b/docs/web/firestore/functions/useSetDocMutation.md index 466a3b3..b1e3b06 100644 --- a/docs/web/firestore/functions/useSetDocMutation.md +++ b/docs/web/firestore/functions/useSetDocMutation.md @@ -6,7 +6,7 @@ function useSetDocMutation(param0): UseMutationResult, TContext> ``` -Defined in: [web/firestore/useSetDocMutation.ts:32](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L32) +Defined in: [web/firestore/useSetDocMutation.ts:32](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L32) Custom hook to create a mutation for setting a document in a Firestore-like database. The mutation can be configured with options and reference to specific document path. diff --git a/docs/web/firestore/functions/useUpdateDocMutation.md b/docs/web/firestore/functions/useUpdateDocMutation.md index 671df9e..4e5170d 100644 --- a/docs/web/firestore/functions/useUpdateDocMutation.md +++ b/docs/web/firestore/functions/useUpdateDocMutation.md @@ -6,7 +6,7 @@ function useUpdateDocMutation(options): UseMutationResult, TContext> ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:50](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L50) +Defined in: [web/firestore/useUpdateDocMutation.ts:50](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L50) Custom hook that sets up a mutation for updating a document in a Firestore database. diff --git a/docs/web/firestore/index.md b/docs/web/firestore/index.md index 3bac1a3..32ed215 100644 --- a/docs/web/firestore/index.md +++ b/docs/web/firestore/index.md @@ -6,6 +6,7 @@ - [CompositeFilter](type-aliases/CompositeFilter.md) - [QueryElement](type-aliases/QueryElement.md) +- [QueryFilterConstraint](type-aliases/QueryFilterConstraint.md) - [UseAddDocMutationOptions](type-aliases/UseAddDocMutationOptions.md) - [UseAddDocMutationValues](type-aliases/UseAddDocMutationValues.md) - [UseBatchWriteOptions](type-aliases/UseBatchWriteOptions.md) @@ -28,28 +29,28 @@ ## Functions -- [buildCompositeFilter](functions/buildCompositeFilter.md) - [useAddDocMutation](functions/useAddDocMutation.md) - [useBatchWrite](functions/useBatchWrite.md) - [useCollectionReference](functions/useCollectionReference.md) -- [useCompositeFilter](functions/useCompositeFilter.md) -- [useCountQuery](functions/useCountQuery.md) - [useDeleteDocMutation](functions/useDeleteDocMutation.md) - [useDocReference](functions/useDocReference.md) - [useDocReferences](functions/useDocReferences.md) - [useFirestore](functions/useFirestore.md) - [useGetDocData](functions/useGetDocData.md) -- [useInfiniteQuery](functions/useInfiniteQuery.md) -- [useQuery](functions/useQuery.md) - [useRunTransaction](functions/useRunTransaction.md) - [useSetDocMutation](functions/useSetDocMutation.md) - [useUpdateDocMutation](functions/useUpdateDocMutation.md) ## Hook +- [useCompositeFilter](functions/useCompositeFilter.md) +- [useCountQuery](functions/useCountQuery.md) - [useGetRealtimeDocData](functions/useGetRealtimeDocData.md) +- [useInfiniteQuery](functions/useInfiniteQuery.md) +- [useQuery](functions/useQuery.md) - [useQueryConstraints](functions/useQueryConstraints.md) ## Utility +- [buildCompositeFilter](functions/buildCompositeFilter.md) - [buildQueryConstraint](functions/buildQueryConstraint.md) diff --git a/docs/web/firestore/type-aliases/CompositeFilter.md b/docs/web/firestore/type-aliases/CompositeFilter.md index 9bb7fe6..96cd274 100644 --- a/docs/web/firestore/type-aliases/CompositeFilter.md +++ b/docs/web/firestore/type-aliases/CompositeFilter.md @@ -1,28 +1,28 @@ [react-query-firebase](../../../modules.md) / [web/firestore](../index.md) / CompositeFilter -# Type Alias: CompositeFilter\ +# Type Alias: CompositeFilter\ ```ts -type CompositeFilter = object; +type CompositeFilter = object; ``` -Defined in: [web/firestore/useCompositeFilter.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L14) +Defined in: [web/firestore/useCompositeFilter.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L23) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties ### children ```ts -children: QueryElement[]; +children: QueryElement[]; ``` -Defined in: [web/firestore/useCompositeFilter.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L16) +Defined in: [web/firestore/useCompositeFilter.ts:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L25) *** @@ -32,4 +32,4 @@ Defined in: [web/firestore/useCompositeFilter.ts:16](https://github.com/vpishuk/ operator: "OR" | "AND"; ``` -Defined in: [web/firestore/useCompositeFilter.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L15) +Defined in: [web/firestore/useCompositeFilter.ts:24](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L24) diff --git a/docs/web/firestore/type-aliases/QueryElement.md b/docs/web/firestore/type-aliases/QueryElement.md index c1833d8..57f5c22 100644 --- a/docs/web/firestore/type-aliases/QueryElement.md +++ b/docs/web/firestore/type-aliases/QueryElement.md @@ -1,18 +1,18 @@ [react-query-firebase](../../../modules.md) / [web/firestore](../index.md) / QueryElement -# Type Alias: QueryElement\ +# Type Alias: QueryElement\ ```ts -type QueryElement = object; +type QueryElement = object; ``` -Defined in: [web/firestore/useCompositeFilter.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L6) +Defined in: [web/firestore/useCompositeFilter.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L15) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties @@ -22,17 +22,17 @@ Defined in: [web/firestore/useCompositeFilter.ts:6](https://github.com/vpishuk/r optional children: QueryElement[]; ``` -Defined in: [web/firestore/useCompositeFilter.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L8) +Defined in: [web/firestore/useCompositeFilter.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L17) *** ### field? ```ts -optional field: keyof DbModelType & object; +optional field: keyof AppModelType & object; ``` -Defined in: [web/firestore/useCompositeFilter.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L9) +Defined in: [web/firestore/useCompositeFilter.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L18) *** @@ -42,7 +42,7 @@ Defined in: [web/firestore/useCompositeFilter.ts:9](https://github.com/vpishuk/r optional op: WhereFilterOp; ``` -Defined in: [web/firestore/useCompositeFilter.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L11) +Defined in: [web/firestore/useCompositeFilter.ts:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L20) *** @@ -52,14 +52,14 @@ Defined in: [web/firestore/useCompositeFilter.ts:11](https://github.com/vpishuk/ optional operator: "OR" | "AND"; ``` -Defined in: [web/firestore/useCompositeFilter.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L7) +Defined in: [web/firestore/useCompositeFilter.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L16) *** ### value? ```ts -optional value: DbModelType[keyof DbModelType]; +optional value: AppModelType[keyof AppModelType]; ``` -Defined in: [web/firestore/useCompositeFilter.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L10) +Defined in: [web/firestore/useCompositeFilter.ts:19](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L19) diff --git a/docs/web/firestore/type-aliases/QueryFilterConstraint.md b/docs/web/firestore/type-aliases/QueryFilterConstraint.md new file mode 100644 index 0000000..6c44ba5 --- /dev/null +++ b/docs/web/firestore/type-aliases/QueryFilterConstraint.md @@ -0,0 +1,9 @@ +[react-query-firebase](../../../modules.md) / [web/firestore](../index.md) / QueryFilterConstraint + +# Type Alias: QueryFilterConstraint + +```ts +type QueryFilterConstraint = FBQueryFilterConstraint | FBQueryCompositeFilterConstraint; +``` + +Defined in: [web/firestore/useCompositeFilter.ts:13](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L13) diff --git a/docs/web/firestore/type-aliases/UseAddDocMutationOptions.md b/docs/web/firestore/type-aliases/UseAddDocMutationOptions.md index 8e0c08b..a79e342 100644 --- a/docs/web/firestore/type-aliases/UseAddDocMutationOptions.md +++ b/docs/web/firestore/type-aliases/UseAddDocMutationOptions.md @@ -6,7 +6,7 @@ type UseAddDocMutationOptions = object; ``` -Defined in: [web/firestore/useAddDocMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L18) +Defined in: [web/firestore/useAddDocMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L18) ## Type Parameters @@ -30,7 +30,7 @@ Defined in: [web/firestore/useAddDocMutation.ts:18](https://github.com/vpishuk/r optional converter: FirestoreDataConverter; ``` -Defined in: [web/firestore/useAddDocMutation.ts:24](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L24) +Defined in: [web/firestore/useAddDocMutation.ts:24](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L24) *** @@ -40,7 +40,7 @@ Defined in: [web/firestore/useAddDocMutation.ts:24](https://github.com/vpishuk/r optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [web/firestore/useAddDocMutation.ts:25](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L25) +Defined in: [web/firestore/useAddDocMutation.ts:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L25) *** @@ -50,4 +50,4 @@ Defined in: [web/firestore/useAddDocMutation.ts:25](https://github.com/vpishuk/r reference: CollectionReference; ``` -Defined in: [web/firestore/useAddDocMutation.ts:23](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L23) +Defined in: [web/firestore/useAddDocMutation.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L23) diff --git a/docs/web/firestore/type-aliases/UseAddDocMutationValues.md b/docs/web/firestore/type-aliases/UseAddDocMutationValues.md index f501292..c399009 100644 --- a/docs/web/firestore/type-aliases/UseAddDocMutationValues.md +++ b/docs/web/firestore/type-aliases/UseAddDocMutationValues.md @@ -6,7 +6,7 @@ type UseAddDocMutationValues = object; ``` -Defined in: [web/firestore/useAddDocMutation.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L14) +Defined in: [web/firestore/useAddDocMutation.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L14) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [web/firestore/useAddDocMutation.ts:14](https://github.com/vpishuk/r data: WithFieldValue; ``` -Defined in: [web/firestore/useAddDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useAddDocMutation.ts#L15) +Defined in: [web/firestore/useAddDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useAddDocMutation.ts#L15) diff --git a/docs/web/firestore/type-aliases/UseBatchWriteOptions.md b/docs/web/firestore/type-aliases/UseBatchWriteOptions.md index 5bd8da7..deeab20 100644 --- a/docs/web/firestore/type-aliases/UseBatchWriteOptions.md +++ b/docs/web/firestore/type-aliases/UseBatchWriteOptions.md @@ -6,7 +6,7 @@ type UseBatchWriteOptions = object; ``` -Defined in: [web/firestore/useBatchWrite.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useBatchWrite.ts#L9) +Defined in: [web/firestore/useBatchWrite.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useBatchWrite.ts#L9) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [web/firestore/useBatchWrite.ts:9](https://github.com/vpishuk/react- optional options: Omit, "mutationFn">; ``` -Defined in: [web/firestore/useBatchWrite.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useBatchWrite.ts#L10) +Defined in: [web/firestore/useBatchWrite.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useBatchWrite.ts#L10) diff --git a/docs/web/firestore/type-aliases/UseBatchWriteVariables.md b/docs/web/firestore/type-aliases/UseBatchWriteVariables.md index 416316d..b103104 100644 --- a/docs/web/firestore/type-aliases/UseBatchWriteVariables.md +++ b/docs/web/firestore/type-aliases/UseBatchWriteVariables.md @@ -6,7 +6,7 @@ type UseBatchWriteVariables = (batch) => Promise | void; ``` -Defined in: [web/firestore/useBatchWrite.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useBatchWrite.ts#L7) +Defined in: [web/firestore/useBatchWrite.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useBatchWrite.ts#L7) ## Parameters diff --git a/docs/web/firestore/type-aliases/UseCollectionReferenceOptions.md b/docs/web/firestore/type-aliases/UseCollectionReferenceOptions.md index 08f01de..4e9c040 100644 --- a/docs/web/firestore/type-aliases/UseCollectionReferenceOptions.md +++ b/docs/web/firestore/type-aliases/UseCollectionReferenceOptions.md @@ -6,7 +6,7 @@ type UseCollectionReferenceOptions = object; ``` -Defined in: [web/firestore/useCollectionReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCollectionReference.ts#L6) +Defined in: [web/firestore/useCollectionReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCollectionReference.ts#L6) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [web/firestore/useCollectionReference.ts:6](https://github.com/vpish path: string; ``` -Defined in: [web/firestore/useCollectionReference.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCollectionReference.ts#L8) +Defined in: [web/firestore/useCollectionReference.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCollectionReference.ts#L8) *** @@ -36,7 +36,7 @@ Defined in: [web/firestore/useCollectionReference.ts:8](https://github.com/vpish optional pathSegments: string[]; ``` -Defined in: [web/firestore/useCollectionReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCollectionReference.ts#L9) +Defined in: [web/firestore/useCollectionReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCollectionReference.ts#L9) *** @@ -48,4 +48,4 @@ optional reference: | DocumentReference; ``` -Defined in: [web/firestore/useCollectionReference.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCollectionReference.ts#L7) +Defined in: [web/firestore/useCollectionReference.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCollectionReference.ts#L7) diff --git a/docs/web/firestore/type-aliases/UseCompositeFilter.md b/docs/web/firestore/type-aliases/UseCompositeFilter.md index c6a5b24..971037c 100644 --- a/docs/web/firestore/type-aliases/UseCompositeFilter.md +++ b/docs/web/firestore/type-aliases/UseCompositeFilter.md @@ -1,25 +1,25 @@ [react-query-firebase](../../../modules.md) / [web/firestore](../index.md) / UseCompositeFilter -# Type Alias: UseCompositeFilter\ +# Type Alias: UseCompositeFilter\ ```ts -type UseCompositeFilter = object; +type UseCompositeFilter = object; ``` -Defined in: [web/firestore/useCompositeFilter.ts:19](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L19) +Defined in: [web/firestore/useCompositeFilter.ts:31](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L31) ## Type Parameters -### DbModelType +### AppModelType -`DbModelType` *extends* `CompositeFilterDocumentData` = `CompositeFilterDocumentData` +`AppModelType` *extends* [`AppModel`](../../../types/type-aliases/AppModel.md) = [`AppModel`](../../../types/type-aliases/AppModel.md) ## Properties ### query? ```ts -optional query: CompositeFilter; +optional query: CompositeFilter; ``` -Defined in: [web/firestore/useCompositeFilter.ts:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useCompositeFilter.ts#L20) +Defined in: [web/firestore/useCompositeFilter.ts:32](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useCompositeFilter.ts#L32) diff --git a/docs/web/firestore/type-aliases/UseDeleteDocMutationOptions.md b/docs/web/firestore/type-aliases/UseDeleteDocMutationOptions.md index 5bc4931..c058f59 100644 --- a/docs/web/firestore/type-aliases/UseDeleteDocMutationOptions.md +++ b/docs/web/firestore/type-aliases/UseDeleteDocMutationOptions.md @@ -6,7 +6,7 @@ type UseDeleteDocMutationOptions = object; ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L11) +Defined in: [web/firestore/useDeleteDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L11) ## Type Parameters @@ -30,7 +30,7 @@ Defined in: [web/firestore/useDeleteDocMutation.ts:11](https://github.com/vpishu optional options: Omit, "mutationFn" | "mutationKey">; ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L17) +Defined in: [web/firestore/useDeleteDocMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L17) *** @@ -40,4 +40,4 @@ Defined in: [web/firestore/useDeleteDocMutation.ts:17](https://github.com/vpishu reference: DocumentReference | null; ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L16) +Defined in: [web/firestore/useDeleteDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L16) diff --git a/docs/web/firestore/type-aliases/UseDeleteDocMutationValues.md b/docs/web/firestore/type-aliases/UseDeleteDocMutationValues.md index 4ec575e..8280b84 100644 --- a/docs/web/firestore/type-aliases/UseDeleteDocMutationValues.md +++ b/docs/web/firestore/type-aliases/UseDeleteDocMutationValues.md @@ -6,7 +6,7 @@ type UseDeleteDocMutationValues = object; ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L7) +Defined in: [web/firestore/useDeleteDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [web/firestore/useDeleteDocMutation.ts:7](https://github.com/vpishuk data: WithFieldValue; ``` -Defined in: [web/firestore/useDeleteDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDeleteDocMutation.ts#L8) +Defined in: [web/firestore/useDeleteDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDeleteDocMutation.ts#L8) diff --git a/docs/web/firestore/type-aliases/UseDocReferenceOptions.md b/docs/web/firestore/type-aliases/UseDocReferenceOptions.md index d873a0b..2d18618 100644 --- a/docs/web/firestore/type-aliases/UseDocReferenceOptions.md +++ b/docs/web/firestore/type-aliases/UseDocReferenceOptions.md @@ -6,7 +6,7 @@ type UseDocReferenceOptions = object; ``` -Defined in: [web/firestore/useDocReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReference.ts#L6) +Defined in: [web/firestore/useDocReference.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReference.ts#L6) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [web/firestore/useDocReference.ts:6](https://github.com/vpishuk/reac optional path: string; ``` -Defined in: [web/firestore/useDocReference.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReference.ts#L8) +Defined in: [web/firestore/useDocReference.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReference.ts#L8) *** @@ -36,7 +36,7 @@ Defined in: [web/firestore/useDocReference.ts:8](https://github.com/vpishuk/reac optional pathSegments: string[]; ``` -Defined in: [web/firestore/useDocReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReference.ts#L9) +Defined in: [web/firestore/useDocReference.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReference.ts#L9) *** @@ -48,4 +48,4 @@ optional reference: | DocumentReference; ``` -Defined in: [web/firestore/useDocReference.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReference.ts#L7) +Defined in: [web/firestore/useDocReference.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReference.ts#L7) diff --git a/docs/web/firestore/type-aliases/UseDocReferencesOptions.md b/docs/web/firestore/type-aliases/UseDocReferencesOptions.md index cb0feaf..256791b 100644 --- a/docs/web/firestore/type-aliases/UseDocReferencesOptions.md +++ b/docs/web/firestore/type-aliases/UseDocReferencesOptions.md @@ -6,7 +6,7 @@ type UseDocReferencesOptions = object; ``` -Defined in: [web/firestore/useDocReferences.ts:6](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReferences.ts#L6) +Defined in: [web/firestore/useDocReferences.ts:6](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReferences.ts#L6) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [web/firestore/useDocReferences.ts:6](https://github.com/vpishuk/rea path: string; ``` -Defined in: [web/firestore/useDocReferences.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReferences.ts#L8) +Defined in: [web/firestore/useDocReferences.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReferences.ts#L8) *** @@ -36,7 +36,7 @@ Defined in: [web/firestore/useDocReferences.ts:8](https://github.com/vpishuk/rea optional pathSegments: string[]; ``` -Defined in: [web/firestore/useDocReferences.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReferences.ts#L9) +Defined in: [web/firestore/useDocReferences.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReferences.ts#L9) *** @@ -48,4 +48,4 @@ optional reference: | DocumentReference; ``` -Defined in: [web/firestore/useDocReferences.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useDocReferences.ts#L7) +Defined in: [web/firestore/useDocReferences.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useDocReferences.ts#L7) diff --git a/docs/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md b/docs/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md index c564cd8..fe6a5b8 100644 --- a/docs/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md +++ b/docs/web/firestore/type-aliases/UseGetRealtimeDocDataOptions.md @@ -6,7 +6,7 @@ type UseGetRealtimeDocDataOptions = object; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L10) +Defined in: [web/firestore/useGetRealtimeDocData.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L10) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [web/firestore/useGetRealtimeDocData.ts:10](https://github.com/vpish optional onError: (error) => unknown; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:28](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L28) +Defined in: [web/firestore/useGetRealtimeDocData.ts:28](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L28) A callback to be called if the listen fails or is cancelled. No further callbacks will occur. @@ -49,7 +49,7 @@ cancelled. No further callbacks will occur. optional path: string; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L14) +Defined in: [web/firestore/useGetRealtimeDocData.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L14) A slash-separated path to a document. Has to be omitted to use @@ -61,7 +61,7 @@ A slash-separated path to a document. Has to be omitted to use optional pathSegments: string[]; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:23](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L23) +Defined in: [web/firestore/useGetRealtimeDocData.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L23) Additional path segments that will be applied relative to the first argument. @@ -76,6 +76,6 @@ optional reference: | DocumentReference; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:18](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L18) +Defined in: [web/firestore/useGetRealtimeDocData.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L18) A reference to a collection. diff --git a/docs/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md b/docs/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md index 8e9e377..092b2ae 100644 --- a/docs/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md +++ b/docs/web/firestore/type-aliases/UseGetRealtimeDocDataResult.md @@ -6,7 +6,7 @@ type UseGetRealtimeDocDataResult = object; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:34](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L34) +Defined in: [web/firestore/useGetRealtimeDocData.ts:34](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L34) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [web/firestore/useGetRealtimeDocData.ts:34](https://github.com/vpish data: AppModelType | null; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:35](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L35) +Defined in: [web/firestore/useGetRealtimeDocData.ts:35](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L35) *** @@ -32,7 +32,7 @@ Defined in: [web/firestore/useGetRealtimeDocData.ts:35](https://github.com/vpish error: FirebaseError | null; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:37](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L37) +Defined in: [web/firestore/useGetRealtimeDocData.ts:37](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L37) *** @@ -42,7 +42,7 @@ Defined in: [web/firestore/useGetRealtimeDocData.ts:37](https://github.com/vpish isError: boolean; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:36](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L36) +Defined in: [web/firestore/useGetRealtimeDocData.ts:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L36) *** @@ -52,4 +52,4 @@ Defined in: [web/firestore/useGetRealtimeDocData.ts:36](https://github.com/vpish isFetching: boolean; ``` -Defined in: [web/firestore/useGetRealtimeDocData.ts:38](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useGetRealtimeDocData.ts#L38) +Defined in: [web/firestore/useGetRealtimeDocData.ts:38](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useGetRealtimeDocData.ts#L38) diff --git a/docs/web/firestore/type-aliases/UseQueryConstraints.md b/docs/web/firestore/type-aliases/UseQueryConstraints.md index 1f79fc3..994df23 100644 --- a/docs/web/firestore/type-aliases/UseQueryConstraints.md +++ b/docs/web/firestore/type-aliases/UseQueryConstraints.md @@ -6,7 +6,7 @@ type UseQueryConstraints = object; ``` -Defined in: web/firestore/useQueryConstraints.ts:18 +Defined in: [web/firestore/useQueryConstraints.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useQueryConstraints.ts#L18) ## Type Parameters @@ -22,6 +22,6 @@ Defined in: web/firestore/useQueryConstraints.ts:18 constraints: NonFilterQueryConstraint[]; ``` -Defined in: web/firestore/useQueryConstraints.ts:22 +Defined in: [web/firestore/useQueryConstraints.ts:22](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useQueryConstraints.ts#L22) A list of constraints such as limit, order, offset. diff --git a/docs/web/firestore/type-aliases/UseRunTransactionOptions.md b/docs/web/firestore/type-aliases/UseRunTransactionOptions.md index 3ac2a79..9bcb25a 100644 --- a/docs/web/firestore/type-aliases/UseRunTransactionOptions.md +++ b/docs/web/firestore/type-aliases/UseRunTransactionOptions.md @@ -6,7 +6,7 @@ type UseRunTransactionOptions = object; ``` -Defined in: [web/firestore/useRunTransaction.ts:9](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useRunTransaction.ts#L9) +Defined in: [web/firestore/useRunTransaction.ts:9](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useRunTransaction.ts#L9) ## Type Parameters @@ -26,4 +26,4 @@ Defined in: [web/firestore/useRunTransaction.ts:9](https://github.com/vpishuk/re optional options: Omit, "mutationFn">; ``` -Defined in: [web/firestore/useRunTransaction.ts:10](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useRunTransaction.ts#L10) +Defined in: [web/firestore/useRunTransaction.ts:10](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useRunTransaction.ts#L10) diff --git a/docs/web/firestore/type-aliases/UseRunTransactionValues.md b/docs/web/firestore/type-aliases/UseRunTransactionValues.md index 4b4d1ef..cda6080 100644 --- a/docs/web/firestore/type-aliases/UseRunTransactionValues.md +++ b/docs/web/firestore/type-aliases/UseRunTransactionValues.md @@ -6,7 +6,7 @@ type UseRunTransactionValues = (transaction) => AppModelType; ``` -Defined in: [web/firestore/useRunTransaction.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useRunTransaction.ts#L7) +Defined in: [web/firestore/useRunTransaction.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useRunTransaction.ts#L7) ## Type Parameters diff --git a/docs/web/firestore/type-aliases/UseSetDocMutationOptions.md b/docs/web/firestore/type-aliases/UseSetDocMutationOptions.md index c56e97a..9accf36 100644 --- a/docs/web/firestore/type-aliases/UseSetDocMutationOptions.md +++ b/docs/web/firestore/type-aliases/UseSetDocMutationOptions.md @@ -6,7 +6,7 @@ type UseSetDocMutationOptions = object; ``` -Defined in: [web/firestore/useSetDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L11) +Defined in: [web/firestore/useSetDocMutation.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L11) ## Type Parameters @@ -30,7 +30,7 @@ Defined in: [web/firestore/useSetDocMutation.ts:11](https://github.com/vpishuk/r optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [web/firestore/useSetDocMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L17) +Defined in: [web/firestore/useSetDocMutation.ts:17](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L17) *** @@ -40,4 +40,4 @@ Defined in: [web/firestore/useSetDocMutation.ts:17](https://github.com/vpishuk/r reference: DocumentReference | null; ``` -Defined in: [web/firestore/useSetDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L16) +Defined in: [web/firestore/useSetDocMutation.ts:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L16) diff --git a/docs/web/firestore/type-aliases/UseSetDocMutationValues.md b/docs/web/firestore/type-aliases/UseSetDocMutationValues.md index 1982072..38be229 100644 --- a/docs/web/firestore/type-aliases/UseSetDocMutationValues.md +++ b/docs/web/firestore/type-aliases/UseSetDocMutationValues.md @@ -6,7 +6,7 @@ type UseSetDocMutationValues = object; ``` -Defined in: [web/firestore/useSetDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L7) +Defined in: [web/firestore/useSetDocMutation.ts:7](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L7) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [web/firestore/useSetDocMutation.ts:7](https://github.com/vpishuk/re data: WithFieldValue; ``` -Defined in: [web/firestore/useSetDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useSetDocMutation.ts#L8) +Defined in: [web/firestore/useSetDocMutation.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useSetDocMutation.ts#L8) diff --git a/docs/web/firestore/type-aliases/UseUpdateDocMutationOptions.md b/docs/web/firestore/type-aliases/UseUpdateDocMutationOptions.md index dd1bb78..ac5b2b3 100644 --- a/docs/web/firestore/type-aliases/UseUpdateDocMutationOptions.md +++ b/docs/web/firestore/type-aliases/UseUpdateDocMutationOptions.md @@ -6,7 +6,7 @@ type UseUpdateDocMutationOptions = object; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L18) +Defined in: [web/firestore/useUpdateDocMutation.ts:18](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L18) ## Type Parameters @@ -30,7 +30,7 @@ Defined in: [web/firestore/useUpdateDocMutation.ts:18](https://github.com/vpishu optional converter: FirestoreDataConverter; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:24](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L24) +Defined in: [web/firestore/useUpdateDocMutation.ts:24](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L24) *** @@ -40,7 +40,7 @@ Defined in: [web/firestore/useUpdateDocMutation.ts:24](https://github.com/vpishu optional options: Omit, TContext>, "mutationFn" | "mutationKey">; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:25](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L25) +Defined in: [web/firestore/useUpdateDocMutation.ts:25](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L25) *** @@ -50,4 +50,4 @@ Defined in: [web/firestore/useUpdateDocMutation.ts:25](https://github.com/vpishu reference: DocumentReference | null; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:23](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L23) +Defined in: [web/firestore/useUpdateDocMutation.ts:23](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L23) diff --git a/docs/web/firestore/type-aliases/UseUpdateDocMutationValues.md b/docs/web/firestore/type-aliases/UseUpdateDocMutationValues.md index a3e3082..ef9bce0 100644 --- a/docs/web/firestore/type-aliases/UseUpdateDocMutationValues.md +++ b/docs/web/firestore/type-aliases/UseUpdateDocMutationValues.md @@ -6,7 +6,7 @@ type UseUpdateDocMutationValues = object; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:14](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L14) +Defined in: [web/firestore/useUpdateDocMutation.ts:14](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L14) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [web/firestore/useUpdateDocMutation.ts:14](https://github.com/vpishu data: UpdateData; ``` -Defined in: [web/firestore/useUpdateDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/firestore/useUpdateDocMutation.ts#L15) +Defined in: [web/firestore/useUpdateDocMutation.ts:15](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/firestore/useUpdateDocMutation.ts#L15) diff --git a/docs/web/remoteConfig/functions/useFetchAndActivate.md b/docs/web/remoteConfig/functions/useFetchAndActivate.md index f032391..6906519 100644 --- a/docs/web/remoteConfig/functions/useFetchAndActivate.md +++ b/docs/web/remoteConfig/functions/useFetchAndActivate.md @@ -6,7 +6,7 @@ function useFetchAndActivate(): object ``` -Defined in: [web/remoteConfig/useFetchAndActivate.ts:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/remoteConfig/useFetchAndActivate.ts#L12) +Defined in: [web/remoteConfig/useFetchAndActivate.ts:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/remoteConfig/useFetchAndActivate.ts#L12) Custom hook to fetch and activate remote configuration settings. Initializes remote configuration, fetches, activates it, and tracks the fetch status. diff --git a/docs/web/remoteConfig/functions/useGetValue.md b/docs/web/remoteConfig/functions/useGetValue.md index 66f9ef6..a761a83 100644 --- a/docs/web/remoteConfig/functions/useGetValue.md +++ b/docs/web/remoteConfig/functions/useGetValue.md @@ -6,7 +6,7 @@ function useGetValue(key): null | Value ``` -Defined in: [web/remoteConfig/useGetValue.ts:11](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/remoteConfig/useGetValue.ts#L11) +Defined in: [web/remoteConfig/useGetValue.ts:11](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/remoteConfig/useGetValue.ts#L11) Custom hook to retrieve a value associated with a specified key from remote configuration. Utilizes memoization to optimize performance by recalculating the result only if dependencies change. diff --git a/docs/web/remoteConfig/functions/useRemoteConfig.md b/docs/web/remoteConfig/functions/useRemoteConfig.md index a6c17e3..536c803 100644 --- a/docs/web/remoteConfig/functions/useRemoteConfig.md +++ b/docs/web/remoteConfig/functions/useRemoteConfig.md @@ -6,7 +6,7 @@ function useRemoteConfig(): RemoteConfig ``` -Defined in: [web/remoteConfig/useRemoteConfig.ts:8](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/remoteConfig/useRemoteConfig.ts#L8) +Defined in: [web/remoteConfig/useRemoteConfig.ts:8](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/remoteConfig/useRemoteConfig.ts#L8) Hook to access the Firebase Remote Config instance from the context. diff --git a/docs/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md b/docs/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md index c109763..6071b8f 100644 --- a/docs/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md +++ b/docs/web/type-aliases/FirebaseContextProviderAuthEmulatorConfig.md @@ -6,7 +6,7 @@ type FirebaseContextProviderAuthEmulatorConfig = object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:26](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L26) +Defined in: [web/context/FirebaseContextProvider.tsx:26](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L26) ## Properties @@ -16,6 +16,6 @@ Defined in: [web/context/FirebaseContextProvider.tsx:26](https://github.com/vpis host: string; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:30](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L30) +Defined in: [web/context/FirebaseContextProvider.tsx:30](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L30) Host to connect to Firebase Auth Emulator diff --git a/docs/web/type-aliases/FirebaseContextProviderEmulators.md b/docs/web/type-aliases/FirebaseContextProviderEmulators.md index fafd362..8cf34a4 100644 --- a/docs/web/type-aliases/FirebaseContextProviderEmulators.md +++ b/docs/web/type-aliases/FirebaseContextProviderEmulators.md @@ -6,7 +6,7 @@ type FirebaseContextProviderEmulators = object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:36](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L36) +Defined in: [web/context/FirebaseContextProvider.tsx:36](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L36) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/context/FirebaseContextProvider.tsx:36](https://github.com/vpis optional auth: object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:44](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L44) +Defined in: [web/context/FirebaseContextProvider.tsx:44](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L44) Defines configuration for Firebase Auth emulator. Optional @@ -36,7 +36,7 @@ Host to connect to Firebase Auth Emulator optional firestore: object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:40](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L40) +Defined in: [web/context/FirebaseContextProvider.tsx:40](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L40) Defines configuration for Firebase Firestore emulator. Optional. diff --git a/docs/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md b/docs/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md index 9f6864e..bed4006 100644 --- a/docs/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md +++ b/docs/web/type-aliases/FirebaseContextProviderFirestoreEmulatorConfig.md @@ -6,7 +6,7 @@ type FirebaseContextProviderFirestoreEmulatorConfig = object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:12](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L12) +Defined in: [web/context/FirebaseContextProvider.tsx:12](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L12) ## Properties @@ -16,7 +16,7 @@ Defined in: [web/context/FirebaseContextProvider.tsx:12](https://github.com/vpis host: string; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:16](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L16) +Defined in: [web/context/FirebaseContextProvider.tsx:16](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L16) Host to connect to Firebase Firestore Emulator @@ -28,6 +28,6 @@ Host to connect to Firebase Firestore Emulator port: number; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:20](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L20) +Defined in: [web/context/FirebaseContextProvider.tsx:20](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L20) Port to connect to Firebase Firestore Emulator diff --git a/docs/web/type-aliases/FirebaseContextProviderProps.md b/docs/web/type-aliases/FirebaseContextProviderProps.md index 78463cf..1301d93 100644 --- a/docs/web/type-aliases/FirebaseContextProviderProps.md +++ b/docs/web/type-aliases/FirebaseContextProviderProps.md @@ -6,7 +6,7 @@ type FirebaseContextProviderProps = PropsWithChildren & object; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:50](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L50) +Defined in: [web/context/FirebaseContextProvider.tsx:50](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L50) ## Type declaration diff --git a/docs/web/variables/FirebaseContextProvider.md b/docs/web/variables/FirebaseContextProvider.md index d764d07..0d47935 100644 --- a/docs/web/variables/FirebaseContextProvider.md +++ b/docs/web/variables/FirebaseContextProvider.md @@ -26,7 +26,7 @@ const FirebaseContextProvider: React.FC<{ }>; ``` -Defined in: [web/context/FirebaseContextProvider.tsx:132](https://github.com/vpishuk/react-query-firebase/blob/09a15a5d938c4bdaa4fd86491bcf8ea41c16371f/web/context/FirebaseContextProvider.tsx#L132) +Defined in: [web/context/FirebaseContextProvider.tsx:132](https://github.com/vpishuk/react-query-firebase/blob/10e2945f75363a784c3dfc0e90b9f7a489dcc848/web/context/FirebaseContextProvider.tsx#L132) FirebaseContextProvider component configures and provides Firebase services to its children. Initializes Firebase app and enables optional Firebase services such as Firestore, Auth, Analytics, diff --git a/react-native/firestore/useCompositeFilter.ts b/react-native/firestore/useCompositeFilter.ts index 4006565..b9bd1f1 100644 --- a/react-native/firestore/useCompositeFilter.ts +++ b/react-native/firestore/useCompositeFilter.ts @@ -1,36 +1,62 @@ import firebase, { FirebaseFirestoreTypes, and, or, where } from "@react-native-firebase/firestore"; import { useMemo } from "react"; +import { AppModel } from "../../types"; -type CompositeFilterDocumentData = FirebaseFirestoreTypes.DocumentData; +export type QueryFilterConstraint = + | FirebaseFirestoreTypes.QueryCompositeFilterConstraint + | FirebaseFirestoreTypes.QueryFilterConstraint; -export type QueryElement = { +export type QueryElement = { operator?: "OR" | "AND"; children?: QueryElement[]; - field?: keyof (DbModelType & { documentId?: string[] }); - value?: DbModelType[keyof DbModelType]; + field?: keyof (AppModelType & { documentId?: string[] }); + value?: AppModelType[keyof AppModelType]; op?: FirebaseFirestoreTypes.WhereFilterOp; }; -export type CompositeFilter = { +export type CompositeFilter = { operator: "OR" | "AND"; - children: QueryElement[]; + children: QueryElement[]; }; -export type UseCompositeFilter = { - query?: CompositeFilter; +/** + * @inline + */ +export type UseCompositeFilter = { + query?: CompositeFilter; }; /** - * Constructs a composite query filter based on the provided query structure. + * Constructs a composite or where query filter based on the provided query structure. * It recursively builds query constraints using logical "or" or "and" operators. * - * @param {QueryElement} query - The query element or structure to be evaluated and transformed into filter constraints. - * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived. + * @group Utility + * + * @param {QueryElement} query + * + * @returns {QueryFilterConstraint | null} + * + * @example + * ```jsx + * export const MyComponent = () => { + * const filter = buildCompositeFilter({ + * operator: "AND", + * children: [ + * { + * field: "field", + * value: "value", + * op: "==" + * }, + * ...(query ? [query] : []) + * ] + * }); + * console.log(filter); + * }; + * ``` */ - -export const buildCompositeFilter = ( - query: QueryElement -): FirebaseFirestoreTypes.QueryFilterConstraint | null => { +export const buildCompositeFilter = ( + query: QueryElement +): QueryFilterConstraint | null => { if (query.children) { const queryConstraints = query.children.map(buildCompositeFilter).filter((constraint) => !!constraint); @@ -57,22 +83,41 @@ export const buildCompositeFilter = } query * - * @param {Object} query - The query configuration object that contains subqueries and a type for logical combination. - * @param {string} query.type - The type of composite operation ('or'/'and'). - * @param {Array} query.children - An array of subqueries that will be processed to form the composite filter. + * @returns {QueryFilterConstraint | null} * - * @returns {(Function|undefined)} A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints. + * @example + * ```jsx + * export const MyComponent = () => { + * const filter = useCompositeFilter({ + * operator: "AND", + * children: [ + * { + * field: "field", + * value: "value", + * op: "==" + * }, + * ...(query ? [query] : []) + * ] + * }); + * console.log(filter); + * }; + * ``` */ -export const useCompositeFilter = ({ +export const useCompositeFilter = ({ query -}: UseCompositeFilter) => { +}: UseCompositeFilter): QueryFilterConstraint | undefined => { return useMemo(() => { const queryConstraints = - query?.children?.map?.((subQuery) => buildCompositeFilter(subQuery)) - ?.filter?.((constraint) => !!constraint) ?? []; + query?.children + ?.map?.((subQuery) => buildCompositeFilter(subQuery)) + ?.filter?.((constraint) => !!constraint) ?? []; if (queryConstraints.length <= 0) { return undefined; diff --git a/react-native/firestore/useCountQuery.ts b/react-native/firestore/useCountQuery.ts index 195cb11..688b472 100644 --- a/react-native/firestore/useCountQuery.ts +++ b/react-native/firestore/useCountQuery.ts @@ -11,34 +11,58 @@ import { useQuery as useReactQuery, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; -type UseCountQueryOptions< - AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData -> = { +/** + * @inline + */ +type UseCountQueryOptions = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit, "queryFn"> & Required, "queryKey">>; + + /** + * Reference to a Firestore collection + */ collectionReference: FirebaseFirestoreTypes.CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** * Executes a query with specified constraints and returns the count of matched documents. * - * This function utilizes React Query to asynchronously fetch the count of documents from a server database - * that match the provided query constraints and an optional composite filter. + * @group Hook * * @param {UseCountQueryOptions} options - Configuration options for the query. - * @param {AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData} [options.options] - Additional options for the React Query. - * @param {unknown} [options.query] - Reference to the query object to be executed. - * @param {unknown[]} [options.queryConstraints=[]] - An array of constraints to apply to the query. - * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query. + * * @returns {UseQueryResult} An object containing the number of documents that match the query. + * + * @example + * ```jsx + * export const MyComponent = () => { + * const count = useCountQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(count); + * }; + * ``` */ - -export const useCountQuery = < - AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData ->({ +export const useCountQuery = ({ options, collectionReference, queryConstraints = [], diff --git a/react-native/firestore/useInfiniteQuery.ts b/react-native/firestore/useInfiniteQuery.ts index 5212d24..3ab419e 100644 --- a/react-native/firestore/useInfiniteQuery.ts +++ b/react-native/firestore/useInfiniteQuery.ts @@ -13,12 +13,20 @@ import { UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; +/** + * @inline + */ type UseInfiniteQueryOptions< - AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, + AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown > = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit< UseReactInfiniteQueryOptions< AppModelType[], @@ -43,26 +51,57 @@ type UseInfiniteQueryOptions< "queryKey" > >; + + /** + * Reference to a Firestore collection + */ collectionReference: FirebaseFirestoreTypes.CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** - * Custom hook that creates an infinite query using Firestore, allowing for query constraints, composite filters, and converters. - * It fetches data in pages and can load more as required. + * Executes an infinite query on a Firestore data source and returns the resulting documents as an array. * - * @param {UseInfiniteQueryOptions} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter. - * @returns {UseInfiniteQueryResult>} Result object containing the infinite data and methods for fetching more pages. + * @group Hook + * + * @param {UseInfiniteQueryOptions} options - Configuration options for the query. + * + * @returns {UseInfiniteQueryResult>} An object containing documents that match the query. + * + * @example + * ```jsx + * export const MyComponent = () => { + * const docs = useInfiniteQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(docs); + * }; + * ``` */ export const useInfiniteQuery = < - AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData + AppModelType extends AppModel = AppModel, + TQueryKey extends QueryKey = QueryKey, + TPageParam = unknown >({ options, collectionReference, queryConstraints = [], compositeFilter -}: UseInfiniteQueryOptions): UseInfiniteQueryResult> => { +}: UseInfiniteQueryOptions): UseInfiniteQueryResult< + InfiniteData +> => { return useInfiniteReactQuery({ ...options, queryFn: async ({ pageParam }) => { diff --git a/react-native/firestore/useQuery.ts b/react-native/firestore/useQuery.ts index 64584db..31d894a 100644 --- a/react-native/firestore/useQuery.ts +++ b/react-native/firestore/useQuery.ts @@ -11,32 +11,58 @@ import { useQuery as useReactQuery, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; -type UseQueryOptions = { +/** + * @inline + */ +type UseQueryOptions = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit, "queryFn"> & Required, "queryKey">>; + + /** + * Reference to a Firestore collection + */ collectionReference: FirebaseFirestoreTypes.CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** - * Executes a query on a Firestore-like data source and returns the resulting documents as an array. + * Executes a query on a Firestore data source and returns the resulting documents as an array. + * + * @group Hook * - * This hook utilizes an abstraction over React Query to asynchronously fetch data based on the provided query - * reference and constraints. It supports optional filtering, conversion, and additional query constraints. + * @param {UseQueryOptions} options - Configuration options for the query. * - * @param {UseQueryOptions} options - Configuration options for the query. - * @param {FirebaseFirestoreTypes.DocumentReference} collectionReference - The reference to the query to be executed. - * @param {QueryConstraint[]} queryConstraints - Additional constraints to fine-tune the query. - * @param {QueryConstraint} compositeFilter - Optional composite filter to apply to the query. - * @param {FirestoreDataConverter} converter - Optional data converter for transforming snapshots. + * @returns {UseQueryResult} An object containing documents that match the query. * - * @returns {UseQueryResult} Result containing an array of documents that match the query criteria. + * @example + * ```jsx + * export const MyComponent = () => { + * const docs = useQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(docs); + * }; + * ``` */ -export const useQuery = < - AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData ->({ +export const useQuery = ({ options, collectionReference, queryConstraints = [], diff --git a/web/firestore/useCompositeFilter.ts b/web/firestore/useCompositeFilter.ts index ada1a38..b3b437f 100644 --- a/web/firestore/useCompositeFilter.ts +++ b/web/firestore/useCompositeFilter.ts @@ -1,35 +1,67 @@ -import { DocumentData, QueryFilterConstraint, WhereFilterOp, documentId, and, or, where } from "firebase/firestore"; +import { + QueryFilterConstraint as FBQueryFilterConstraint, + QueryCompositeFilterConstraint as FBQueryCompositeFilterConstraint, + WhereFilterOp, + documentId, + and, + or, + where +} from "firebase/firestore"; import { useMemo } from "react"; +import { AppModel } from "../../types"; -type CompositeFilterDocumentData = DocumentData; +export type QueryFilterConstraint = FBQueryFilterConstraint | FBQueryCompositeFilterConstraint; -export type QueryElement = { +export type QueryElement = { operator?: "OR" | "AND"; children?: QueryElement[]; - field?: keyof (DbModelType & { documentId?: string[] }); - value?: DbModelType[keyof DbModelType]; + field?: keyof (AppModelType & { documentId?: string[] }); + value?: AppModelType[keyof AppModelType]; op?: WhereFilterOp; }; -export type CompositeFilter = { +export type CompositeFilter = { operator: "OR" | "AND"; - children: QueryElement[]; + children: QueryElement[]; }; -export type UseCompositeFilter = { - query?: CompositeFilter; +/** + * @inline + */ +export type UseCompositeFilter = { + query?: CompositeFilter; }; /** - * Constructs a composite query filter based on the provided query structure. + * Constructs a composite or where query filter based on the provided query structure. * It recursively builds query constraints using logical "or" or "and" operators. * - * @param {QueryElement} query - The query element or structure to be evaluated and transformed into filter constraints. - * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived. + * @group Utility + * + * @param {QueryElement} query + * + * @returns {QueryFilterConstraint | null} + * + * @example + * ```jsx + * export const MyComponent = () => { + * const filter = buildCompositeFilter({ + * operator: "AND", + * children: [ + * { + * field: "field", + * value: "value", + * op: "==" + * }, + * ...(query ? [query] : []) + * ] + * }); + * console.log(filter); + * }; + * ``` */ - -export const buildCompositeFilter = ( - query: QueryElement +export const buildCompositeFilter = ( + query: QueryElement ): QueryFilterConstraint | null => { if (query.children) { const queryConstraints = query.children.map(buildCompositeFilter).filter((constraint) => !!constraint); @@ -49,18 +81,36 @@ export const buildCompositeFilter = } query * - * @param {Object} query - The query configuration object that contains subqueries and a type for logical combination. - * @param {string} query.type - The type of composite operation ('or'/'and'). - * @param {Array} query.children - An array of subqueries that will be processed to form the composite filter. + * @returns {QueryFilterConstraint | null} * - * @returns {(Function|undefined)} A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints. + * @example + * ```jsx + * export const MyComponent = () => { + * const filter = useCompositeFilter({ + * operator: "AND", + * children: [ + * { + * field: "field", + * value: "value", + * op: "==" + * }, + * ...(query ? [query] : []) + * ] + * }); + * console.log(filter); + * }; + * ``` */ -export const useCompositeFilter = ({ +export const useCompositeFilter = ({ query -}: UseCompositeFilter) => { +}: UseCompositeFilter) => { return useMemo(() => { const queryConstraints = query?.children?.map?.((subQuery) => buildCompositeFilter(subQuery))?.filter?.( diff --git a/web/firestore/useCountQuery.ts b/web/firestore/useCountQuery.ts index db787cb..c3d59a3 100644 --- a/web/firestore/useCountQuery.ts +++ b/web/firestore/useCountQuery.ts @@ -1,5 +1,4 @@ import { - DocumentData, getCountFromServer, CollectionReference, query, @@ -13,36 +12,58 @@ import { useQuery as useReactQuery, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; -type UseCountQueryOptions< - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData -> = { +/** + * @inline + */ +type UseCountQueryOptions = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit, "queryFn"> & Required, "queryKey">>; + + /** + * Reference to a Firestore collection + */ collectionReference: CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: QueryCompositeFilterConstraint; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** * Executes a query with specified constraints and returns the count of matched documents. * - * This function utilizes React Query to asynchronously fetch the count of documents from a server database - * that match the provided query constraints and an optional composite filter. + * @group Hook + * + * @param {UseCountQueryOptions} options - Configuration options for the query. * - * @param {UseCountQueryOptions} options - Configuration options for the query. - * @param {AppModelType extends DocumentData = DocumentData} [options.options] - Additional options for the React Query. - * @param {unknown} [options.query] - Reference to the query object to be executed. - * @param {unknown[]} [options.queryConstraints=[]] - An array of constraints to apply to the query. - * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query. * @returns {UseQueryResult} An object containing the number of documents that match the query. + * + * @example + * ```jsx + * export const MyComponent = () => { + * const count = useCountQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(count); + * }; + * ``` */ - -export const useCountQuery = < - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData ->({ +export const useCountQuery = ({ options, collectionReference, queryConstraints = [], @@ -52,7 +73,11 @@ export const useCountQuery = < ...options, queryFn: async () => { const queryToExecute = compositeFilter - ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[])) + ? query( + collectionReference, + compositeFilter as QueryCompositeFilterConstraint, + ...(queryConstraints as QueryNonFilterConstraint[]) + ) : query(collectionReference, ...queryConstraints); const querySnapshot = await getCountFromServer(queryToExecute); diff --git a/web/firestore/useInfiniteQuery.ts b/web/firestore/useInfiniteQuery.ts index 6767e48..ce9c833 100644 --- a/web/firestore/useInfiniteQuery.ts +++ b/web/firestore/useInfiniteQuery.ts @@ -1,7 +1,5 @@ import { CollectionReference, - DocumentData, - FirestoreDataConverter, getDocs, query, QueryCompositeFilterConstraint, @@ -16,12 +14,16 @@ import { UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; -type UseInfiniteQueryOptions< - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData, - TQueryKey extends QueryKey = QueryKey -> = { +/** + * @inline + */ +type UseInfiniteQueryOptions = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit< UseReactInfiniteQueryOptions< AppModelType[], @@ -46,38 +48,64 @@ type UseInfiniteQueryOptions< "queryKey" > >; - collectionReference: CollectionReference; + + /** + * Reference to a Firestore collection + */ + collectionReference: CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: QueryCompositeFilterConstraint; - converter?: FirestoreDataConverter; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** - * Custom hook that creates an infinite query using Firestore, allowing for query constraints, composite filters, and converters. - * It fetches data in pages and can load more as required. + * Executes an infinite query on a Firestore data source and returns the resulting documents as an array. + * + * @group Hook + * + * @param {UseInfiniteQueryOptions} options - Configuration options for the query. + * + * @returns {UseInfiniteQueryResult>} An object containing documents that match the query. * - * @param {UseInfiniteQueryOptions} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter. - * @returns {UseInfiniteQueryResult>} Result object containing the infinite data and methods for fetching more pages. + * @example + * ```jsx + * export const MyComponent = () => { + * const docs = useInfiniteQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(docs); + * }; + * ``` */ -export const useInfiniteQuery = < - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData ->({ +export const useInfiniteQuery = ({ options, collectionReference, queryConstraints = [], - compositeFilter, - converter -}: UseInfiniteQueryOptions): UseInfiniteQueryResult> => { + compositeFilter +}: UseInfiniteQueryOptions): UseInfiniteQueryResult> => { return useInfiniteReactQuery({ ...options, queryFn: async ({ pageParam }) => { const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])]; const queryToExecute = compositeFilter - ? query(collectionReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[])) + ? query( + collectionReference, + compositeFilter as QueryCompositeFilterConstraint, + ...(allQueryConstraints as QueryNonFilterConstraint[]) + ) : query(collectionReference, ...allQueryConstraints); - const querySnapshot = await getDocs(converter ? queryToExecute.withConverter(converter) : queryToExecute); + const querySnapshot = await getDocs(queryToExecute); const docs: AppModelType[] = []; if (querySnapshot) { diff --git a/web/firestore/useQuery.ts b/web/firestore/useQuery.ts index f5b0259..9cb6e6a 100644 --- a/web/firestore/useQuery.ts +++ b/web/firestore/useQuery.ts @@ -1,6 +1,4 @@ import { - DocumentData, - FirestoreDataConverter, getDocs, CollectionReference, query, @@ -14,51 +12,75 @@ import { useQuery as useReactQuery, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query"; +import { QueryFilterConstraint } from "./useCompositeFilter"; +import { AppModel } from "../../types"; -type UseQueryOptions< - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData -> = { +/** + * @inline + */ +type UseQueryOptions = { + /** + * Reqct-query options that must include queryKey and shall not define queryFn + */ options: Omit, "queryFn"> & Required, "queryKey">>; - collectionReference: CollectionReference; + + /** + * Reference to a Firestore collection + */ + collectionReference: CollectionReference; + + /** + * Non composite filter constraints such as limit, order, where + */ queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[]; - compositeFilter?: QueryCompositeFilterConstraint; - converter?: FirestoreDataConverter; + + /** + * Composite filter + */ + compositeFilter?: QueryFilterConstraint; }; /** - * Executes a query on a Firestore-like data source and returns the resulting documents as an array. + * Executes a query on a Firestore data source and returns the resulting documents as an array. + * + * @group Hook * - * This hook utilizes an abstraction over React Query to asynchronously fetch data based on the provided query - * reference and constraints. It supports optional filtering, conversion, and additional query constraints. + * @param {UseQueryOptions} options - Configuration options for the query. * - * @param {UseQueryOptions} options - Configuration options for the query. - * @param {DocumentReference} queryReference - The reference to the query to be executed. - * @param {QueryConstraint[]} queryConstraints - Additional constraints to fine-tune the query. - * @param {QueryConstraint} compositeFilter - Optional composite filter to apply to the query. - * @param {FirestoreDataConverter} converter - Optional data converter for transforming snapshots. + * @returns {UseQueryResult} An object containing documents that match the query. * - * @returns {UseQueryResult} Result containing an array of documents that match the query criteria. + * @example + * ```jsx + * export const MyComponent = () => { + * const docs = useQuery({ + * options: { + * queryKey: ['key'] + * }, + * collectionReference: collection(), + * }); + * console.log(docs); + * }; + * ``` */ -export const useQuery = < - AppModelType extends DocumentData = DocumentData, - DbModelType extends DocumentData = DocumentData ->({ +export const useQuery = ({ options, collectionReference, queryConstraints = [], - compositeFilter, - converter -}: UseQueryOptions): UseQueryResult => { + compositeFilter +}: UseQueryOptions): UseQueryResult => { return useReactQuery({ ...options, queryFn: async () => { const queryToExecute = compositeFilter - ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[])) + ? query( + collectionReference, + compositeFilter as QueryCompositeFilterConstraint, + ...(queryConstraints as QueryNonFilterConstraint[]) + ) : query(collectionReference, ...queryConstraints); - const querySnapshot = await getDocs(converter ? queryToExecute.withConverter(converter) : queryToExecute); + const querySnapshot = await getDocs(queryToExecute); const docs: AppModelType[] = []; if (querySnapshot) {