You are reading the documentation for Vue Storefront v2. See the latest docs.

Home > @vue-storefront/core > UseUser

UseUser interface

Signature:

export interface UseUser<USER, UPDATE_USER_PARAMS, API extends PlatformApi = any> extends Composable<API> 

Extends: Composable

Properties

Property Modifiers Type Description
changePassword (params: { current: string; new: string; customQuery?: CustomQuery; }) => Promise<void>
error ComputedProperty<UseUserErrors>
isAuthenticated Ref<boolean>
load (params?: { customQuery: CustomQuery; }) => Promise<void>
loading ComputedProperty<boolean>
login (params: { user: UseUserLoginParams; customQuery?: CustomQuery; }) => Promise<void>
logout (params?: { customQuery: CustomQuery; }) => Promise<void>
register (params: { user: UseUserRegisterParams; customQuery?: CustomQuery; }) => Promise<void>
setUser (user: USER) => void
updateUser (params: { user: UPDATE_USER_PARAMS; customQuery?: CustomQuery; }) => Promise<void>
user ComputedProperty<USER>