Interface: UseAddressReturn
Defined in: composables/react/useAddress.ts:78
State and CRUD actions returned by useAddress.
Properties
createAddress
createAddress: (
input) =>Promise<{address?:Address;error?:string;success:boolean; }>
Defined in: composables/react/useAddress.ts:84
Creates a company- or customer-scoped address depending on the user kind.
Parameters
input
Returns
Promise<{ address?: Address; error?: string; success: boolean; }>
deleteAddress
deleteAddress: (
addressId) =>Promise<{error?:string;success:boolean; }>
Defined in: composables/react/useAddress.ts:88
Deletes an address by id.
Parameters
addressId
number
Returns
Promise<{ error?: string; success: boolean; }>
error
error:
string|null
Defined in: composables/react/useAddress.ts:82
Last error message, or null.
loading
loading:
boolean
Defined in: composables/react/useAddress.ts:80
true while any CRUD call is in flight.
setDefaultAddress
setDefaultAddress: (
addressId) =>Promise<{error?:string;success:boolean; }>
Defined in: composables/react/useAddress.ts:90
Marks an address as default by issuing an update with isDefault: Y.
Parameters
addressId
number
Returns
Promise<{ error?: string; success: boolean; }>
updateAddress
updateAddress: (
addressId,input) =>Promise<{address?:Address;error?:string;success:boolean; }>
Defined in: composables/react/useAddress.ts:86
Updates an existing address by id; address type cannot be changed.
Parameters
addressId
number
input
Partial<AddressInput>
Returns
Promise<{ address?: Address; error?: string; success: boolean; }>