Object EventEmitter
O obxecto desencadeado por sucesos, que se pode usar para establecer o modo de observador, todos os obxectos que admiten o desencadeamento de sucesos herdan deste e a mesma función do mesmo suceso só xerará unha devolución de chamada.
Event Os obxectos pódense crear de forma independente para formar un sistema de eventos personalizado:
1
2
3var EventEmitter = require('events');
var e = new EventEmitter();
Herdanza
Construtor
EventEmitter
Construtor
1new EventEmitter();
Obxecto
Obxecto disparador de sucesos
1EventEmitter new EventEmitter;
Propiedades estáticas
defaultMaxListeners
Entero, o número máximo predeterminado global de oíntes
1static Integer EventEmitter.defaultMaxListeners;
Función de membro
on
Vincula un controlador de eventos ao obxecto
1
2Object EventEmitter.on(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Vincula un controlador de eventos ao obxecto
1Object EventEmitter.on(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
addListener
Vincula un controlador de eventos ao obxecto
1
2Object EventEmitter.addListener(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Vincula un controlador de eventos ao obxecto
1Object EventEmitter.addListener(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
prependListener
Vincula un controlador de eventos ao comezo do obxecto
1
2Object EventEmitter.prependListener(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Vincula un controlador de eventos ao comezo do obxecto
1Object EventEmitter.prependListener(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
once
Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez
1
2Object EventEmitter.once(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez
1Object EventEmitter.once(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
prependOnceListener
Vincula un controlador de eventos ao comezo do obxecto
1
2Object EventEmitter.prependOnceListener(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Vincula un controlador de eventos ao comezo do obxecto
1Object EventEmitter.prependOnceListener(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
off
Cancelar a función especificada desde a cola de procesamento de obxectos
1
2Object EventEmitter.off(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Cancelar todas as funcións da cola de procesamento de obxectos
1Object EventEmitter.off(String ev);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Cancelar a función especificada desde a cola de procesamento de obxectos
1Object EventEmitter.off(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
removeListener
Cancelar a función especificada desde a cola de procesamento de obxectos
1
2Object EventEmitter.removeListener(String ev,
Function func);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
- func: Función, especifica a función de procesamento de eventos
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Cancelar todas as funcións da cola de procesamento de obxectos
1Object EventEmitter.removeListener(String ev);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Cancelar a función especificada desde a cola de procesamento de obxectos
1Object EventEmitter.removeListener(Object map);
Parámetros de chamada:
- map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
removeAllListeners
Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.
1Object EventEmitter.removeAllListeners(String ev);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.
1Object EventEmitter.removeAllListeners(Array evs = []);
Parámetros de chamada:
- evs: Matriz, especifica o nome do evento
Resultado de volta:
- Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea
setMaxListeners
O límite predeterminado do número de oíntes, só para compatibilidade
1EventEmitter.setMaxListeners(Integer n);
Parámetros de chamada:
- n: Enteiro, especifique o número de eventos
getMaxListeners
Obtén o límite predeterminado do número de oíntes, só por compatibilidade
1Integer EventEmitter.getMaxListeners();
Resultado de volta:
- Integer, Volver ao número límite predeterminado
listeners
Matriz de oíntes para o evento especificado do obxecto de consulta
1Array EventEmitter.listeners(String ev);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Array, Devolve unha matriz de oíntes para o evento especificado
listenerCount
O número de oíntes para o evento especificado do obxecto de consulta
1Integer EventEmitter.listenerCount(String ev);
Parámetros de chamada:
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Integer, Devolve o número de oíntes para o evento especificado
O número de oíntes para o evento especificado do obxecto de consulta
1
2Integer EventEmitter.listenerCount(Value o,
String ev);
Parámetros de chamada:
- o: Valor, especifica o obxecto da consulta
- ev: Cadea, especifica o nome do evento
Resultado de volta:
- Integer, Devolve o número de oíntes para o evento especificado
eventNames
Consulta o nome do evento do oínte
1Array EventEmitter.eventNames();
Resultado de volta:
- Array, Devolve unha matriz de nomes de eventos
emit
Desencadea un evento activamente
1
2Boolean EventEmitter.emit(String ev,
...args);
Parámetros de chamada:
- ev: Cadea, nome do evento
- args: ..., parámetros do evento, que se pasarán ao controlador de eventos
Resultado de volta:
- Boolean, Volver ao estado de activación do evento, devolver verdadeiro se hai un evento de resposta, en caso contrario devolver falso
toString
Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características
1String EventEmitter.toString();
Resultado de volta:
- String, Devolve a representación de cadea do obxecto
toJSON
Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto
1Value EventEmitter.toJSON(String key = "");
Parámetros de chamada:
- key: Cadea, sen usar
Resultado de volta:
- Value, Devolve un valor que contén JSON serializable