Auth0.js: [docs] please document `appState` usage and purpose

Created on 29 Jul 2019  路  3Comments  路  Source: auth0/auth0.js

Description

From time to time the questions about appState opaque local object surface here or on the support forum:
https://community.auth0.com/t/pass-custom-parameters-on-auth0-login-redirect/19075
https://github.com/auth0/auth0.js/issues/662
They are used in the sample code already:
https://auth0.com/docs/quickstart/spa/vuejs#create-an-authentication-service

It could be beneficial to either add the as a note to the docs itself or even change the JDoc to incorporate optional parameter description

Prerequisites

[x] I have checked the documentation for this library.

[x] I have checked the Auth0 Community for related posts.

[x] I have checked for related or duplicate Issues and PRs.

Thanks!

Most helpful comment

done, thanks!

All 3 comments

I think it's a good idea to add to our jsdocs. Do you want to send a PR with this? 馃帀

done, thanks!

Thanks for the PR!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

MaksSlesarenko picture MaksSlesarenko  路  3Comments

StefH picture StefH  路  5Comments

jorgeucano picture jorgeucano  路  6Comments

rfrerebe picture rfrerebe  路  6Comments

beno picture beno  路  3Comments