Configuration

Configure Nuxt Apollo via the apollo property.


Defaults

nuxt.config.ts
export default defineNuxtConfig({  modules: ['@nuxtjs/apollo'],  apollo: {    autoImports: true,    authType: 'Bearer',    authHeader: 'Authorization',    tokenStorage: 'cookie',    proxyCookies: true,    clients: {}  }})

autoImports

  • Default: true

Determine if vue-apollo composables should be automatically imported and accessible within your nuxt app.

authType

  • Default: Bearer

Specify the Authentication scheme.

authHeader

  • Default: Authorization

Name of the Authentication token header.

tokenStorage

  • Default: cookie

Specify if the auth token should be stored in cookie or localStorage. Cookie storage is required for SSR.

proxyCookies

  • Default: true

Specify if client cookies should be proxied to the server.

clients

Configure your Apollo Client instances.

nuxt.config.ts
export default defineNuxtConfig({  modules: ['@nuxtjs/apollo'],  apollo: {    clients: {      default: {        httpEndpoint: '',        browserHttpEndpoint: '',        wsEndpoint: '',        httpLinkOptions: {},        wsLinkOptions: {},        wsEndpoint: '',        websocketsOnly: false,        connectToDevTools: false,        defaultOptions: {},        inMemoryCacheOptions: {},        tokenName: 'apollo:<client-name>.token',        tokenStorage: 'cookie',        authType: 'Bearer',        authHeader: 'Authorization'      },      other: './apollo/other.ts'    }  }})
apollo/other.ts
import { defineApolloClient } from '@nuxtjs/apollo/config'export default defineApolloClient({  httpEndpoint: '',  browserHttpEndpoint: '',  wsEndpoint: '',  httpLinkOptions: {},  wsLinkOptions: {},  wsEndpoint: '',  websocketsOnly: false,  connectToDevTools: false,  defaultOptions: {},  inMemoryCacheOptions: {},  tokenName: 'apollo:<client-name>.token',  tokenStorage: 'cookie',  authType: 'Bearer',  authHeader: 'Authorization'})

The GraphQL endpoint.

Provide a GraphQL endpoint to be used client-side. Overrides httpEndpoint.

Provide additional configuration for the HttpLink.

Provide additional configuration for the GraphQLWsLink.

Specify a websocket endpoint to be used for subscriptions. The wss protocol is recommended in production.

Specify if the client should solely use WebSocket. requires wsEndpoint.

Specify if the client should be able to connect to the Apollo Client Devtools in production mode.

Configure default options to be applied to the apollo client.

Additional configuration for the in-memory cache.

  • tokenName

    • Default: apollo:<client-name>.token"

Specify the name under which the token will be stored.

Specify if the auth token should be stored in cookie or localStorage. Cookie storage is required for SSR.

Specify the Authentication scheme.

Name of the Authentication token header.