OptionalworldId: numberOptionalinternalServerPort: numberOptional_airdropGlobal dictionaries for all entities
Readonly_clientsTotal amount of clients on the server
Networking layer - allows sending game data to the game client, lays on top of the H1Z1 protocol (on top of the actual H1Z1 packets)
Information from ServerItemDefinitions.json
Interactible options for items - See (ZonePacketHandlers.ts or datasources/ItemUseOptions)
Protected_loginReadonly_loginDetermines which login server is used, Localhost by default.
Readonly_mongoHandles all packets for H1Z1
Readonly_protocolReadonly_soloManagers used for handling core functionalities
OptionalchallengeOptionaldynamicReadonlygameOptionalinitialOptionalitemOptionalitemOptionalprofileOptionalprojectileMANAGED BY CONFIGMANAGER - See defaultConfig.yaml for more information
import {
setImmediate,
} from 'node:timers/promises';
const res = await setImmediate('result');
console.log(res); // Prints 'result'
Optionalvalue: TA value with which the promise is fulfilled.
Optionaloptions: TimerOptionsimport {
setTimeout,
} from 'node:timers/promises';
const res = await setTimeout(100, 'result');
console.log(res); // Prints 'result'
Optionaldelay: numberThe number of milliseconds to wait before fulfilling the promise.
Optionalvalue: TA value with which the promise is fulfilled.
Optionaloptions: TimerOptionsOptionalrebootOptionalroutinesOptionalweaponReadonlyworldStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
StaticdefaultBy 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.defaultMaxListeners property
can be used. If this value is not a positive number, a RangeError is thrown.
Take caution when setting the events.defaultMaxListeners because the
change affects all EventEmitter 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 single
EventEmitter, 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'.
Static ReadonlyerrorThis 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.
Optional[captureAdds an item to a character's inventory.
The client adding the item.
The item to add.
The id of the container definition.
[character=client.character] - The character to add the item to.
Clears a character's equipment slot.
The character to have their equipment slot cleared.
The equipment slot to clear.
OptionalsendPacket: boolean = trueOptional: Specifies whether to send a packet to other clients, default is true.
Returns true if the slot was cleared, false if the slot is invalid.
Clears all items from a character's inventory.
The client that'll have it's character's inventory cleared.
OptionaloverrideProjectileId: booleanOptionaleffectId: numberOptionaltimeToDisappear: numberRemoves a single item type from the inventory and spawns it on the ground
The item object.
Optional: The number of items to drop on the ground, default 1.
Synchronously calls each of the listeners registered for the event named eventName, 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
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) ]
Optionalclient: ZoneClient2016Generates a new item with the specified itemDefinitionId and count.
The itemDefinitionId of the item to generate.
Optionalcount: number = 1The count of the item.
OptionalforceMaxDurability: boolean = falseforce the item to have his max durability.
The generated item, or undefined if the item definition is invalid.
Generates and returns an unused itemGuid.
The generated itemGuid.
Generates random equipment for a specific slot (Zombies only).
The ID of the slot.
The gender of the entity.
[excludedModels=[]] - The excluded equipment models.
The generated equipment.
Generates random equipment for the specified entity and slots (Zombies only). To be deprecated soon
The entity to generate equipment for.
The slots to generate equipment for.
[excludedModels=[]] - The excluded equipment models.
Returns a client object by either the characterId of the passed character, or the mountedCharacterId if the passed character is a BaseLootableEntity.
Either a Character or BaseLootableEntity to retrieve its accessing client.
Returns client or undefined.
Gets the container definition for a given containerDefinitionId.
The id of the container definition to retrieve.
The container definition.
Gets the rewards for a given itemDefinitionId.
OptionalitemDefinitionId: numberThe ID of the crate to retrieve rewards from.
The rewards.
Gets the firegroup definition for a given firegroupId.
The ID of the firegroup definition to retrieve.
The firegroup definition or undefined.
Gets the firemode definition for a given firemodeId.
The ID of the firemode definition to retrieve.
The firemode definition or undefined.
Gets the max durability for a given itemDefinitionId.
OptionalitemDefinitionId: numberThe ID of the item definition to retrieve.
The item definition or undefined.
Gets the item definition for a given itemDefinitionId.
OptionalitemDefinitionId: numberThe ID of the item definition to retrieve.
The item definition or undefined.
Gets the first loadout slot that a specified item is able to go into.
The definition ID of an item to check.
OptionalloadoutId: number = LoadoutIds.CHARACTEROptional: The loadoutId of the entity to get the slot for, default LoadoutIds.CHARACTER.
Returns the ID of the first loadout slot that an item can go into (occupied or not).
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Gets a random reward for a given crate.
OptionalitemDefinitionId: numberThe ID of the crate to retrieve rewards from.
Reward Item definition ID.
Gets the maximum value for a given resource.
The ID of the resource.
The maximum value of the resource (0 if undefined).
Generates a new transientId and maps it to a provided characterId.
The characterId to map the transientId to.
Gets the ammoId for a given weapon.
The itemDefinitionId of the weapon.
The ammoId (0 if undefined).
Gets the clip size for a given weapon.
The itemDefinitionId of the weapon.
The clip size (0 if undefined).
Gets the weapon definition for a given weaponDefinitionId.
The ID of the weapon definition to retrieve.
The weapon definition or undefined.
OptionalitemDefinitionId: ItemsGets the maximum amount of ammo a clip can hold for a given weapon.
The itemDefinitionId of the weapon.
The maximum ammo (0 if undefined).
Gets the reload time in milliseconds for a given weapon.
The itemDefinitionId of the weapon.
The reload time in milliseconds (0 if undefined).
OptionalitemDefinitionId: numberChecks if an item with the specified itemDefinitionId is an armor.
The itemDefinitionId to check.
True if the item is an armor, false otherwise.
Optionalban: ClientBanChecks if an item with the specified itemDefinitionId is a boot.
The itemDefinitionId to check.
True if the item is a convey, false otherwise.
Optionalclient: ZoneClient2016Checks if an item with the specified itemDefinitionId is a construction type.
The itemDefinitionId to check.
True if the item is a generic type, false otherwise.
Checks if an item with the specified itemDefinitionId is a container.
The itemDefinitionId to check.
True if the item is a container, false otherwise.
Checks if an item with the specified itemDefinitionId is a convey.
The itemDefinitionId to check.
True if the item is a convey, false otherwise.
Checks if an item with the specified itemDefinitionId is footwear.
The itemDefinitionId to check.
True if the item is a boot, false otherwise.
Checks if an item with the specified itemDefinitionId is a gator shoe.
The itemDefinitionId to check.
True if the item is a convey, false otherwise.
Checks if an item with the specified itemDefinitionId is a generic item type.
The itemDefinitionId to check.
True if the item is a generic type, false otherwise.
Checks if an item with the specified itemDefinitionId is a helmet.
The itemDefinitionId to check.
True if the item is a helmet, false otherwise.
Checks if an item with the specified itemDefinitionId is stackable.
The itemDefinitionId to check.
True if the item is stackable, false otherwise.
Checks if an item with the specified itemDefinitionId is a weapon.
The itemDefinitionId to check.
True if the item is a weapon, false otherwise.
Checks if an item with the specified itemDefinitionId is a zed shoe.
The itemDefinitionId to check.
True if the item is a convey, false otherwise.
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.
The name of the event being listened for
Optionallistener: FunctionThe event handler 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] ]
Optionalitem: BaseItemAdds 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 eventName and
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. The emitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
The name of the event.
The callback function
Adds a one-time listener 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. The emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
The name of the event.
The callback function
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 eventName
and 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.
The name of the event.
The callback function
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.
The name of the event.
The callback 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');
OptionalinternalServerPort: numberReloads all packet handlers, structures, and commands for the entire server.
The client that called the function.
Removes an item from the account inventory.
The character to have their items removed.
The item to remove.
Optionalcount: number = 1Optional: Specifies the amount of items that need to be removed, default is 1.
Returns true if the item was successfully removed, false if there was an error.
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.
OptionaleventName: string | symbolRemoves items from a specific item stack in a container.
The character to have their items removed.
Optionalitem: BaseItemThe item object.
Optionalcontainer: LoadoutContainerThe container that has the item stack in it.
Optionalcount: numberOptional: The number of items to remove from the stack, default 1.
Returns true if the items were successfully removed, false if there was an error.
Removes items from a specific item stack in the inventory, including containers and loadout.
The character to have their items removed.
The item object.
Optionalcount: number = 1Optional: The number of items to remove from the stack, default 1.
OptionalupdateEquipment: boolean = trueOptional: Specifies whether to update the equipment, default is true.
Returns true if the items were successfully removed, false if there was an error.
Removes a specified amount of an item across all inventory containers / loadout (LOADOUT DISABLED FOR NOW).
The itemDefinitionId of the item(s) to be removed.
Optional: The number of items to remove, default 1.
Returns true if all items were successfully removed, false if there was an error.
Removes the specified listener from the listener array for the event named eventName.
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 any removeListener() 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.
Removes an item from the loadout.
The character to have their items removed.
The loadout slot containing the item to remove.
OptionalupdateEquipment: boolean = trueOptional: Specifies whether to update the equipment, default is true.
Returns true if the item was successfully removed, false if there was an error.
OptionalrejectionFlag: CONNECTION_REJECTION_FLAGSOptionalclearChat: booleanOptionalammoCount: numberBy 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 to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Switches the loadout slot for a client.
The client to switch the loadout slot for.
The new loadout item.
Disconnects a client from the zone.
The client to be disconnected
OptionalresourceType: numberValidates if an item can be equipped in the specified equipment slot.
The itemDefinitionId of the item to validate.
The equipment slot ID.
True if the item can be equipped in the slot, false otherwise.
Validates that a given itemDefinitionId can be equipped in a given loadout slot.
The definition ID of an item to validate.
The loadoutSlotId to have the item validated for.
The loadoutId of the entity to get the slot for.
Returns true/false if the item can go in a specified loadout slot.
StaticaddExperimentalListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
this since it would violate the web standard. Additionally, the original
API makes it easy to forget to remove listeners.
This API allows safely using AbortSignals in Node.js APIs by solving these
two issues by listening to the event such that stopImmediatePropagation does
not prevent the listener from running.
Returns a disposable so that it may be unsubscribed from more easily.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
Disposable that removes the abort listener.
StaticgetReturns 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] ]
}
StaticgetReturns the currently set max amount of listeners.
For EventEmitters this behaves exactly the same as calling .getMaxListeners on
the emitter.
For EventTargets this is the only way to get the max event listeners for the
event target. If the number of event handlers on a single EventTarget exceeds
the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
StaticlistenerA class method that returns the number of listeners for the given eventName registered 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
The emitter to query
The event name
Staticonimport { 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());
Use the close option to specify an array of event names that will end the iteration:
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);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'
Optionaloptions: StaticEventEmitterIteratorOptionsAn AsyncIterator that iterates eventName events emitted by the emitter
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());
Use the close option to specify an array of event names that will end the iteration:
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);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'
Optionaloptions: StaticEventEmitterIteratorOptionsAn AsyncIterator that iterates eventName events emitted by the emitter
StaticonceCreates 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!
Optionaloptions: StaticEventEmitterOptionsCreates 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!
Optionaloptions: StaticEventEmitterOptionsStaticsetimport { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
Optionaln: numberA non-negative number. The maximum number of listeners per EventTarget event.
Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter}
objects.
Airdrop information - includes: plane (Plane), cargo (Plane), planeTarget (string), planeTargetPos (Float32Array), cargoTarget (string), cargoTargetPos(Float32Array), destination (string), destinationPos (Float32Array), cargoSpawned (boolean), hospitalCrate (boolean), manager (Client)