fix useSigninCheck caps in docs

FirebaseExtended · Aug 17, 2022 · 414201e · 414201e
1 parent 467cc2b
commit 414201e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/docs/reference/README.md b/docs/reference/README.md
diff --git a/docs/use.md b/docs/use.md
@@ -206,12 +206,12 @@ To check [custom claims](https://firebase.google.com/docs/auth/admin/custom-clai
 
 ```jsx
 // pass in an object describing the custom claims a user must have
-const { status, data: signInCheckResult } = useSignInCheck({ requiredClaims: { superUser: true } });
+const { status, data: signInCheckResult } = useSigninCheck({ requiredClaims: { superUser: true } });
 
 // OR
 
 // pass in a custom claims validator function
-const { status, data: signInCheckResult } = useSignInCheck({
+const { status, data: signInCheckResult } = useSigninCheck({
   validateCustomClaims: (userClaims) => {
     // custom validation logic...
     return {

diff --git a/src/auth.tsx b/src/auth.tsx
@@ -117,15 +117,15 @@ export interface SignInCheckOptionsClaimsValidator extends SignInCheckOptionsBas
  *
  * ```ts
  * // pass in an object describing the custom claims a user must have
- * const {status, data: signInCheckResult} = useSignInCheck({requiredClaims: {admin: true}});
+ * const {status, data: signInCheckResult} = useSigninCheck({requiredClaims: {admin: true}});
  *
  * // pass in a custom claims validator function
- * const {status, data: signInCheckResult} = useSignInCheck({validateCustomClaims: (userClaims) => {
+ * const {status, data: signInCheckResult} = useSigninCheck({validateCustomClaims: (userClaims) => {
  *   // custom validation logic...
  * }});
  *
  * // You can optionally force-refresh the token
- * const {status, data: signInCheckResult} = useSignInCheck({forceRefresh: true, requiredClaims: {admin: true}});
+ * const {status, data: signInCheckResult} = useSigninCheck({forceRefresh: true, requiredClaims: {admin: true}});
  * ```
  */
 export function useSigninCheck(
@@ -201,7 +201,7 @@ function getClaimsObjectValidator(requiredClaims: Claims): ClaimsValidator {
 }
 
 /**
- * @deprecated Use `useSignInCheck` instead
+ * @deprecated Use `useSigninCheck` instead
  *
  * Conditionally render children based on [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
  *
@@ -238,7 +238,7 @@ export function ClaimsCheck({ user, fallback, children, requiredClaims }: Claims
 }
 
 /**
- * @deprecated Use `useSignInCheck` instead
+ * @deprecated Use `useSigninCheck` instead
  *
  * Conditionally render children based on signed-in status and [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
  *

diff --git a/test/auth.test.tsx b/test/auth.test.tsx
@@ -193,7 +193,7 @@ describe('Authentication', () => {
         claims: requiredClaims,
       };
 
-      // Extra claim passed to useSignInCheck
+      // Extra claim passed to useSigninCheck
       const { result, waitFor: waitForHookCondition } = renderHook(() => useSigninCheck({ requiredClaims: { ...requiredClaims, anExtraClaim: 'true' } }), {
         wrapper: Provider,
       });