common-nest-plena v3.0.1

Description

common-nest-framework for common functionality access the projects. Includes NATS

Usage

1. Install the library

npm install common-nest-plena

2. In app.module.ts or cron.module.ts (which ever is app factory) add below config.

import { CommonModule } from 'common-nest-plena';

const options = {
  enabled: true,
  url: process.env.NATS_URL,
  healthCheckUrl: '/project-name/health',
};

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
    CommonModule.forRoot(options),
    // OtherModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

3. Inject NatsService as a service in Class constructor

import { NatsService } from 'common-nest-plena';

constructor(private nc: NatsService) {}

Test

# unit tests
npm run test

Other re-usable components

1. NatsService

2. Response object to handle API reponses structure