Skip to content
github-actions[bot] edited this page Aug 11, 2023 · 2 revisions

Class: Hue

Hierarchy

  • EventEmitter

    Hue

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Hue(options)

Parameters

Name Type
options HueOptions

Defined in

src/hue/Hue.ts:74

Properties

_rest

Readonly _rest: Rest

Defined in

src/hue/Hue.ts:71


_sse

Readonly _sse: Sse

Defined in

src/hue/Hue.ts:72


bridges

Readonly bridges: BridgeManager

Defined in

src/hue/Hue.ts:70


devicePowers

Readonly devicePowers: DevicePowerManager

Defined in

src/hue/Hue.ts:65


devices

Readonly devices: DeviceManager

Defined in

src/hue/Hue.ts:61


groupedLights

Readonly groupedLights: GroupedLightManager

Defined in

src/hue/Hue.ts:64


lights

Readonly lights: LightManager

Defined in

src/hue/Hue.ts:60


motions

Readonly motions: MotionManager

Defined in

src/hue/Hue.ts:67


off

off: <T>(event: T, listener: (...args: HueEvents[T]) => any) => Hue

Type declaration

▸ <T>(event, listener): Hue

Type parameters
Name Type
T extends keyof HueEvents
Parameters
Name Type
event T
listener (...args: HueEvents[T]) => any
Returns

Hue

Defined in

src/hue/Hue.ts:54


on

on: <T>(event: T, listener: (...args: HueEvents[T]) => any) => Hue

Type declaration

▸ <T>(event, listener): Hue

Type parameters
Name Type
T extends keyof HueEvents
Parameters
Name Type
event T
listener (...args: HueEvents[T]) => any
Returns

Hue

Defined in

src/hue/Hue.ts:52


once

once: <T>(event: T, listener: (...args: HueEvents[T]) => any) => Hue

Type declaration

▸ <T>(event, listener): Hue

Type parameters
Name Type
T extends keyof HueEvents
Parameters
Name Type
event T
listener (...args: HueEvents[T]) => any
Returns

Hue

Defined in

src/hue/Hue.ts:53


options

Readonly options: HueOptions

Defined in

src/hue/Hue.ts:59


removeAllListeners

removeAllListeners: <T>(event?: T) => Hue

Type declaration

▸ <T>(event?): Hue

Type parameters
Name Type
T extends keyof HueEvents
Parameters
Name Type
event? T
Returns

Hue

Defined in

src/hue/Hue.ts:55


rooms

Readonly rooms: RoomManager

Defined in

src/hue/Hue.ts:62


scenes

Readonly scenes: SceneManager

Defined in

src/hue/Hue.ts:66


zigbeeConnectivities

Readonly zigbeeConnectivities: ZigbeeConnectivityManager

Defined in

src/hue/Hue.ts:68


zigbeeDeviceDiscoveries

Readonly zigbeeDeviceDiscoveries: ZigbeeDeviceDiscoveryManager

Defined in

src/hue/Hue.ts:69


zones

Readonly zones: ZoneManager

Defined in

src/hue/Hue.ts:63


captureRejectionSymbol

Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Defined in

node_modules/@types/node/events.d.ts:326


captureRejections

Static captureRejections: boolean

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Defined in

node_modules/@types/node/events.d.ts:333


defaultMaxListeners

Static defaultMaxListeners: number

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

Take caution when setting the events.defaultMaxListeners because the change affects allEventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Defined in

node_modules/@types/node/events.d.ts:370


errorMonitor

Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Defined in

node_modules/@types/node/events.d.ts:319

Accessors

_url

get _url(): string

Returns

string

Defined in

src/hue/Hue.ts:79

Methods

_create

_create(data): undefined | NarrowResource

Parameters

Name Type
data any

Returns

undefined | NarrowResource

Defined in

src/hue/Hue.ts:96


addListener

addListener(eventName, listener): Hue

Alias for emitter.on(eventName, listener).

Since

v0.1.26

Parameters

