nuxt-server-utils icon indicating copy to clipboard operation
nuxt-server-utils copied to clipboard

A collection of utilities for Nuxt server.

Nuxt Server Utils

🛠️ Nuxt Server Utils

npm version npm downloads License Nuxt Netlify Status

A collection of utility functions for Nuxt API development.

Features

Filtering Collections (Mongoose)
  • [x] Filtering
  • [x] Sorting
  • [x] Pagination
  • [x] Selecting
  • [x] Populating
  • [x] Counting
  • [x] Searching
Authorization
  • [x] Authority checker utility
  • [ ] Permission checker utility
  • [ ] Policy utility
Resource Helper
  • [x] Resource index utility
  • [x] Resource show utility
  • [x] Resource delete utility
  • [ ] Resource update utility
Validation
  • [x] Zod schema validator

Quick Setup

  1. Add nuxt-server-utils dependency to your project
# Using pnpm
pnpm add -D nuxt-server-utils

# Using yarn
yarn add --dev nuxt-server-utils

# Using npm
npm install --save-dev nuxt-server-utils
  1. Add nuxt-server-utils to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["nuxt-server-utils"],
});

That's it! You can now use Nuxt Server Utils in your Nuxt app ✨

Development

# 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