Skip to content

Repository files navigation

nestjs-database-trigger

NPM

npm versionnpmCircleCICoverage Status

All Contributors

Description

This is a SQL (currently support only PostgreSQL) database trigger module for NestJS which allow you to use decorators on SQL triggers.

Installation

$ npm install nestjs-database-trigger --save

Example

app.module.ts

import{TriggerModule}from"nestjs-database-trigger";TriggerModule.forRootAsync({imports: [UtilsModule],inject: [UtilsService],useFactory: async(utilsService: UtilsService)=>({connectionString: databaseUrl,tables: ["Notification"],}),});

notification.service.ts

import{onTrigger}from"nestjs-database-trigger";
@Injectable()exportclassNotificationService{constructor(){}
@OnTrigger("Notification")asyncprintout(payload: MessagePayload){console.log(payload);}}

Payload interface

interfaceMessagePayload<T=any>{table: string;action: "INSERT"|"UPDATE"|"DELETE";data: T|null;oldData: T|null;}

Roadmap

We plan to support other SQL database in the future.

License

nestjs-database-trigger is MIT licensed.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


kahoowkh

📖⚠️💻

Marco Tse

📖⚠️💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A SQL database trigger module for NestJS

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages