From 1583a82022bfd404e94f28d1786e596d6b5a9f43 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 9 Nov 2021 12:42:03 -0800 Subject: [PATCH] [Auth] Fix credentialFromResult docs (#5715) * Fix credentialFromResult docs * Changeset --- .changeset/seven-glasses-worry.md | 5 +++++ packages/auth/src/core/providers/facebook.ts | 4 ++-- packages/auth/src/core/providers/github.ts | 4 ++-- packages/auth/src/core/providers/google.ts | 4 ++-- packages/auth/src/core/providers/twitter.ts | 4 ++-- 5 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 .changeset/seven-glasses-worry.md diff --git a/.changeset/seven-glasses-worry.md b/.changeset/seven-glasses-worry.md new file mode 100644 index 00000000000..607e5bc5a85 --- /dev/null +++ b/.changeset/seven-glasses-worry.md @@ -0,0 +1,5 @@ +--- +"@firebase/auth": patch +--- + +Fix Provider.credentialFromResult documentation snippets diff --git a/packages/auth/src/core/providers/facebook.ts b/packages/auth/src/core/providers/facebook.ts index 16cf6dc8236..ce664605505 100644 --- a/packages/auth/src/core/providers/facebook.ts +++ b/packages/auth/src/core/providers/facebook.ts @@ -42,7 +42,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // This is the signed-in user * const user = result.user; * // This gives you a Facebook Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = FacebookAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * } * ``` @@ -57,7 +57,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // The signed-in user info. * const user = result.user; * // This gives you a Facebook Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = FacebookAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * ``` * diff --git a/packages/auth/src/core/providers/github.ts b/packages/auth/src/core/providers/github.ts index 3e8c152a7d2..68003171689 100644 --- a/packages/auth/src/core/providers/github.ts +++ b/packages/auth/src/core/providers/github.ts @@ -46,7 +46,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // This is the signed-in user * const user = result.user; * // This gives you a Github Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = GithubAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * } * ``` @@ -61,7 +61,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // The signed-in user info. * const user = result.user; * // This gives you a Github Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = GithubAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * ``` * @public diff --git a/packages/auth/src/core/providers/google.ts b/packages/auth/src/core/providers/google.ts index 3aa6cfa5562..764ac9d2601 100644 --- a/packages/auth/src/core/providers/google.ts +++ b/packages/auth/src/core/providers/google.ts @@ -44,7 +44,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // This is the signed-in user * const user = result.user; * // This gives you a Google Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = GoogleAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * } * ``` @@ -60,7 +60,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // The signed-in user info. * const user = result.user; * // This gives you a Google Access Token. - * const credential = provider.credentialFromResult(auth, result); + * const credential = GoogleAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * ``` * diff --git a/packages/auth/src/core/providers/twitter.ts b/packages/auth/src/core/providers/twitter.ts index 8aa35c7ab9a..77c78db56d4 100644 --- a/packages/auth/src/core/providers/twitter.ts +++ b/packages/auth/src/core/providers/twitter.ts @@ -59,7 +59,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // This is the signed-in user * const user = result.user; * // This gives you a Twitter Access Token and Secret. - * const credential = provider.credentialFromResult(auth, result); + * const credential = TwitterAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * const secret = credential.secret; * } @@ -74,7 +74,7 @@ import { ProviderId, SignInMethod } from '../../model/enums'; * // The signed-in user info. * const user = result.user; * // This gives you a Twitter Access Token and Secret. - * const credential = provider.credentialFromResult(auth, result); + * const credential = TwitterAuthProvider.credentialFromResult(result); * const token = credential.accessToken; * const secret = credential.secret; * ```