API Documentation / @pinia/colada / PiniaColadaQueryHooksPlugin

Function: PiniaColadaQueryHooksPlugin()

function PiniaColadaQueryHooksPlugin(options): PiniaColadaPlugin;

Allows to add global hooks to all queries:

• onSuccess: called when a query is successful
• onError: called when a query throws an error
• onSettled: called when a query is settled (either successfully or with an error)

Parameters

options

PiniaColadaQueryHooksPluginOptions

Pinia Colada Query Hooks plugin options

Returns

PiniaColadaPlugin

Example

import { PiniaColada, PiniaColadaQueryHooksPlugin } from '@pinia/colada'

const app = createApp(App)
// app setup with other plugins
app.use(PiniaColada, {
  plugins: [
    PiniaColadaQueryHooksPlugin({
      onError(error, entry) {
        // ...
      },
    }),
  ],
})