Skip to content

Commit

Permalink
docs(auth): more explicitly note that onIdTokenChanged returns a JWT (#…
Browse files Browse the repository at this point in the history
…5674)

* Update index.d.ts

It's not clear wether ID Token is a JWT Token or not, developer will have to visit [official documentation](https://firebase.google.com/docs/auth/admin/verify-id-tokens) in order to find out.

* Update index.d.ts

added link to official documentation about Verify ID token
  • Loading branch information
efstathiosntonas authored Sep 1, 2021
1 parent 96f51a0 commit 32ddef7
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions packages/auth/lib/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1295,6 +1295,7 @@ export namespace FirebaseAuthTypes {

/**
* Listen for changes in ID token.
* ID token can be verified (if desired) using the [admin SDK or a 3rd party JWT library](https://firebase.google.com/docs/auth/admin/verify-id-tokens)
* This method returns a unsubscribe function to stop listening to events.
* Always ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.
*
Expand Down

1 comment on commit 32ddef7

@vercel
Copy link

@vercel vercel bot commented on 32ddef7 Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.