Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add validateOnPageLoad documentation #211

Merged
merged 2 commits into from
Sep 16, 2015
Merged

Add validateOnPageLoad documentation #211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff13b74
Add validateOnPageLoad documentation
Sep 16, 2015
fc81ba9
Merge pull request #1 from dmackerman/dmackerman-patch-1
Sep 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ angular.module('myApp', ['ng-token-auth'])
emailSignInPath: '/auth/sign_in',
storage: 'cookies',
forceValidateToken: false,
validateOnPageLoad: true,
proxyIf: function() { return false; },
proxyUrl: '/proxy',
omniauthWindowType: 'sameWindow',
Expand Down Expand Up @@ -285,6 +286,8 @@ This method returns a promise that will resolve if a user's auth token exists an

This method automatically is called on page load during the app's run phase so that returning users will not need to manually re-authenticate themselves.

You can disable this automatic check by setting `validateOnPageLoad: false` in the configuration phase.

This method will broadcast the following events:

* On page load:
Expand Down