Skip to content

qchat.server.QChatServerModule

Zvicii edited this page Jul 8, 2022 · 6 revisions

Class: QChatServerModule

qchat/server.QChatServerModule

Hierarchy

  • EventEmitter

    QChatServerModule

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): QChatServerModule

Alias for emitter.on(eventName, listener).

Since

v0.1.26

Parameters

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

Returns

QChatServerModule

Inherited from

EventEmitter.addListener


on

on(eventName, listener): QChatServerModule

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

QChatServerModule

Inherited from

EventEmitter.on


once

once(eventName, listener): QChatServerModule

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

QChatServerModule

Inherited from

EventEmitter.once


removeListener

removeListener(eventName, listener): QChatServerModule

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

QChatServerModule

Inherited from

EventEmitter.removeListener


off

off(eventName, listener): QChatServerModule

Alias for emitter.removeListener().

Since

v10.0.0

Parameters

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

Returns

QChatServerModule

Inherited from

EventEmitter.off


removeAllListeners

removeAllListeners(event?): QChatServerModule

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

QChatServerModule

Inherited from

EventEmitter.removeAllListeners


setMaxListeners

setMaxListeners(n): QChatServerModule

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

QChatServerModule

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): QChatServerModule

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

QChatServerModule

Inherited from

EventEmitter.prependListener


prependOnceListener

prependOnceListener(eventName, listener): QChatServerModule

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

QChatServerModule

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


createServer

createServer(param): Promise<QChatServerCreateResp>

Fn

createServer(param: QChatServerCreateParam) 创建服务器

Parameters

Name Type
param QChatServerCreateParam

Returns

Promise<QChatServerCreateResp>

void


deleteServer

deleteServer(param): Promise<QChatBaseResp>

Fn

deleteServer(param: QChatServerDeleteParam) 删除服务器

Parameters

Name Type
param QChatServerDeleteParam

Returns

Promise<QChatBaseResp>

void


updateServer

updateServer(param): Promise<QChatServerCreateResp>

Fn

updateServer(param: QChatServerUpdateParam) 更新服务器

Parameters

Name Type
param QChatServerUpdateParam

Returns

Promise<QChatServerCreateResp>

void


subscribe

subscribe(param): Promise<QChatServerSubscribeResp>

Fn

subscribe(param: QChatServerSubscribeParam) 订阅指定服务器下的系统通知消息

Parameters

Name Type
param QChatServerSubscribeParam

Returns

Promise<QChatServerSubscribeResp>

void


getServers

getServers(param): Promise<QChatServerGetServersResp>

Fn

getServers(param: QChatServerGetServersParam) 查询服务器列表

Parameters

Name Type
param QChatServerGetServersParam

Returns

Promise<QChatServerGetServersResp>

void


getServersByPage

getServersByPage(param): Promise<QChatServerGetServersPageResp>

Fn

getServersByPage(param: QChatServerGetServersPageParam) 查询服务器列表(分页)

Parameters

Name Type
param QChatServerGetServersPageParam

Returns

Promise<QChatServerGetServersPageResp>

void


invite

invite(param): Promise<QChatServerInviteResp>

Fn

invite(param: QChatServerInviteParam) 邀请用户加入服务器

Parameters

Name Type
param QChatServerInviteParam

Returns

Promise<QChatServerInviteResp>

void


acceptInvite

acceptInvite(param): Promise<QChatBaseResp>

Fn

acceptInvite(param: QChatServerAcceptInviteParam) 接受加入服务器邀请

Parameters

Name Type
param QChatServerAcceptInviteParam

Returns

Promise<QChatBaseResp>

void


rejectInvite

rejectInvite(param): Promise<QChatBaseResp>

Fn

rejectInvite(param: QChatServerRejectInviteParam) 拒绝加入服务器邀请

Parameters

Name Type
param QChatServerRejectInviteParam

Returns

Promise<QChatBaseResp>

void


apply

apply(param): Promise<QChatServerApplyResp>

Fn

apply(param: QChatServerApplyParam) 申请加入服务器

Parameters

Name Type
param QChatServerApplyParam

Returns

Promise<QChatServerApplyResp>

void


acceptApply

acceptApply(param): Promise<QChatBaseResp>

Fn

acceptApply(param: QChatServerAcceptApplyParam) 同意加入服务器申请

Parameters

Name Type
param QChatServerAcceptApplyParam

Returns

Promise<QChatBaseResp>

void


rejectApply

rejectApply(param): Promise<QChatBaseResp>

Fn

rejectApply(param: QChatServerRejectApplyParam) 拒绝加入服务器申请

Parameters

Name Type
param QChatServerRejectApplyParam

Returns

Promise<QChatBaseResp>

void


kick

kick(param): Promise<QChatBaseResp>

Fn

