[Auth] Fix credentialFromResult docs (#5715)

* Fix credentialFromResult docs * Changeset
firebase · Nov 9, 2021 · 1583a82 · 1583a82
1 parent 3b23a9e
commit 1583a82
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/.changeset/seven-glasses-worry.md 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
@@ -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
@@ -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
@@ -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
@@ -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;
  * ```