Apollo Nuxt Module

This module integrates Apollo GraphQL for Vue with Nuxt 3.

Please note

Since @vue/apollo-composable is still in alpha and this module depends on it, caution is advised, since future changes may occur that break the functionality or compatibility of this module.

Features

• Creation and injection of an Apollo GraphQL client into a Nuxt 3 app
• Functional on server- and client-side
• Enables use of @vue/apollo-composable

Current Limitations

• Only configuration is the uri of the GraphQL endpoint
• Due to @vue/apollo-composable being in alpha, breaking changes may occur in the future

Installation

The module can be installed by running the following command:

1npm i @hrwg/apollo-nuxt

It is activated and configured, by adding it to the nuxt.config.ts.

1import { defineNuxtConfig } from 'nuxt';
2
3export default defineNuxtConfig({
4    modules: [
5        '@hrwg/apollo-nuxt',
6    ],
7    apolloNuxt: {
8        uri: 'http://localhost:3000/api/graphql',
9    },
10});

The configuration parameter uri is the GraphQL endpoint.

Usage

After installation, GraphQL queries can be executed according to the Vue Apollo Documentation.

For a simple example, refer to the Playground Project.

Development

• Run npm i to install dependencies.
• Run npm run dev:prepare to generate type stubs.
• Use npm run dev to start playground in development mode.

Changelog

This project adheres to Semantic Versioning. Please refer to the CHANGELOG.md for detailed changes and migration instructions.

License

MIT