README.md

fastify-typeorm

Fastify plugin for TypeORM for sharing the same TypeORM connection in every part of your server. Under the hood the official TypeORM module is used.

Install

npm install fastify-typeorm-plugin

Usage

Add it to your project with register and you are done! The plugin accepts the same connection options as the TypeORM client.

const fastify = require('fastify')();

const user = require('./entity/user');

fastify.register(require('fastify-typeorm-plugin'), {
  type: 'sqlite',
  database: './mydb.sql',
});

fastify.get('/users', async function(req, reply) {
  const users = await this.orm
    .getRepository(User)
    .createQueryBuilder('user')
    .getMany();

  return users;
});

fastify.listen(3000, err => {
  if (err) throw err;
});

If you won't pass config, it will use typeorm default createConnection mechanism:

const fastify = require('fastify')();

const user = require('./entity/user');

fastify.register(require('fastify-typeorm-plugin'));

fastify.get('/users', async function(req, reply) {
  const users = await this.orm
    .getRepository(User)
    .createQueryBuilder('user')
    .getMany();

  return users;
});

fastify.listen(3000, err => {
  if (err) throw err;
});

You can also pass in an existing connection:

const { createConnection } = require('typeorm');

const fastify = require('fastify')();
const connection = await createConnection({
  type: 'sqlite',
  database: './mydb.sql',
});
fastify.register(require('fastify-typeorm-plugin'), {
  connection,
});

Team

• Glenn Bostoen https://github.com/gboston https://twitter.com/gbostoen
• Jonas Goderis https://github.com/jonasgoderis https://twitter.com/JonasGoderis

License

Licensed under MIT.