Composables

useSanctumConfig

How to use useSanctumConfig to retrieve module configuration

Usage

This composable provides quick access to the module configuration instead of using useRuntimeConfig and several keys like public.sanctum.

The composable is context-aware - it automatically returns the appropriate configuration based on where it's executed:

  • Server-side (SSR): Returns runtimeConfig.sanctum configuration
  • Client-side (CSR): Returns runtimeConfig.public.sanctum configuration

This allows you to have different settings for server and client contexts (e.g., different baseUrl for Docker internal network vs public TLD).

const config = useSanctumConfig();

// On server: runtimeConfig.sanctum.baseUrl
// On client: runtimeConfig.public.sanctum.baseUrl
console.log(config.baseUrl);

More details about the configuration structure can be found here.