Configuration
The only required configuration option is baseUrl
which will be used for API calls to your Laravel API, so you can start using the module with the following definition:
Available options
For any additional configurations, you can adjust the next list of available parameters:
For more details, please check the source code - options.ts.
Overrides
You can override any of these options in the nuxt.config.ts
file:
RuntimeConfig
Module configuration is exposed to runtimeConfig
property of your Nuxt app, so you can override either in sanctum
module config or runtimeConfig.public.sanctum
property.
Environment variables
It is possible to override options via environment variables too. It might be useful when you want to use .env
file to provide baseUrl
for Laravel API.
And here is what it will look like in .env
file:
NUXT_PUBLIC_SANCTUM_BASE_URL='http://localhost:80'
Configuration example
Here is an example of a full module configuration