Interface Auth

interface Auth {
    login(params: LoginParams): Promise<UserCredentials>;
    register(params: RegisterParams): Promise<void>;
    changePassword(params: ChangePasswordParams): Promise<void>;
}

Index

Methods

login register changePassword

Methods

login(params: LoginParams): Promise<UserCredentials>
Get a user's credentials without setting the instance's token. Requires either username or email along with a password.
Parameters
- params: LoginParams
  Object with required fields.
Returns Promise<UserCredentials>
User's credentials.
See
MarketClient.login if you want to authenticate an instance.
Example
```
await client.auth.login({ email: 'user@example.com', password: 'prettynewpassword' })
```
- Defined in src/services/auth/service.ts:22

register

register(params: RegisterParams): Promise<void>
Register a new user.
Parameters
- params: RegisterParams
  Object with required fields.
Returns Promise<void>
Example
```
await client.auth.register({
    userName: 'ECS',
    email: 'user@example.com',
    password: 'prettynewpassword'
})
```
- Defined in src/services/auth/service.ts:36

changePassword

changePassword(params: ChangePasswordParams): Promise<void>
Change a user's password.
Parameters
- params: ChangePasswordParams
  Object with required fields.
Returns Promise<void>
Example
```
await client.auth.changePassword({
    email: 'user@example.com',
    currentPassword: 'old-password',
    newPassword: 'prettynewpassword'
})
```
- Defined in src/services/auth/service.ts:50