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

Jump to bottom

Update documentation #188

Merged
merged 1 commit into from
Jun 13, 2023
Merged

Update documentation #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ class AuthProvider {
}

/**
* A function to get user info for logged in user
* A function to get user info for the logged-in user
* @returns available user info
*/
public getUser(): Promise<UserInfo> {
Expand All @@ -224,7 +224,7 @@ class AuthProvider {
}

/**
* A function to determine whether user is logged in
* A function to determine whether the user is logged in
*/
public async isLoggedIn() {
if (this.initStatus === InitStatus.DONE) {
Expand All @@ -235,7 +235,7 @@ class AuthProvider {
}

/**
* A function to logout the user
* A function to log out the user
*/
public logout() {
if (this.initStatus === InitStatus.DONE) {
Expand All @@ -245,7 +245,10 @@ class AuthProvider {
}

/**
* A function to request public key of different users
* A function to request public key of other users
*
* **NOTE**: Currently does not work by default for most applications.
* MFA availability (which is enabled by default) has to be disabled for this to work.
*/
public async getPublicKey(email: string) {
if (this.initStatus === InitStatus.DONE) {
Expand Down