Skip to content

Commit 414201e

Browse files
committed
fix useSigninCheck caps in docs
1 parent 467cc2b commit 414201e

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/reference/README.md

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/use.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,12 +206,12 @@ To check [custom claims](https://firebase.google.com/docs/auth/admin/custom-clai
206206

207207
```jsx
208208
// pass in an object describing the custom claims a user must have
209-
const { status, data: signInCheckResult } = useSignInCheck({ requiredClaims: { superUser: true } });
209+
const { status, data: signInCheckResult } = useSigninCheck({ requiredClaims: { superUser: true } });
210210

211211
// OR
212212

213213
// pass in a custom claims validator function
214-
const { status, data: signInCheckResult } = useSignInCheck({
214+
const { status, data: signInCheckResult } = useSigninCheck({
215215
validateCustomClaims: (userClaims) => {
216216
// custom validation logic...
217217
return {

src/auth.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,15 @@ export interface SignInCheckOptionsClaimsValidator extends SignInCheckOptionsBas
117117
*
118118
* ```ts
119119
* // pass in an object describing the custom claims a user must have
120-
* const {status, data: signInCheckResult} = useSignInCheck({requiredClaims: {admin: true}});
120+
* const {status, data: signInCheckResult} = useSigninCheck({requiredClaims: {admin: true}});
121121
*
122122
* // pass in a custom claims validator function
123-
* const {status, data: signInCheckResult} = useSignInCheck({validateCustomClaims: (userClaims) => {
123+
* const {status, data: signInCheckResult} = useSigninCheck({validateCustomClaims: (userClaims) => {
124124
* // custom validation logic...
125125
* }});
126126
*
127127
* // You can optionally force-refresh the token
128-
* const {status, data: signInCheckResult} = useSignInCheck({forceRefresh: true, requiredClaims: {admin: true}});
128+
* const {status, data: signInCheckResult} = useSigninCheck({forceRefresh: true, requiredClaims: {admin: true}});
129129
* ```
130130
*/
131131
export function useSigninCheck(
@@ -201,7 +201,7 @@ function getClaimsObjectValidator(requiredClaims: Claims): ClaimsValidator {
201201
}
202202

203203
/**
204-
* @deprecated Use `useSignInCheck` instead
204+
* @deprecated Use `useSigninCheck` instead
205205
*
206206
* Conditionally render children based on [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
207207
*
@@ -238,7 +238,7 @@ export function ClaimsCheck({ user, fallback, children, requiredClaims }: Claims
238238
}
239239

240240
/**
241-
* @deprecated Use `useSignInCheck` instead
241+
* @deprecated Use `useSigninCheck` instead
242242
*
243243
* Conditionally render children based on signed-in status and [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
244244
*

test/auth.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ describe('Authentication', () => {
193193
claims: requiredClaims,
194194
};
195195

196-
// Extra claim passed to useSignInCheck
196+
// Extra claim passed to useSigninCheck
197197
const { result, waitFor: waitForHookCondition } = renderHook(() => useSigninCheck({ requiredClaims: { ...requiredClaims, anExtraClaim: 'true' } }), {
198198
wrapper: Provider,
199199
});

0 commit comments

Comments
 (0)