OpenVeo server API for plugins

API Docs for: 7.0.0
Show:

AdvancedEmitter

Extends EventEmitter
Module: emitters

Summary

Defines an AdvancedEmitter which wraps an EventEmitter.

An AdvancedEmitter works pretty much the same as the default Node.js EventEmitter excepts that it adds a new method to emit an AdvancedEvent to have the event's name as the first argument of the handler function.

It helps emit an event with the name of the event as the first argument.

var AdvancedEmitter = require('@openveo/api').emitters.AdvancedEmitter;
var AdvancedEvent = require('@openveo/api').emitters.AdvancedEvent;

var emitter = new AdvancedEmitter();
emitter.emitEvent(new AdvancedEvent('eventName', param1, param2, ...));

emitter.on('eventName', function(eventName, param1, param2, ...) {
  console.log(eventName); // Output "eventName"
});

Constructor

AdvancedEmitter

Syntax

AdvancedEmitter

()

Summary

Item Index

Methods

Methods

emitEvent

Syntax

emitEvent

(
  • event
)

Summary

Emits an AdvancedEvent by emitting its constructor's arguments.

Parameters: