Socket
Socket
Sign inDemoInstall

nuxt-typed-router

Package Overview
Dependencies
153
Maintainers
1
Versions
209
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    nuxt-typed-router

Provide autocompletion for routes paths, names and params in Nuxt apps


Version published
Weekly downloads
9.8K
increased by14.93%
Maintainers
1
Install size
49.5 MB
Created
Weekly downloads
 

Readme

Source

nuxt-typed-router cover

npm version npm downloads npm downloads

Provide a type safe router to Nuxt

  • Supports all programmatic navigation utils (NuxtLink, useRouter, navigateTo, useRoute, useLocalePath, etc...)
  • Supports optional params and catchAll routes
  • Autocompletes routes paths, names and params
  • Throw error if route path is invalid
  • Out of the box i18n support
  • Supports routes extended by config and modules



Documentation

Documentation

Play with it

Open in StackBlitz

Demo repo 🧪 : nuxt-typed-router-demo

Cool video about it from LearnVue!

Watch the video


Compatibility:

  • Nuxt 3

Quick start

For Nuxt 3

npx nuxi@latest module add typed-router

Configuration

Register the module in the nuxt.config.ts, done!

export default defineNuxtConfig({
  modules: ['nuxt-typed-router'],
});

Development

  1. Clone this repository
  2. Install dependencies using pnpm
  3. Build project for local tests pnpm run test
  4. Start dev playground pnpm run prepack && pnpm run dev
  5. Build project for deploy pnpm prepack

📑 License

MIT License

Keywords

FAQs

Last updated on 17 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc