Class FRUser`Abstract`

High-level API for logging a user in/out and getting profile information.

Index

Constructors

Methods

Constructors

constructor

new FRUser(): FRUser
Returns FRUser

Methods

`Static`login

login<T>(handler: FRStepHandler, options?: ConfigOptions): Promise<FRStep | T>
Logs the user in with the specified step handler, acquires OAuth tokens, and retrieves user profile. Currently not implemented.
Type Parameters
- T
Parameters
- handler: FRStepHandler
  The function to invoke when handling authentication steps
- Optionaloptions: ConfigOptions
  Configuration overrides
Returns Promise<FRStep | T>
Typeparam
T The type of user object expected
- Defined in fr-user/index.ts:34

`Static`logout

logout(options?: LogoutOptions): Promise<void>
Ends the user's session and revokes OAuth tokens.
Parameters
- Optionaloptions: LogoutOptions
  Configuration overrides
Returns Promise<void>
- Defined in fr-user/index.ts:47