https://github.com/marianozunino/nestely

Nestely is a NestJs module that integrates Kysely into your NestJs application.
https://github.com/marianozunino/nestely

kysely nestjs nodejs query-builder

Last synced: about 6 hours ago
JSON representation

Nestely is a NestJs module that integrates Kysely into your NestJs application.

• Host: GitHub
• URL: https://github.com/marianozunino/nestely
• Owner: marianozunino
• License: mit
• Created: 2023-07-18T16:52:33.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-18T17:31:09.000Z (over 1 year ago)
• Last Synced: 2024-11-16T15:38:46.133Z (2 months ago)
• Topics: kysely, nestjs, nodejs, query-builder
• Language: TypeScript
• Homepage:
• Size: 202 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build-deploy](https://github.com/marianozunino/nestely/actions/workflows/release.yaml/badge.svg)](https://github.com/marianozunino/nestely/actions/workflows/release.yaml)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

[![Coverage Status](https://coveralls.io/repos/github/marianozunino/nestely/badge.svg)](https://coveralls.io/github/marianozunino/nestely)

![npm type definitions](https://img.shields.io/npm/types/nestely)

[![current-version](https://img.shields.io/badge/dynamic/json?label=current-version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fmarianozunino%2Fnestely%2Fmaster%2Fpackage.json)](https://npmjs.com/package/nestely)



### Table of Contents

- [Nestely](#nestely)

  + [About](#about)

- [Installation](#installation)

- [NestJs Configuration ](#nestjs-configuration--a-href--http---nestjscom---target--blank---img-src--https---nestjscom-img-logo-smallsvg--width--25--alt--nest-logo------a-)

  + [Using the Kysely instance](#using-the-kysely-instance)

Table of contents generated with markdown-toc

# Nestely

### About

Nestely is a NestJs module that integrates [Kysely](kysely.dev/) into your [NestJs](https://nestjs.com) application.

> What else does this module do?

Nothing else really. It just provides a way to inject the Kysely instance into your services/controllers/repositories.

I created this module just to avoid the same boilerplate code in every NestJs project I create.

This project has been tested with

> - Kysely 0.24

> - SQLite3

# Installation

Install the latest version of Nestely using npm:

```sh

npm install nestely

```

# NestJs Configuration 

In order to configure the module with your [NestJs](https://nestjs.com) application, you need to import the `NestelyModule` into your `AppModule` (or any other module).

```ts

import { Module } from '@nestjs/common';

import { NestelyModule } from 'nestely';

@Module({

  imports: [

    NestelyModule.register({

      plugins: [new CamelCasePlugin()],

      dialect: new SqliteDialect({

        database: new SQLite(':memory:'),

      }),

      isGlobal: true,

    }),

    // Asynchronous configuration

    NestelyModule.registerAsync({

      useFactory: () => ({

        dialect: new SqliteDialect({

          database: new SQLite(':memory:'),

        }),

        plugins: [new CamelCasePlugin()],

      }),

      isGlobal: false, // default is true

    }),

  ],

})

export class AppModule {}

```

#### Using the Kysely instance

Once the module is configured, you can inject the `Kysely` instance into your services/controllers/repositories using the `@InjectKysely()` decorator.

```ts

import { Injectable } from '@nestjs/common';

import { InjectKysely, Kysely } from 'nestely';

import { DB } from './db.interface';

@Injectable()

export class AppService {

  // provide the DB interface

  constructor(@InjectKysely() private readonly kysely: Kysely) {}

  async findAll(): Promise {

    const result = await sql`select 1+1 as result`.execute(this.kysely);

    console.log(result); // { rows: [ { result: 2 } ] }

  }

}

```