Skip to content

chatroom.chatroom.ChatRoomModule

Jump to bottom
Zvicii edited this page Jul 8, 2022 · 8 revisions

Class: ChatRoomModule

chatroom/chatroom.ChatRoomModule

Hierarchy

  • EventEmitter

    ↳ ChatRoomModule

Table of contents

Methods

Properties

Constructors

Methods

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.

const { once, EventEmitter } = require('events');

async function run() {
  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.log('error happened', err);
  }
}

run();

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:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

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

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

// Prints: ok boom

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

const { EventEmitter, once } = require('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[]>

Inherited from

EventEmitter.once

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

Parameters

Name Type
emitter DOMEventTarget
eventName string
options? StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

EventEmitter.once

on

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

const { on, EventEmitter } = require('events');

(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')) {
    // 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:

const { on, EventEmitter } = require('events');
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

Inherited from

EventEmitter.on

listenerCount

▸ Static listenerCount(emitter, eventName): number

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

const { EventEmitter, listenerCount } = require('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

Inherited from

EventEmitter.listenerCount

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.

const { getEventListeners, EventEmitter } = require('events');

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

Since

v15.2.0

Parameters

Name Type
emitter EventEmitter | DOMEventTarget
name string | symbol

Returns

Function[]

Inherited from

EventEmitter.getEventListeners

addListener

▸ addListener(eventName, listener): ChatRoomModule

Alias for emitter.on(eventName, listener).

Since

v0.1.26

Parameters

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

Returns

ChatRoomModule

Inherited from

EventEmitter.addListener

on

▸ on(eventName, listener): ChatRoomModule

Adds the listener function to the end 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.on('connection', (stream) => {
  console.log('someone connected!');
});

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

By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since

v0.1.101

Parameters

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

Returns

ChatRoomModule

Inherited from

EventEmitter.on

once

▸ once(eventName, listener): ChatRoomModule

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

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

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

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since

v0.3.0

Parameters

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

Returns

ChatRoomModule

Inherited from

EventEmitter.once

removeListener

▸ removeListener(eventName, listener): ChatRoomModule

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.

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:

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

ChatRoomModule

Inherited from

EventEmitter.removeListener

off

▸ off(eventName, listener): ChatRoomModule

Alias for emitter.removeListener().

Since

v10.0.0

Parameters

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

Returns

ChatRoomModule

Inherited from

EventEmitter.off

removeAllListeners

▸ removeAllListeners(event?): ChatRoomModule

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

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

Since

v0.1.26

Parameters

Name Type
event? string | symbol

Returns

ChatRoomModule

Inherited from

EventEmitter.removeAllListeners

setMaxListeners

▸ setMaxListeners(n): ChatRoomModule

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

ChatRoomModule

Inherited from

EventEmitter.setMaxListeners

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

Inherited from

EventEmitter.getMaxListeners

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[]

Inherited from

EventEmitter.listeners

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()).

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[]

Inherited from

EventEmitter.rawListeners

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.

const EventEmitter = require('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

Inherited from

EventEmitter.emit

listenerCount

▸ listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Since

v3.2.0

Parameters

Name Type Description
eventName string | symbol The name of the event being listened for

Returns

number

Inherited from

EventEmitter.listenerCount

prependListener

▸ prependListener(eventName, listener): ChatRoomModule

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

ChatRoomModule

Inherited from

EventEmitter.prependListener

prependOnceListener

▸ prependOnceListener(eventName, listener): ChatRoomModule

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

ChatRoomModule

Inherited from

EventEmitter.prependOnceListener

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.

const EventEmitter = require('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)[]

Inherited from

EventEmitter.eventNames

initEventHandlers

▸ initEventHandlers(): void

Returns

void

init

▸ init(app_install_dir, json_extension): boolean

Parameters

Name Type
app_install_dir string
json_extension string

Returns

boolean

cleanup

▸ cleanup(json_extension): void

Parameters

Name Type
json_extension string

Returns

void

independentEnter

▸ independentEnter(room_id, info): boolean

Parameters

Name Type
room_id number
info ChatRoomIndependentEnterInfo

Returns

boolean

anonymousEnter

▸ anonymousEnter(room_id, anonymity_info, info, json_extension): boolean

Parameters

Name Type
room_id number
anonymity_info ChatRoomAnoymityEnterInfo
info ChatRoomEnterInfo
json_extension string

Returns

boolean

enter

▸ enter(room_id, request_login_data, info, json_extension): boolean

Parameters

Name Type
room_id number
request_login_data string
info ChatRoomEnterInfo
json_extension string

Returns

boolean

exit

▸ exit(room_id, json_extension): void

Parameters

Name Type
room_id number
json_extension string

Returns

void

getLoginState

▸ getLoginState(room_id, json_extension): NIMChatRoomLoginState

Parameters

Name Type
room_id number
json_extension string

Returns

NIMChatRoomLoginState

setMsgsBatchReport

▸ setMsgsBatchReport(set_batch, json_extension): void

Parameters

Name Type
set_batch boolean
json_extension string

Returns

void

sendMsg

▸ sendMsg(room_id, msg, json_extension): boolean

Parameters

Name Type
room_id number
msg ChatRoomMessage
json_extension string

Returns

boolean

getMembersOnlineAsync

▸ getMembersOnlineAsync(room_id, parameters, callback, json_extension): void

Parameters

Name Type
room_id number
parameters ChatRoomGetMembersParameters
callback GetMembersCallback
json_extension string

Returns

void

getMembersByTagOnlineAsync

▸ getMembersByTagOnlineAsync(room_id, parameters, callback, json_extension): void

Parameters

Name Type
room_id number
parameters ChatRoomGetMembersParameters
callback GetMembersCallback
json_extension string

Returns

void

getMembersCountByTagOnlineAsync

▸ getMembersCountByTagOnlineAsync(room_id, parameters, callback, json_extension): void

Parameters

Name Type
room_id number
parameters ChatRoomGetMembersParameters
callback GetMembersCountByTagCallback
json_extension string

Returns

void

getMessageHistoryOnlineAsync

▸ getMessageHistoryOnlineAsync(room_id, parameters, callback, json_extension): void

Parameters

Name Type
room_id number
parameters ChatRoomGetMsgHistoryParameters
callback GetMsgHistoryCallback
json_extension string

Returns

void

setMemberAttributeOnlineAsync

▸ setMemberAttributeOnlineAsync(room_id, parameters, callback, json_extension): void

Parameters

Name Type
room_id number
parameters ChatRoomSetMemberAttributeParameters
callback SetMemberAttributeCallback
json_extension string

Returns

void

getInfoAsync

▸ getInfoAsync(room_id, callback, json_extension): void

Parameters

Name Type
room_id number
callback GetChatRoomInfoCallback
json_extension string

Returns

void

getMemberInfoByIDsAsync

▸ getMemberInfoByIDsAsync(room_id, ids, callback, json_extension): void

Parameters

Name Type
room_id number
ids string[]
callback GetMembersCallback
json_extension string

Returns

void

kickMemberAsync

▸ kickMemberAsync(room_id, id, notify_ext, callback, json_extension): void

Parameters

Name Type
room_id number
id string
notify_ext string
callback KickMemberCallback
json_extension string

Returns

void

setProxy

▸ setProxy(type, host, port, user, password): void

Parameters

Name Type
type NIMChatRoomProxyType
host string
port number
user string
password string

Returns

void

tempMuteMemberAsync

▸ tempMuteMemberAsync(room_id, accid, duration, need_notify, notify_ext, callback, json_extension): void

Parameters

Name Type
room_id number
accid string
duration number
need_notify boolean
notify_ext string
callback TempMuteMemberCallback
json_extension string

Returns

void

tempMuteMemberByTagAsync

▸ tempMuteMemberByTagAsync(room_id, target_tag, duration, need_notify, notify_ext, callback, notify_tags, json_extension): void

Parameters

Name Type
room_id number
target_tag string
duration number
need_notify boolean
notify_ext string
callback TempMuteMemberCallback
notify_tags string
json_extension string

Returns

void

updateRoomInfoAsync

▸ updateRoomInfoAsync(room_id, room_info, need_notify, notify_ext, callback, json_extension): void

Parameters

Name Type
room_id number
room_info ChatRoomInfo
need_notify boolean
notify_ext string
callback UpdateRoomInfoCallback
json_extension string

Returns

void

updateMyRoomRoleAsync

▸ updateMyRoomRoleAsync(room_id, info, need_notify, notify_ext, callback, json_extension): void

Parameters

Name Type
room_id number
info ChatRoomMemberInfo
need_notify boolean
notify_ext string
callback UpdateMyRoomRoleCallback
json_extension string

Returns

void

queueOfferAsync

▸ queueOfferAsync(room_id, element, option, callback, json_extension): void

Parameters

Name Type
room_id number
element ChatRoomQueueElement
option ChatRoomQueueOfferOption
callback QueueOfferCallback
json_extension string

Returns

void

queuePollAsync

▸ queuePollAsync(room_id, element_key, callback, json_extension): void

Parameters

Name Type
room_id number
element_key string
callback QueuePollCallback
json_extension string

Returns

void

queueListAsync

▸ queueListAsync(room_id, callback, json_extension): void

Parameters

Name Type
room_id number
callback QueueListCallback
json_extension string

Returns

void

queueHeaderAsync

▸ queueHeaderAsync(room_id, callback, json_extension): void

Parameters

Name Type
room_id number
callback QueueHeaderCallback
json_extension string

Returns

void

queueDropAsync

▸ queueDropAsync(room_id, callback, json_extension): void

Parameters

Name Type
room_id number
callback QueueDropCallback
json_extension string

Returns

void

queueBatchUpdateAsync

▸ queueBatchUpdateAsync(room_id, batch_elements, need_notify, notify_ext, callback, json_extension): void

Parameters

Name Type
room_id number
batch_elements ChatRoomQueueElement[]
need_notify boolean
notify_ext string
callback QueueBatchUpdateCallback
json_extension string

Returns

void

updateLocation

▸ updateLocation(room_id, location, callback, json_extension): boolean

Parameters

Name Type
room_id number
location NIMChatRoomLocation
callback UpdateLocationCallback
json_extension string

Returns

boolean

updateTags

▸ updateTags(room_id, tags_info, callback, json_extension): boolean

Parameters

Name Type
room_id number
tags_info ChatRoomUpdateTagsInfo
callback UpdateTagsCallback
json_extension string

Returns

boolean

Properties

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.

Inherited from

EventEmitter.errorMonitor

Defined in

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

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

EventEmitter.captureRejectionSymbol

Defined in

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

captureRejections

▪ Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

EventEmitter.captureRejections

Defined in

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

defaultMaxListeners

▪ Static defaultMaxListeners: number

Inherited from

EventEmitter.defaultMaxListeners

Defined in

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

chatroom

• chatroom: any

Defined in

ts/chatroom/chatroom.ts:73

Constructors

constructor

• new ChatRoomModule()

Overrides

EventEmitter.constructor

node-nim

Modules

Clone this wiki locally