Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 2.66 KB

README.md

File metadata and controls

114 lines (83 loc) · 2.66 KB
Raw

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)
  • Filtering
  • Sorting
  • Pagination
  • Selecting
  • Populating
  • Counting
  • Searching
Authorization
  • Authority checker utility
  • Permission checker utility
  • Policy utility
Resource Helper
  • Resource index utility
  • Resource show utility
  • Resource delete utility
  • Resource update utility
Validation
  • 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