Class API

Auth API handles user authentication processes

Hierarchy

API

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new API(transport: API): API

- Defined in modules/Auth.ts:34
Auth API handles user authentication processes

Parameters
- transport: API
Returns API

Properties

cookies

cookies: object

Private transport

transport: API

Methods

findLoggedInUserByHeaders

findLoggedInUserByHeaders(headers: object): Promise<object | false>

- Defined in modules/Auth.ts:68
Finds a logged in user and returns basic user data

Parameters
- headers: object
  
  Session Headers
Returns Promise<object | false>

A Promise that resolves to an object with user data or false if user not found

isLoggedIn

isLoggedIn(headers: object): Promise<boolean>

- Defined in modules/Auth.ts:50
Checks if user is logged in

Parameters
- headers: object
  
  Session Headers
Returns Promise<boolean>

A Promise that resolves to a boolean value signaling if user is logged in

login

login(credentials: Credentials): Promise<AxiosResponse>

- Defined in modules/Auth.ts:100
Logs user in

Parameters
- credentials: Credentials
  
  Credentials to authenticate against Magento
Returns Promise<AxiosResponse>

A Promise that resolves to an object with login result

register

register(userData: UserData): Promise<object>

- Defined in modules/Auth.ts:108
Parameters
- userData: UserData
Returns Promise<object>

Generated using TypeDoc