p2p-cash / Peer

Class: Peer

Hierarchy

EventEmitter

↳ Peer

DEBUG_LOG
autoReconnect
autoReconnectWait
buffers
connectOptions
connected
disableExtmsg
disconnects
emitter
extmsg
keepAliveTimer
listenRelay
magic
nextInvIsMessageResponse
node
peerVersion
pingInterval
port
promiseConnect
socket
startHeight
stream
ticker
timeoutConnect
useSSL
userAgent
validate
version
wsProxyNode
wsProxyPort
captureRejectionSymbol
captureRejections
defaultMaxListeners
errorMonitor

Methods

addListener
broadcastTransaction
broadcastTransactions
clearKeepAlive
connect
disconnect
emit
eventNames
getBlock
getBlockHashes
getBlocks
getDSProof
getDSProofs
getHeaders
getMaxListeners
getMempool
getMempoolTransactions
getPeerAddresses
getRawDSProof
getRawDSProofs
getRawTransaction
getRawTransactions
getTransaction
getTransactions
listenerCount
listeners
off
on
once
ping
prependListener
prependOnceListener
rawListeners
readMessage
removeAllListeners
removeListener
sendMessage
setMaxListeners
setupKeepAlive
streamBlock
watchAddressTransactions
watchDSProofIds
watchDSProofs
watchMempoolRawTransactions
watchMempoolTransactionHashes
watchMempoolTransactions
watchNewBlocks
watchRawDSProofs
getEventListeners
listenerCount
on
once
setMaxListeners

Constructors

constructor

• new Peer(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`PeerOptions`

Overrides

EventEmitter.constructor

Defined in

src/peer.ts:64

Properties

DEBUG_LOG

• DEBUG_LOG: boolean

Defined in

src/peer.ts:45

autoReconnect

• autoReconnect: boolean

Defined in

src/peer.ts:37

autoReconnectWait

• autoReconnectWait: number

Defined in

src/peer.ts:38

buffers

• buffers: Object

Type declaration

Name	Type
`block`	`default`
`chunkNum`	`number`
`data`	`Buffer`[]
`downloadingBlock`	`boolean`
`length`	`number`
`needed`	`number`

Defined in

src/peer.ts:47

connectOptions

• Optional connectOptions: VersionOptions

Defined in

src/peer.ts:56

connected

• connected: boolean

Defined in

src/peer.ts:41

disableExtmsg

• disableExtmsg: boolean

Defined in

src/peer.ts:40

disconnects

• disconnects: number

Defined in

src/peer.ts:43

emitter

• emitter: default

Defined in

src/peer.ts:46

extmsg

• extmsg: boolean

Defined in

src/peer.ts:42

keepAliveTimer

• Optional keepAliveTimer: Timeout

Defined in

src/peer.ts:60

listenRelay

• listenRelay: boolean

Defined in

src/peer.ts:34

magic

• magic: Buffer

Defined in

src/peer.ts:30

nextInvIsMessageResponse

• Private nextInvIsMessageResponse: boolean = false

Defined in

src/peer.ts:62

node

• node: string

Defined in

src/peer.ts:24

peerVersion

• Optional peerVersion: Object

Type declaration

Name	Type
`addrFrom`	`NetAddress`
`addrRecv`	`NetAddress`
`nonce`	`Buffer`
`relay`	`number`
`services`	`Buffer`
`startHeight`	`number`
`timestamp`	`number`
`userAgent`	`string`
`version`	`number`

Defined in

src/peer.ts:58

pingInterval

• pingInterval: number

Defined in

src/peer.ts:39

port

• port: number

Defined in

src/peer.ts:25

promiseConnect

• Optional promiseConnect: any

Defined in

src/peer.ts:57

socket

• Optional socket: null | Socket

Defined in

src/peer.ts:55

startHeight

• Optional startHeight: number

Defined in

src/peer.ts:33

stream

• stream: boolean

Defined in

src/peer.ts:35

ticker

• ticker: string

Defined in

src/peer.ts:29

timeoutConnect

• timeoutConnect: number

Defined in

src/peer.ts:44

useSSL

• Optional useSSL: boolean

Defined in

src/peer.ts:28

userAgent

• Optional userAgent: string

Defined in

src/peer.ts:32

validate

• validate: boolean

Defined in

src/peer.ts:36

version

• version: number

Defined in

src/peer.ts:31

wsProxyNode

• Optional wsProxyNode: string

Defined in

src/peer.ts:26

wsProxyPort

• Optional wsProxyPort: number

Defined in

src/peer.ts:27

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

EventEmitter.captureRejectionSymbol

Defined in

node_modules/@types/node/ts4.8/events.d.ts:328

captureRejections

▪ Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

EventEmitter.captureRejections

Defined in

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

defaultMaxListeners

▪ Static defaultMaxListeners: number

Inherited from

EventEmitter.defaultMaxListeners

Defined in

node_modules/@types/node/ts4.8/events.d.ts:334

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/ts4.8/events.d.ts:327

Methods

addListener

▸ addListener(eventName, listener): Peer

Alias for emitter.on(eventName, listener).

Since

v0.1.26

Parameters

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

Returns

Peer

Inherited from

EventEmitter.addListener

Defined in

node_modules/@types/node/ts4.8/events.d.ts:354

broadcastTransaction

▸ broadcastTransaction(transaction, timeoutSeconds?): Promise<Buffer>

Parameters

Name	Type
`transaction`	`default`
`timeoutSeconds`	`number`

Returns

Promise<Buffer>

Defined in

src/peer.ts:642

broadcastTransactions

▸ broadcastTransactions(transactions, timeoutSeconds?): Promise<Buffer[]>

Parameters

Name	Type
`transactions`	`default`[]
`timeoutSeconds`	`number`

Returns

Promise<Buffer[]>

Defined in

src/peer.ts:648

clearKeepAlive

▸ clearKeepAlive(): void

Returns

void

Defined in

src/peer.ts:148

connect

▸ connect(options?): any

Parameters

Name	Type
`options`	`undefined` \| `VersionOptions`

Returns

any

Defined in

src/peer.ts:436

disconnect

▸ disconnect(autoReconnect?): void

Parameters

Name	Type	Default value
`autoReconnect`	`boolean`	`false`

Returns

void

Defined in

src/peer.ts:553

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:610

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:669

getBlock

▸ getBlock(blockHash): Promise<default>

Parameters

Name	Type
`blockHash`	`Buffer`

Returns

Promise<default>

Defined in

src/peer.ts:741

getBlockHashes

▸ getBlockHashes(__namedParameters): Promise<default[]>

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.from?`	`Buffer` \| `Buffer`[]
`__namedParameters.timeoutSeconds?`	`number`
`__namedParameters.to?`	`Buffer`

Returns

Promise<default[]>

Defined in

src/peer.ts:607

getBlocks

▸ getBlocks(blockHashes): Promise<default[]>

Parameters

Name	Type
`blockHashes`	`Buffer`[]

Returns

Promise<default[]>

Defined in

src/peer.ts:719

getDSProof

▸ getDSProof(dspId): Promise<default>

Parameters

Name	Type
`dspId`	`Buffer`

Returns

Promise<default>

Defined in

src/peer.ts:828

getDSProofs

▸ getDSProofs(dspIds): Promise<default[]>

Parameters

Name	Type
`dspIds`	`Buffer`[]

Returns

Promise<default[]>

Defined in

src/peer.ts:823

getHeaders

▸ getHeaders(__namedParameters): Promise<default[]>

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.from?`	`Buffer` \| `Buffer`[]
`__namedParameters.timeoutSeconds?`	`number`
`__namedParameters.to?`	`Buffer`

Returns

Promise<default[]>

Defined in

src/peer.ts:587

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:526

getMempool

▸ getMempool(): Promise<Buffer[]>

Returns

Promise<Buffer[]>

Defined in

src/peer.ts:629

getMempoolTransactions

▸ getMempoolTransactions(): Promise<default[]>

Returns

Promise<default[]>

Defined in

src/peer.ts:636

getPeerAddresses

▸ getPeerAddresses(timeoutSeconds?): Promise<NetAddress[]>

Parameters

Name	Type
`timeoutSeconds`	`number`

Returns

Promise<NetAddress[]>

Defined in

src/peer.ts:860

getRawDSProof

▸ getRawDSProof(dspId): Promise<Buffer>

Parameters

Name	Type
`dspId`	`Buffer`

Returns

Promise<Buffer>

Defined in

src/peer.ts:818

getRawDSProofs

▸ getRawDSProofs(dspIds): Promise<Buffer[]>

Parameters

Name	Type
`dspIds`	`Buffer`[]

Returns

Promise<Buffer[]>

Defined in

src/peer.ts:802

getRawTransaction

▸ getRawTransaction(txHash): Promise<Buffer>

Parameters

Name	Type
`txHash`	`Buffer`

Returns

Promise<Buffer>

Defined in

src/peer.ts:704

getRawTransactions

▸ getRawTransactions(txHashes): Promise<Buffer[]>

Parameters

Name	Type
`txHashes`	`Buffer`[]

Returns

Promise<Buffer[]>

Defined in

src/peer.ts:688

getTransaction

▸ getTransaction(txHash): Promise<default>

Parameters

Name	Type
`txHash`	`Buffer`

Returns

Promise<default>

Defined in

src/peer.ts:714

getTransactions

▸ getTransactions(txHashes): Promise<default[]>

Parameters

Name	Type
`txHashes`	`Buffer`[]

Returns

Promise<default[]>

Defined in

src/peer.ts:709

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:616

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:539

off

▸ off(eventName, listener): Peer

Alias for emitter.removeListener().

Since

v10.0.0

Parameters

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

Returns

Peer

Inherited from

EventEmitter.off

Defined in

node_modules/@types/node/ts4.8/events.d.ts:499

on

▸ on(eventName, listener): Peer

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

Peer

Inherited from

EventEmitter.on

Defined in

node_modules/@types/node/ts4.8/events.d.ts:385

once

▸ once(eventName, listener): Peer

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

Peer

Inherited from

EventEmitter.once

Defined in

node_modules/@types/node/ts4.8/events.d.ts:414

ping

▸ ping(timeoutSeconds?): Promise<number>

Parameters

Name	Type	Default value
`timeoutSeconds`	`number`	`30`

Returns

Promise<number>

Defined in

src/peer.ts:866

prependListener

▸ prependListener(eventName, listener): Peer

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

Peer

Inherited from

EventEmitter.prependListener

Defined in

node_modules/@types/node/ts4.8/events.d.ts:634

prependOnceListener

▸ prependOnceListener(eventName, listener): Peer

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

Peer

Inherited from

EventEmitter.prependOnceListener

Defined in

node_modules/@types/node/ts4.8/events.d.ts:650

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:569

readMessage

▸ readMessage(buffer): void

Parameters

Name	Type
`buffer`	`Buffer`

Returns

void

Defined in

src/peer.ts:247

removeAllListeners

▸ removeAllListeners(event?): Peer

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

Peer

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/@types/node/ts4.8/events.d.ts:510

removeListener

▸ removeListener(eventName, listener): Peer

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

Peer

Inherited from

EventEmitter.removeListener

Defined in

node_modules/@types/node/ts4.8/events.d.ts:494

sendMessage

▸ sendMessage(command, payload, force?): void

Parameters

Name	Type	Default value
`command`	`string`	`undefined`
`payload`	`null` \| `Buffer`	`undefined`
`force`	`boolean`	`false`

Returns

void

Defined in

src/peer.ts:158

setMaxListeners

▸ setMaxListeners(n): Peer

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

Peer

Inherited from

EventEmitter.setMaxListeners

Defined in

node_modules/@types/node/ts4.8/events.d.ts:520

setupKeepAlive

▸ setupKeepAlive(): void

Returns

void

Defined in

src/peer.ts:133

streamBlock

▸ streamBlock(chunk): void

Parameters

Name	Type
`chunk`	`Buffer`

Returns

void

Defined in

src/peer.ts:175

watchAddressTransactions

▸ watchAddressTransactions(cashaddr, callback): CancelWatch

Parameters

Name	Type
`cashaddr`	`string`
`callback`	(`transaction`: `default`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:780

watchDSProofIds

▸ watchDSProofIds(callback): CancelWatch

Parameters

Name	Type
`callback`	(`dspId`: `Buffer`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:833

watchDSProofs

▸ watchDSProofs(callback): CancelWatch

Parameters

Name	Type
`callback`	(`dsProof`: `default`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:850

watchMempoolRawTransactions

▸ watchMempoolRawTransactions(callback): CancelWatch

Parameters

Name	Type
`callback`	(`rawTransaction`: `Buffer`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:760

watchMempoolTransactionHashes

▸ watchMempoolTransactionHashes(callback): CancelWatch

Parameters

Name	Type
`callback`	(`txHash`: `Buffer`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:753

watchMempoolTransactions

▸ watchMempoolTransactions(callback): CancelWatch

Parameters

Name	Type
`callback`	(`transaction`: `default`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:770

watchNewBlocks

▸ watchNewBlocks(callback): CancelWatch

Parameters

Name	Type
`callback`	(`blockHash`: `Buffer`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:746

watchRawDSProofs

▸ watchRawDSProofs(callback): CancelWatch

Parameters

Name	Type
`callback`	(`rawDsProof`: `Buffer`) => `void`

Returns

CancelWatch

Defined in

src/peer.ts:840

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, v14.17.0

Parameters

Name	Type
`emitter`	`EventEmitter` \| `_DOMEventTarget`
`name`	`string` \| `symbol`

Returns

Function[]

Inherited from

EventEmitter.getEventListeners

Defined in

node_modules/@types/node/ts4.8/events.d.ts:299

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:271

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:254

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

Defined in

node_modules/@types/node/ts4.8/events.d.ts:194

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

Parameters

Name	Type
`emitter`	`_DOMEventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Inherited from

EventEmitter.once

Defined in

node_modules/@types/node/ts4.8/events.d.ts:195

setMaxListeners

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

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

Inherited from

EventEmitter.setMaxListeners

Defined in

node_modules/@types/node/ts4.8/events.d.ts:317

Files

Peer.md

Latest commit

History

Peer.md

File metadata and controls

Class: Peer

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters

Overrides

Defined in

Properties

DEBUG_LOG

Defined in

autoReconnect

Defined in

autoReconnectWait

Defined in

buffers

Type declaration

Defined in

connectOptions

Defined in

connected

Defined in

disableExtmsg

Defined in

disconnects

Defined in

emitter

Defined in

extmsg

Defined in

keepAliveTimer

Defined in

listenRelay

Defined in

magic

Defined in

nextInvIsMessageResponse

Defined in

node

Defined in

peerVersion

Type declaration

Defined in

pingInterval

Defined in

port

Defined in

promiseConnect

Defined in

socket

Defined in

startHeight

Defined in

stream

Defined in

ticker

Defined in

timeoutConnect

Defined in

useSSL

Defined in

userAgent

Defined in

validate

Defined in

version

Defined in

wsProxyNode

Defined in

wsProxyPort

Defined in