Home > @vue-storefront/core > UseUserFactoryParams
UseUserFactoryParams interface
Signature:
export interface UseUserFactoryParams<USER, UPDATE_USER_PARAMS, REGISTER_USER_PARAMS, API extends PlatformApi = any> extends FactoryParams<API>
Extends: FactoryParams
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| changePassword | (context: Context, params: { currentUser: USER; currentPassword: string; newPassword: string; customQuery?: CustomQuery; }) => Promise<USER> | ||
| load | (context: Context, params?: { customQuery: CustomQuery; }) => Promise<USER> | ||
| logIn | (context: Context, params: { username: string; password: string; customQuery?: CustomQuery; }) => Promise<USER> | ||
| logOut | (context: Context, params?: { currentUser: USER; }) => Promise<void> | ||
| register | (context: Context, params: REGISTER_USER_PARAMS & { customQuery?: CustomQuery; }) => Promise<USER> | ||
| updateUser | (context: Context, params: { currentUser: USER; updatedUserData: UPDATE_USER_PARAMS; customQuery?: CustomQuery; }) => Promise<USER> |