node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

moleculer-decorators

Moleculer logo

npm npm GitHub issues GitHub license

Moleculer Decorators

Decorators for moleculer

Available options

constructOverride: false // True by default, This will override any properties defined in @Service if defined in the constructor as well.

These are defined in @Service

Example usage

const moleculer = require('moleculer');
const { Service, Action, Event, Method, BaseSchema } = require('moleculer-decorators');
const web = require('moleculer-web');
const broker = new moleculer.ServiceBroker({
  logger: console,
  logLevel: "debug",
});
 
@Service({
  mixins: [web],
  settings: {
    port: 3000,
    routes: [
      ...
    ]
  }
})
class ServiceName extends BaseSchema {
 
  // Optional constructor
  constructor() {
    this.settings = { // Overrides above by default, to prevent this, add "constructOverride: false" to @Service
      port: 3001
    }
  }
 
  // Without constructor (typescript)
  settings = {
    port: 3001
  }
 
  @Action()
  Login(ctx) {
    ...
  }
 
  // With options
  @Action({
    cache: false,
    params: {
      a: "number",
      b: "number"
    }
  })
  Login2(ctx) {
    ...
  }
 
  @Event
  'event.name'(payload, sender, eventName) {
    ...
  }
 
  @Method
  authorize(ctx, route, req, res) {
    ...
  }
 
  started() { // Reserved for moleculer, fired when started
    ...
  }
 
  created() { // Reserved for moleculer, fired when created
    ...
  }
 
  stopped() { // Reserved for moleculer, fired when stopped
    ...
  }
}
 
broker.createService(ServiceName);
broker.start();

Usage with moleculer-runner

Simply export the service instead of starting a broker manually.

  export default class ServiceName 

License

Moleculer Decorators is available under the MIT license.