1.0.8 • Published 1 year ago

nats-section v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

Description

Nest framework TypeScript starter repository With nats creating to add section or tags

Installation

$ npm i nats-section

ADD to Imports app.module.ts

import { SectionsModule } from 'nats-section';
@Module({
  imports: [SectionsModule.forRoot(process.env.ElasticServer,process.env.NatsServerDB)],
  ...
})
export class AppModule {}

ADD .env file

NatsServerDB="nats://localhost:4222"
ElasticServer='http://0.0.0.0:9200'

To Use API ${BaseURL}/section

To create new section or tags

  • Method : POST
  • URL : /new
  • Request Body : { key : string, value : string }

    To delete specific key 'change status of key in nats to delete'

  • Method : DELETE

  • URL : /
  • params : { key : string, }

    To force delete specific key

  • Method : DELETE

  • URL : /force
  • params : { key : string, }

    To get specific key

  • Method : GET

  • URL : /
  • params : { key : string, }

    To get version of specific key

  • Method : GET

  • URL : /version
  • params : { key : string, version : number }

    To get all keys

  • Method : GET

  • URL : /all

  • To get historic of specific key

  • Method : GET
  • URL : /historic
  • params : { key : string, }

To Use section in relation by installing a generate-nats-service package

  • will generate a relationColumn Folder, In relationColumn.enum.ts and add the following code to
export enum RelationColumn{
    column_id = "column_id",
 ## Modify  [section_name] = ["section_name"] to the new key your's added 
}
  • will generate a event Folder, In service.event.ts and add the following code to
import { SectionsService } from 'nats-section';

export class EntityEvent extends ServiceBaseEvent {
    constructor(
        @Inject('EVENT_SERVICE') public readonly eventEmitter: ClientNats,
        public readonly logFactory:LogFactory,
        private readonly entityFactory:EntityFactory,
        private readonly sectionsService:SectionsService
        ){
        super(eventEmitter,logFactory);
    }
    ...
    ...
    ...
    ...
    ...