From 0578e72b369bd9634ba58e1a191b70e2162b748c Mon Sep 17 00:00:00 2001 From: justinsa Date: Mon, 23 Oct 2017 21:03:23 -0500 Subject: [PATCH] Update readme with doNotRedirect documentation Update the readme to include documentation on the functionality of the doNotRedirect parameter for logoutConfirmed. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7d41380..40c9a22 100644 --- a/README.md +++ b/README.md @@ -133,12 +133,13 @@ $authentication.loginRequired(); ``` Broadcast via: ```event:auth-loginRequired```. -### logoutConfirmed() +### logoutConfirmed(doNotRedirect) ```JAVASCRIPT // Remove any existing profile from local storage, notify all listeners of logout, and redirect to: -// 1. lastAttemptedUrl if defined and trackLastAttemptedUrl is true -// 2. onLogoutRedirectUrl if defined -// 3. do not redirect +// 1. do not redirect if @doNotRedirect === true +// 2. lastAttemptedUrl if defined and trackLastAttemptedUrl is true +// 3. onLogoutRedirectUrl if defined +// 4. do not redirect $authentication.logoutConfirmed(); ``` Broadcast via: ```event:auth-logoutConfirmed```.