Obxecto obxecto incorporado

ObjectEventEmitter

Obxecto de activación de eventos, que se pode usar para establecer o modo de observador. Os obxectos que admiten o desencadeador de eventos herdanse deste. A mesma función do mesmo evento só xerará unha devolución de chamada

EventOs obxectos pódense crear de forma independente para formar sistemas de eventos personalizados:

1 2 3
var EventEmitter = require('events'); var e = new EventEmitter();

relación de herdanza

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<class>ChildProcess] [<class>DgramSocket] [<class>FSWatcher] [<class>LruCache] [<class>Service] [<class>StatsWatcher] [<class>WebSocket] [<class>WebView] [<class>Worker] [object] <:- [EventEmitter] [EventEmitter] <:- [ChildProcess] [EventEmitter] <:- [DgramSocket] [EventEmitter] <:- [FSWatcher] [EventEmitter] <:- [LruCache] [EventEmitter] <:- [Service] [EventEmitter] <:- [StatsWatcher] [EventEmitter] <:- [WebSocket] [EventEmitter] <:- [WebView] [EventEmitter] <:- [Worker] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object toString() toJSON() ChildProcess DgramSocket FSWatcher LruCache Service StatsWatcher WebSocket WebView Worker

Construtor

EventEmitter

Construtor

1
new EventEmitter();

obxecto

obxecto de activación de eventos

1
EventEmitter new EventEmitter;

propiedades estáticas

defaultMaxListeners

Enteiro, o número máximo global predeterminado de oíntes

1
static Integer EventEmitter.defaultMaxListeners;

función de membro

on

Vincular un controlador de eventos a un obxecto

1 2
Object EventEmitter.on(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Vincular un controlador de eventos a un obxecto

1
Object 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 utilizarase como nome do evento e o valor da propiedade como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

addListener

Vincular un controlador de eventos a un obxecto

1 2
Object EventEmitter.addListener(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Vincular un controlador de eventos a un obxecto

1
Object 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 utilizarase como nome do evento e o valor da propiedade como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

prependListener

Vincular un controlador de eventos ao inicio do obxecto

1 2
Object EventEmitter.prependListener(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Vincular un controlador de eventos ao inicio do obxecto

1
Object 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 utilizarase como nome do evento e o valor da propiedade como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

once

Vincula un controlador de eventos único ao obxecto, o manejador único activarase unha vez

1 2
Object EventEmitter.once(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Vincula un controlador de eventos único ao obxecto, o manejador único activarase unha vez

1
Object 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 utilizarase como nome do evento e o valor da propiedade como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

prependOnceListener

Vincular un controlador de eventos ao inicio do obxecto

1 2
Object EventEmitter.prependOnceListener(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Vincular un controlador de eventos ao inicio do obxecto

1
Object 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 utilizarase como nome do evento e o valor da propiedade como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

off

cancele a función especificada da cola de procesamento de obxectos

1 2
Object EventEmitter.off(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Cancela todas as funcións da cola de procesamento de obxectos

1
Object EventEmitter.off(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

cancele a función especificada da cola de procesamento de obxectos

1
Object EventEmitter.off(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome da propiedade do obxecto utilízase como nome do evento e o valor da propiedade úsase como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

removeListener

cancele a función especificada da cola de procesamento de obxectos

1 2
Object EventEmitter.removeListener(String ev, Function func);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función do controlador de eventos

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Cancela todas as funcións da cola de procesamento de obxectos

1
Object EventEmitter.removeListener(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

cancele a función especificada da cola de procesamento de obxectos

1
Object EventEmitter.removeListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome da propiedade do obxecto utilízase como nome do evento e o valor da propiedade úsase como función do controlador de eventos.

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

removeAllListeners

Cancela todos os oíntes para todos os eventos da cola de procesamento do obxecto ou, se se especifica un evento, elimina todos os oíntes para o evento especificado.

1
Object EventEmitter.removeAllListeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

Cancela todos os oíntes para todos os eventos da cola de procesamento do obxecto ou, se se especifica un evento, elimina todos os oíntes para o evento especificado.

1
Object EventEmitter.removeAllListeners(Array evs = []);

Parámetros de chamada:

  • evs: Matriz, especificando o nome do evento

Devolver resultado:

  • Object, devolve o propio obxecto do evento para facilitar o encadeamento

setMaxListeners

O límite predeterminado no número de oíntes, só para compatibilidade

1
EventEmitter.setMaxListeners(Integer n);

Parámetros de chamada:

  • n: Número enteiro, especifica o número de eventos

getMaxListeners

Obtén o número de límites predeterminados para os oíntes, só para compatibilidade

1
Integer EventEmitter.getMaxListeners();

Devolver resultado:

  • Integer, devolve o número límite predeterminado

listeners

Consulta a matriz de oíntes para o evento especificado do obxecto

1
Array EventEmitter.listeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • 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

1
Integer EventEmitter.listenerCount(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • 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 2
Integer EventEmitter.listenerCount(Value o, String ev);

Parámetros de chamada:

  • o: Valor, especifica o obxecto da consulta
  • ev: Cadea, especifica o nome do evento

Devolver resultado:

  • Integer, devolve o número de oíntes para o evento especificado

eventNames

Consulta o nome do evento do oínte

1
Array EventEmitter.eventNames();

Devolver resultado:

  • Array, devolve unha matriz de nomes de eventos

emit

Activa un evento de forma activa

1 2
Boolean EventEmitter.emit(String ev, ...args);

Parámetros de chamada:

  • ev: Cadea, nome do evento
  • args: ..., parámetros de eventos, que se pasarán ao controlador de eventos

Devolver resultado:

  • Boolean, devolve o estado de activación do evento, devolve verdadeiro se hai un evento de resposta, se non, devolve falso

toString

Devolve a representación en cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode ser reimplementado segundo as súas propias características

1
String EventEmitter.toString();

Devolver resultado:

  • String, devolve a representación en cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve o conxunto de propiedades lexibles definidas polo obxecto

1
Value EventEmitter.toJSON(String key = "");

Parámetros de chamada:

  • key: Corda, sen usar

Devolver resultado:

  • Value, devolve un valor que contén JSON serializable