Name Type
eventName string | symbol
listener (...args: any[]) => void

Returns

Hue

Defined in

node_modules/@types/node/events.d.ts:390


connect

connect(): Promise<void>

Returns

Promise<void>

Defined in

src/hue/Hue.ts:84


emit

emit(eventName, ...args): boolean

Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Since

v0.1.26

Parameters

Name Type
eventName string | symbol
...args any[]

Returns

boolean

Defined in

node_modules/@types/node/events.d.ts:652


eventNames

eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Since

v6.0.0

Returns

(string | symbol)[]

Defined in

node_modules/@types/node/events.d.ts:715


getMaxListeners

getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Since

v1.0.0

Returns

number

Defined in

node_modules/@types/node/events.d.ts:567


listenerCount

listenerCount(eventName, listener?): number

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Since

v3.2.0

Parameters

Name Type Description
eventName string | symbol The name of the event being listened for
listener? Function The event handler function

Returns

number

Defined in

node_modules/@types/node/events.d.ts:661


listeners

listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Since

v0.1.26

Parameters

Name Type
eventName string | symbol

Returns

Function[]

Defined in

node_modules/@types/node/events.d.ts:580


prependListener

prependListener(eventName, listener): Hue

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v6.0.0

Parameters

Name Type Description
eventName string | symbol The name of the event.
listener (...args: any[]) => void The callback function

Returns

Hue

Defined in

node_modules/@types/node/events.d.ts:679


prependOnceListener

prependOnceListener(eventName, listener): Hue

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v6.0.0

Parameters

Name Type Description
eventName string | symbol The name of the event.
listener (...args: any[]) => void The callback function

Returns

Hue

Defined in

node_modules/@types/node/events.d.ts:695


rawListeners

rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Since

v9.4.0

Parameters

Name Type
eventName string | symbol

Returns

Function[]

Defined in

node_modules/@types/node/events.d.ts:611


removeListener

removeListener(eventName, listener): Hue

Removes the specified listener from the listener array for the event namedeventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.1.26

Parameters

Name Type
eventName string | symbol
listener (...args: any[]) => void

Returns

Hue

Defined in

node_modules/@types/node/events.d.ts:535


setMaxListeners

setMaxListeners(n): Hue

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.3.5

Parameters

Name Type
n number

Returns

Hue

Defined in

node_modules/@types/node/events.d.ts:561


getEventListeners

Static getEventListeners(emitter, name): Function[]

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

Since

v15.2.0, v14.17.0

Parameters

Name Type
emitter EventEmitter | _DOMEventTarget
name string | symbol

Returns

Function[]

Defined in

node_modules/@types/node/events.d.ts:296


listenerCount

Static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Parameters

Name Type Description
emitter EventEmitter The emitter to query
eventName string | symbol The event name

Returns

number

Defined in

node_modules/@types/node/events.d.ts:268


on

Static on(emitter, eventName, options?): AsyncIterableIterator<any>

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Since

v13.6.0, v12.16.0

Parameters

Name Type Description
emitter EventEmitter -
eventName string The name of the event being listened for
options? StaticEventEmitterOptions -

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Defined in

node_modules/@types/node/events.d.ts:250


once

Static once(emitter, eventName, options?): Promise<any[]>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters

Name Type
emitter _NodeEventTarget
eventName string | symbol
options? StaticEventEmitterOptions

Returns

Promise<any[]>

Defined in

node_modules/@types/node/events.d.ts:189

Static once(emitter, eventName, options?): Promise<any[]>

Parameters

Name Type
emitter _DOMEventTarget
eventName string
options? StaticEventEmitterOptions

Returns

Promise<any[]>

Defined in

node_modules/@types/node/events.d.ts:190


setMaxListeners

Static setMaxListeners(n?, ...eventTargets): void

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters

Name Type Description
n? number A non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets (EventEmitter | _DOMEventTarget)[] -

Returns

void

Defined in

node_modules/@types/node/events.d.ts:311

hue.ts

Clone this wiki locally