Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 3.9 KB

README.md

File metadata and controls

117 lines (83 loc) · 3.9 KB
Raw

Nuxt MikroORM module

Nuxt module for easy integration with MikroORM into your Nuxt application.

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add nuxt-mikro-orm-module

After that, ideally in a Nitro plugin, call registerGlobalOrm() with the instance's config.

Example:

// server/plugins/db.ts
import { defineConfig, type MikroORM } from "@mikro-orm/mysql";

export default defineNitroPlugin(async (nitro) => {
  const orm = await registerGlobalOrm<MikroORM>(nitro, defineConfig({
    host: '127.0.0.1',
    user: 'root',
    password: '',
    dbName: 'test',
    port: 3306,
  }));

  // any additional checks on the DB you may want to do on startup

});

Call useEntityManager() in a request context or in an island component to get a forked EntityManager you can immediately use.

If you are working in a different context, such as a Nitro task, you may call useOrm(), and manually call fork() to get a locally scoped EntityManager.

Module options / Runtime options

This module's options are used as defaults for runtime options, under the mikroOrm key.

See ModuleOptions for details.

Per route auto forking

By default, when using registerGlobalOrm(), all requests get a fork of the instance, which is what you will want in most cases.

You may turn off this auto fork for some routes if you set in your Nuxt config the autoForking option to middleware, and then add mikroOrm: false to the routes you want to disable auto forking on.

e.g.

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-mikro-orm-module'],
  routeRules: {
    '/about': { mikroOrm: false },
  },
  mikroOrm: {
    autoForking: 'middleware',
  },
  devtools: {
    enabled: true,
  },
});

API

Have a look at the typedoc generated docs for the full feature set.

In addition to the previously mentioned functions and options, if even more fine-grained control over the MikroORM instance is needed, you can also use initOrm() to init a MikroORM instance, without making it auto forked for requests. You will need to call useEntityManager() in a request context at the routes you want to enable the instance at. You should also call closeOrm() when you are done with the instance, be it at a Nitro close hook, or some other time at which you know the connection needs to be closed.

Contribution

Local development 
# Install dependencies
yarn install

# Generate type stubs
yarn run dev:prepare

# Start docker container, to host the sample database
docker compose up -d

# Develop with the playground
yarn run dev

# Build the playground
yarn run dev:build

# Run ESLint
yarn run lint

# Run Vitest
yarn run test
yarn run test:watch

# Release new version
yarn run release