kick(param: QChatServerKickParam) 将指定用户踢出服务器

Parameters

Name Type
param QChatServerKickParam

Returns

Promise<QChatBaseResp>

void


leave

leave(param): Promise<QChatBaseResp>

Fn

leave(param: QChatServerLeaveParam) 离开指定服务器

Parameters

Name Type
param QChatServerLeaveParam

Returns

Promise<QChatBaseResp>

void


updateMemberInfo

updateMemberInfo(param): Promise<QChatBaseResp>

Fn

updateMemberInfo(param: QChatServerUpdateMemberInfoParam) 更新服务器成员信息

Parameters

Name Type
param QChatServerUpdateMemberInfoParam

Returns

Promise<QChatBaseResp>

void


getServerMembers

getServerMembers(param): Promise<QChatServerGetMembersResp>

Fn

getServerMembers(param: QChatServerGetMembersParam) 查询服务器成员列表

Parameters

Name Type
param QChatServerGetMembersParam

Returns

Promise<QChatServerGetMembersResp>

void


getServerMembersByPage

getServerMembersByPage(param): Promise<QChatServerGetMembersPageResp>

Fn

getServerMembersByPage(param: QChatServerGetMembersPageParam) 查询服务器成员列表(分页)

Parameters

Name Type
param QChatServerGetMembersPageParam

Returns

Promise<QChatServerGetMembersPageResp>

void


banMember

banMember(param): Promise<QChatBaseResp>

Fn

banMember(param: QChatServerBanMemberParam) 封禁服务器成员

Parameters

Name Type
param QChatServerBanMemberParam

Returns

Promise<QChatBaseResp>

void


unbanMember

unbanMember(param): Promise<QChatBaseResp>

Fn

unbanMember(param: QChatServerUnbanMemberParam) 解封服务器成员

Parameters

Name Type
param QChatServerUnbanMemberParam

Returns

Promise<QChatBaseResp>

void


getBannedMembersByPage

getBannedMembersByPage(param): Promise<QChatServerGetBannedMembersPageResp>

Fn

getBannedMembersByPage(param: QChatServerGetBannedMembersPageParam) 查询服务器封禁成员列表(分页)

Parameters

Name Type
param QChatServerGetBannedMembersPageParam

Returns

Promise<QChatServerGetBannedMembersPageResp>

void


serverSearchByPage

serverSearchByPage(param): Promise<QChatServerGetServersPageResp>

Fn

serverSearchByPage(param: QChatServerSearchPageParam) 根据关键字搜索服务器(分页)

Parameters

Name Type
param QChatServerSearchPageParam

Returns

Promise<QChatServerGetServersPageResp>

void


serverMemberSearch

serverMemberSearch(param): Promise<QChatServerGetMembersResp>

Fn

serverMemberSearch(param: QChatServerMemberSearchParam) 根据关键字搜索服务器成员

Parameters

Name Type
param QChatServerMemberSearchParam

Returns

Promise<QChatServerGetMembersResp>

void


generateInviteCode

generateInviteCode(param): Promise<QChatServerGenerateInviteCodeResp>

Fn

generateInviteCode(param: QChatServerGenerateInviteCodeParam) 生成服务器邀请码

Parameters

Name Type
param QChatServerGenerateInviteCodeParam

Returns

Promise<QChatServerGenerateInviteCodeResp>

void


joinByInviteCode

joinByInviteCode(param): Promise<QChatBaseResp>

Fn

joinByInviteCode(param: QChatServerJoinByInviteCodeParam) 通过邀请码加入服务器

Parameters

Name Type
param QChatServerJoinByInviteCodeParam

Returns

Promise<QChatBaseResp>

void


getInviteApplyRecordOfServer

getInviteApplyRecordOfServer(param): Promise<QChatServerGetInviteApplyRecordOfServerResp>

Fn

getInviteApplyRecordOfServer(param: QChatServerGetInviteApplyRecordOfServerParam) 查询服务器下邀请申请历史

Parameters

Name Type
param QChatServerGetInviteApplyRecordOfServerParam

Returns

Promise<QChatServerGetInviteApplyRecordOfServerResp>

void


getInviteApplyRecordOfSelf

getInviteApplyRecordOfSelf(param): Promise<QChatServerGetInviteApplyRecordOfServerResp>

Fn

getInviteApplyRecordOfSelf(param: QChatServerGetInviteApplyRecordOfSelfParam) 查询自己邀请申请历史

Parameters

Name Type
param QChatServerGetInviteApplyRecordOfSelfParam

Returns

Promise<QChatServerGetInviteApplyRecordOfServerResp>

void

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


instance

instance: any

Defined in

ts/qchat/server.ts:61

Constructors

constructor

new QChatServerModule()

Overrides

EventEmitter.constructor

Clone this wiki locally