npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nuxt-easy-typeorm

v1.1.2

Published

Easy TypeORM integration module for Nuxt

Downloads

490

Readme

Nuxt EasyTypeORM

npm version npm downloads License Nuxt

This Nuxt module is aimed for a seamless integration of TypeORM.

Installation

npx nuxi@latest module add nuxt-easy-typeorm

Configuration

In your Nuxt project, configure the module options inside nuxt.config.js:

export default defineNuxtConfig({
  modules: ['nuxt-easy-typeorm'],
  typeorm: {
    directory: 'my-typeorm-folder', // optional: defaults to 'typeorm' if not specified
  }
})

Setup

  1. Create the typeorm Directory: Inside the root of your project, create a typeorm directory (or the directory specified in your config). This is where you'll organize TypeORM-related files, such as entities and migrations.
  2. Organize with Subdirectories: To keep the folder organized, create subdirectories like entities for entity files and migrations for migration files.
  3. Define a Data Source: Create a file (e.g., useDatabase.ts) in the typeorm directory. Use the provided defineDataSource function to configure your TypeORM data source.
export const useDatabase = defineDataSource({
  type: 'sqlite',
  database: './typeorm/database.sqlite',
  entities: [],
  migrations: [],
  synchronize: true,
})

[!NOTE] You can add all entities and migrations here without additional imports.

Usage

After setting up, the data source will be auto-imported and ready for use in your Nitro routes. Here’s a simple example of using useDatabase to interact with an entity called User.

Example: Fetching Users

// server/api/user/list/index.get.ts
export default defineEventHandler(async (event) => {
  const database = await useDatabase()
  const UserRepository = database.getRepository(User)
  return UserRepository.find()
})

In this example, useDatabase() initializes the database connection and retrieves the repository for the User entity, allowing you to perform operations like .find().

Contribution

# 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