@gqfn/nuxt

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

The Nuxt binding for @gqfn/core.

- 📖  Documentation

Features

- 🔒  Write queries with type safety and type hints.
- 🚀  No need to scan your source code, no code generation during HMR.
- ❤️  The experience of using gqfn is very similar to writing plain GraphQL queries.
- 🌐  Working for most clients with TypedDocumentNode.

Quick Setup

1. Add @gqfn/nuxt dependency to your project

``bash


✨ Auto-detect

npx nypm install @gqfn/nuxt

Using npm

npm install @gqfn/nuxt

Using yarn

yarn add @gqfn/nuxt

Using pnpm

pnpm add @gqfn/nuxt

Using bun

bun install @gqfn/nuxt
`

2. Add @gqfn/nuxt to the modules section of nuxt.config.ts, and configure it:

`ts
export default defineNuxtConfig({
modules: [
'@gqfn/nuxt'
],

gqfn: {
clients: [
'https://your-graphql-endpoint',
],
},
})
`




Contribution

Local development

`bash
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release
``

[npm-version-src]: https://img.shields.io/npm/v/@gqfn/nuxt/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/@gqfn/nuxt

[npm-downloads-src]: https://img.shields.io/npm/dm/@gqfn/nuxt.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/@gqfn/nuxt

[license-src]: https://img.shields.io/npm/l/@gqfn/nuxt.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/@gqfn/nuxt

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com