Объект встроенный объект

Объект EventEmitter

Объект триггера события, который можно использовать для установки режима наблюдателя. Объекты, поддерживающие триггер события, наследуются от него. Одна и та же функция того же события будет генерировать только обратный вызов.

Объекты Event могут быть созданы независимо для создания пользовательских систем событий:

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

наследование

конструктор

EventEmitter

конструктор

1
new EventEmitter();

Статическое свойство

defaultMaxListeners

Integer, глобальное максимальное число слушателей по умолчанию

1
static Integer EventEmitter.defaultMaxListeners;

Функция-член

on

Привязать обработчик событий к объекту

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к объекту

1
Object EventEmitter.on(Object map);

Параметры звонка:

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

addListener

Привязать обработчик событий к объекту

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Привязать обработчик событий к объекту

1
Object EventEmitter.addListener(Object map);

Параметры звонка:

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

prependListener

Привязать обработчик событий к началу объекта

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к началу объекта

1
Object EventEmitter.prependListener(Object map);

Параметры звонка:

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

Возвращает результат:

  • Object , возвращает количество успешных привязок или 0, если функция связана

once

Привязать одноразовый обработчик событий к объекту. Одноразовый обработчик будет срабатывать только один раз.

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Привязать одноразовый обработчик событий к объекту. Одноразовый обработчик будет срабатывать только один раз.

1
Object EventEmitter.once(Object map);

Параметры звонка:

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

prependOnceListener

Привязать обработчик событий к началу объекта

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает количество успешных привязок или 0, если функция связана

Привязать обработчик событий к началу объекта

1
Object EventEmitter.prependOnceListener(Object map);

Параметры звонка:

  • map : Object, указывает отношение отображения события, имя свойства объекта будет использоваться в качестве имени события, а значение свойства будет использоваться в качестве обработчика события

Возвращает результат:

  • Object , возвращает количество успешных привязок или 0, если функция связана

off

Неуказанная функция из очереди обработки объекта

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Отмена всех функций в очереди обработки объекта

1
Object EventEmitter.off(String ev);

Параметры звонка:

  • ev : String, имя указанного события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Неуказанная функция из очереди обработки объекта

1
Object EventEmitter.off(Object map);

Параметры звонка:

  • map : Object, определяет отношение отображения событий, имя свойства объекта используется в качестве имени события, а значение свойства используется в качестве функции обработки события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

removeListener

Неуказанная функция из очереди обработки объекта

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

Параметры звонка:

  • ev : String, имя указанного события
  • func : Функция, указать функцию обработчика события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Отмена всех функций в очереди обработки объекта

1
Object EventEmitter.removeListener(String ev);

Параметры звонка:

  • ev : String, имя указанного события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

Неуказанная функция из очереди обработки объекта

1
Object EventEmitter.removeListener(Object map);

Параметры звонка:

  • map : Object, определяет отношение отображения событий, имя свойства объекта используется в качестве имени события, а значение свойства используется в качестве функции обработки события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

removeAllListeners

Отмените все прослушиватели для всех событий из очереди обработки объекта. Если событие указано, удалите все прослушиватели для указанного события.

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

Параметры звонка:

  • evs : Array, укажите название события

Возвращает результат:

  • Object , возвращает сам объект события, что удобно для цепных вызовов

setMaxListeners

Количество слушателей по умолчанию, только для совместимости

1
EventEmitter.setMaxListeners(Integer n);

Параметры звонка:

  • n : целое число, количество указанных событий

getMaxListeners

Получить предельное количество слушателей по умолчанию, только для совместимости

1
Integer EventEmitter.getMaxListeners();

Возвращает результат:

  • Integer , возвращает номер лимита по умолчанию

listeners

Массив слушателя для указанного события объекта запроса

1
Array EventEmitter.listeners(String ev);

Параметры звонка:

  • ev : String, имя указанного события

Возвращает результат:

  • Array , возвращает массив слушателей для указанного события

listenerCount

Запрос количества слушателей для указанного события

1
Integer EventEmitter.listenerCount(String ev);

Параметры звонка:

  • ev : String, имя указанного события

Возвращает результат:

  • Integer , возвращает количество слушателей для указанного события

eventNames

Запрос имени слушателя события

1
Array EventEmitter.eventNames();

Возвращает результат:

  • Array , возвращает массив имен событий

emit

Активно вызвать событие

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

Параметры звонка:

  • ev : Строка, название события
  • args : ..., параметры события будут переданы в обработчик события

Возвращает результат:

  • Boolean , вернуть статус триггера события, вернуть true, если есть событие ответа, в противном случае вернуть false

toString

Возвращает строковое представление объекта, обычно «[Native Object]». Объекты могут быть переопределены в соответствии с их собственными характеристиками

1
String EventEmitter.toString();

Возвращает результат:

  • String , возвращает строковое представление объекта

toJSON

Возвращает JSON-представление объекта, обычно возвращая коллекцию читаемых свойств, определенных объектом

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

Параметры звонка:

  • key : строка, не используется

Возвращает результат:

  • Value , возвращает значение, содержащее сериализуемый JSON