Skip to main content

Interface: UseFavoritesOptions

Defined in: composables/vue/useFavorites.ts:36

Properties

graphqlClient

graphqlClient: GraphQLClient

Defined in: composables/vue/useFavorites.ts:37


language?

optional language?: Ref<string, string>

Defined in: composables/vue/useFavorites.ts:39


onCreate?

optional onCreate?: (data) => void

Defined in: composables/vue/useFavorites.ts:40

Parameters

data

FavoriteListFormData

Returns

void


onDelete?

optional onDelete?: (id) => void

Defined in: composables/vue/useFavorites.ts:42

Parameters

id

string

Returns

void


onEdit?

optional onEdit?: (id, data) => void

Defined in: composables/vue/useFavorites.ts:41

Parameters

id

string

data

FavoriteListFormData

Returns

void


onListChanged?

optional onListChanged?: (change?) => void

Defined in: composables/vue/useFavorites.ts:51

Called after a list mutation succeeds.

The change argument is optional so existing zero-argument callbacks keep working, but without it a host cannot tell a create from a delete — which makes the composable useless for analytics, audit trails or optimistic UI that needs to know WHAT happened rather than merely THAT something did.

Parameters

change?

FavoriteListChange

Returns

void


user

user: Ref<AnyUser>

Defined in: composables/vue/useFavorites.ts:38