[null,{"_path":"/getting-started/configuration","_draft":false,"_partial":false,"_empty":false,"title":"Configuration","description":"Configure Nuxt Apollo via the `apollo` property.","excerpt":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"defaults"},"children":[{"type":"text","value":"Defaults"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/apollo'],\n\n  apollo: {\n    autoImports: true,\n    authType: 'Bearer',\n    authHeader: 'Authorization',\n    tokenStorage: 'cookie',\n    proxyCookies: true,\n    clients: {}\n  }\n})\n","filename":"nuxt.config.ts","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/apollo'],\n\n  apollo: {\n    autoImports: true,\n    authType: 'Bearer',\n    authHeader: 'Authorization',\n    tokenStorage: 'cookie',\n    proxyCookies: true,\n    clients: {}\n  }\n})\n"}]}]}]},{"type":"element","tag":"h2","props":{"id":"autoimports"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"autoImports"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"true"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Determine if vue-apollo composables should be automatically imported and accessible within your nuxt app."}]},{"type":"element","tag":"h2","props":{"id":"authtype"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"authType"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Bearer"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify the Authentication scheme."}]},{"type":"element","tag":"h2","props":{"id":"authheader"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"authHeader"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Authorization"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Name of the Authentication token header."}]},{"type":"element","tag":"h2","props":{"id":"tokenstorage"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"tokenStorage"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cookie"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify if the auth token should be stored in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cookie"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"localStorage"}]},{"type":"text","value":". "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Cookie"}]},{"type":"text","value":" storage is required for SSR."}]},{"type":"element","tag":"h2","props":{"id":"proxycookies"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"proxyCookies"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"true"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify if client cookies should be proxied to the server."}]},{"type":"element","tag":"h2","props":{"id":"clients"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"clients"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure your Apollo Client instances."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/apollo'],\n\n  apollo: {\n    clients: {\n      default: {\n        httpEndpoint: '',\n        browserHttpEndpoint: '',\n        wsEndpoint: '',\n        httpLinkOptions: {},\n        wsLinkOptions: {},\n        wsEndpoint: '',\n        websocketsOnly: false,\n        connectToDevTools: false,\n        defaultOptions: {},\n        inMemoryCacheOptions: {},\n        tokenName: 'apollo:<client-name>.token',\n        tokenStorage: 'cookie',\n        authType: 'Bearer',\n        authHeader: 'Authorization'\n      },\n      other: './apollo/other.ts'\n    }\n  }\n})\n","filename":"nuxt.config.ts","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/apollo'],\n\n  apollo: {\n    clients: {\n      default: {\n        httpEndpoint: '',\n        browserHttpEndpoint: '',\n        wsEndpoint: '',\n        httpLinkOptions: {},\n        wsLinkOptions: {},\n        wsEndpoint: '',\n        websocketsOnly: false,\n        connectToDevTools: false,\n        defaultOptions: {},\n        inMemoryCacheOptions: {},\n        tokenName: 'apollo:<client-name>.token',\n        tokenStorage: 'cookie',\n        authType: 'Bearer',\n        authHeader: 'Authorization'\n      },\n      other: './apollo/other.ts'\n    }\n  }\n})\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"import { defineApolloClient } from '@nuxtjs/apollo'\n\nexport default defineApolloClient({\n  httpEndpoint: '',\n  browserHttpEndpoint: '',\n  wsEndpoint: '',\n  httpLinkOptions: {},\n  wsLinkOptions: {},\n  wsEndpoint: '',\n  websocketsOnly: false,\n  connectToDevTools: false,\n  defaultOptions: {},\n  inMemoryCacheOptions: {},\n  tokenName: 'apollo:<client-name>.token',\n  tokenStorage: 'cookie',\n  authType: 'Bearer',\n  authHeader: 'Authorization'\n})\n","filename":"apollo/other.ts","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"import { defineApolloClient } from '@nuxtjs/apollo'\n\nexport default defineApolloClient({\n  httpEndpoint: '',\n  browserHttpEndpoint: '',\n  wsEndpoint: '',\n  httpLinkOptions: {},\n  wsLinkOptions: {},\n  wsEndpoint: '',\n  websocketsOnly: false,\n  connectToDevTools: false,\n  defaultOptions: {},\n  inMemoryCacheOptions: {},\n  tokenName: 'apollo:<client-name>.token',\n  tokenStorage: 'cookie',\n  authType: 'Bearer',\n  authHeader: 'Authorization'\n})\n"}]}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"httpendpoint"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"httpEndpoint"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The GraphQL endpoint."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"browserhttpendpoint"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"browserHttpEndpoint"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Provide a GraphQL endpoint to be used client-side. Overrides "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"httpEndpoint"}]},{"type":"text","value":"."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"httplinkoptions"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"httpLinkOptions"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Provide additional configuration for the "},{"type":"element","tag":"a","props":{"href":"https://www.apollographql.com/docs/link/links/http.html#options","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"HttpLink"}]},{"type":"text","value":"."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"wslinkoptions"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"wsLinkOptions"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Provide additional configuration for the "},{"type":"element","tag":"a","props":{"href":"https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/client.ClientOptions.md","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"GraphQLWsLink"}]}]},{"type":"text","value":"."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"wsendpoint"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"wsEndpoint"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify a websocket endpoint to be used for subscriptions. The "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"wss"}]},{"type":"text","value":" protocol is recommended in production."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"websocketsonly"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"websocketsOnly"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify if the client should solely use WebSocket. requires "},{"type":"element","tag":"a","props":{"href":"#wsendpoint"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"wsEndpoint"}]}]},{"type":"text","value":"."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"connecttodevtools"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"connectToDevTools"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"true"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify if the client should be able to connect to the Apollo Client Devtools in production mode."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"defaultoptions"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"defaultOptions"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configure default options to be applied to the apollo client."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"inmemorycacheoptions"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"inMemoryCacheOptions"}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Additional configuration for the in-memory cache."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"tokenname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"tokenName"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apollo:<client-name>.token\""}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify the name under which the token will be stored."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"tokenstorage-1"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"tokenStorage"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cookie"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify if the auth token should be stored in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cookie"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"localStorage"}]},{"type":"text","value":". "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Cookie"}]},{"type":"text","value":" storage is required for SSR."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"authtype-1"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"authType"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Bearer"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Specify the Authentication scheme."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"h3","props":{"id":"authheader-1"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"authHeader"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"Authorization"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Name of the Authentication token header."}]}]},"_type":"markdown","_id":"content:1.getting-started:2.configuration.md","_source":"content","_file":"1.getting-started/2.configuration.md","_extension":"md"}]