Advanced

Interceptors

Use custom interceptors for the fetch client used for API calls

Usage

Interceptors allow you to define custom functions that will be used by sanctumClient during API calls. Here are some examples of what you can do with it:

Add custom headers to all requests (e.g. X-Localization, Accept-Language, etc)
Use telemetry or logging for requests/responses
Modify the request payload before sending

If you are not familiar with ofetch interceptors, check this documentation first.

Configuration

This module provides special hooks to define your interceptors:

sanctum:request
sanctum:response

You can set up a new plugin and describe the behaviour of handling each outgoing request and incoming response.

Here is an example of the plugin that writes a log entry for each request and response:

app/plugins/sanctum-listener.ts

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('sanctum:request', (app, ctx, logger) => {
    logger.info('Sanctum request hook triggered', ctx.request)
  })

  nuxtApp.hook('sanctum:response', (app, ctx, logger) => {
    logger.info('Sanctum response hook triggered', ctx.request)
  })
}

Each interceptor receives 3 arguments:

app - an instance of the current NuxtApp
ctx - FetchContext instance for the current operation with access to request, response, and options (query, headers, etc)
logger - an instance of a Consola logger used by the module (will be prefixed with nuxt-auth-sanctum)

sanctum:logout

Subscribe to logout hook to inject custom event handling

Error handling

How to catch Laravel API errors using this module