ModuleClient class

  • 참조
패키지:
azure-iot-device

디바이스를 Azure IoT Hub에 연결하는 데 사용되는 디바이스 클라이언트를 IoT Hub.

SDK 사용자는 ConnectionString 또는SharedAccessSignature에서 팩터리 메서드 중 하나를 호출하여 IoT Hub 디바이스 클라이언트를 만들어야 합니다.

Extends

InternalClient

상속된 속성

captureRejections

값: 부울

모든 새 EventEmitter 개체에 대한 기본 captureRejections 옵션을 변경합니다.
captureRejectionSymbol

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

사용자 지정 rejection handler를 작성하는 방법을 참조하세요.
defaultMaxListeners

기본적으로 모든 단일 이벤트에 대해 최대 10 수신기를 등록할 수 있습니다. 메서드를 사용하여 emitter.setMaxListeners(n) 개별 EventEmitter 인스턴스에 대해 이 제한을 변경할 수 있습니다. 모든EventEmitter 인스턴스의 기본값을 events.defaultMaxListeners변경하려면 속성을 사용할 수 있습니다. 이 값이 양수가 아니면 이 RangeErrorthrow됩니다.

를 설정할 events.defaultMaxListeners 때는 변경 내용이 변경되기 전에 만든 인스턴스를 포함하여 모든EventEmitter 인스턴스에 영향을 주므로 주의해야 합니다. 그러나 호출 emitter.setMaxListeners(n) 은 여전히 보다 events.defaultMaxListeners우선합니다.

이것은 하드 제한이 아닙니다. EventEmitter instance 더 많은 수신기를 추가할 수 있지만 "가능한 EventEmitter 메모리 누수"가 검색되었음을 나타내는 추적 경고를 stderr에 출력합니다. 모든 단일EventEmitter의 경우 및 emitter.setMaxListeners()메서드를 emitter.getMaxListeners() 사용하여 이 경고를 일시적으로 방지할 수 있습니다.

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));
});

명령줄 플래그를 --trace-warnings 사용하여 이러한 경고에 대한 스택 추적을 표시할 수 있습니다.

내보낸 경고는 를 사용하여 process.on('warning') 검사할 수 있으며 이벤트 송신기 instance, 이벤트의 이름 및 count 연결된 수신기 수를 각각 참조하는 추가 emitter, type및 속성이 있습니다. 해당 name 속성은 로 설정됩니다 'MaxListenersExceededWarning'.
errorMonitor

이 기호는 모니터링 이벤트에 대해서만 수신기를 설치하는 'error'데 사용됩니다. 이 기호를 사용하여 설치된 수신기는 일반'error' 수신기가 호출되기 전에 호출됩니다.

이 기호를 사용하여 수신기를 설치해도 이벤트가 내보내지면'error' 동작이 변경되지 않습니다. 따라서 일반 'error' 수신기가 설치되지 않은 경우에도 프로세스가 중단됩니다.

메서드

close()
close(Callback<Disconnected>)

전송 연결을 닫고 클라이언트 리소스를 삭제합니다.

참고: 이 메서드를 호출한 후에는 ModuleClient 개체를 다시 사용할 수 없습니다.
fromAuthenticationProvider(AuthenticationProvider, any)

지정된 인증 방법에서 지정된 전송 형식을 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.
fromConnectionString(string, any)

지정된 전송 유형을 사용하여 지정된 연결 문자열 IoT Hub 디바이스 클라이언트를 만듭니다.
fromEnvironment(any)
fromEnvironment(any, Callback<ModuleClient>)

환경의 구성 정보를 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.

또는 IotHubConnectionString 라는 EdgeHubConnectionString 환경 변수가 있는 경우 해당 값이 사용되고 동작은 전달을 호출하는 fromConnectionString 것과 동일합니다. 이러한 환경 변수가 없으면 다음 변수를 정의해야 합니다.

- IOTEDGE_WORKLOADURI          URI for iotedged's workload API
- IOTEDGE_DEVICEID             Device identifier
- IOTEDGE_MODULEID             Module identifier
- IOTEDGE_MODULEGENERATIONID   Module generation identifier
- IOTEDGE_IOTHUBHOSTNAME       IoT Hub host name
- IOTEDGE_AUTHSCHEME           Authentication scheme to use; must be "sasToken"
fromSharedAccessSignature(string, any)

지정된 전송 형식을 사용하여 지정된 공유 액세스 서명에서 IoT Hub 모듈 클라이언트를 만듭니다.
invokeMethod(string, MethodParams)
invokeMethod(string, MethodParams, Callback<MethodResult>)

다운스트림 디바이스 또는 동일한 IoTEdge 디바이스의 다른 모듈에서 메서드를 호출합니다. 이 기능은 모듈이 IoTEdge 디바이스의 일부로 실행되는 경우에만 작동합니다.
invokeMethod(string, string, MethodParams)
invokeMethod(string, string, MethodParams, Callback<MethodResult>)
onMethod(string, DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

라는 methodName메서드에 대한 콜백을 등록합니다.
sendOutputEvent(string, Message)
sendOutputEvent(string, Message, Callback<MessageEnqueued>)

지정된 모듈 출력에 이벤트를 보냅니다.
sendOutputEventBatch(string, Message[])
sendOutputEventBatch(string, Message[], Callback<MessageEnqueued>)

지정된 모듈 출력에 이벤트 배열을 보냅니다.
setOptions(DeviceClientOptions)
setOptions(DeviceClientOptions, Callback<TransportConfigured>)

전송을 구성하는 데 사용할 수 있는 개체에 옵션을 ModuleClient 전달합니다.

상속된 메서드

abandon(Message)
abandon(Message, Callback<MessageAbandoned>)
addAbortListener(AbortSignal, (event: Event) => void)

제공된 signal의 abort 이벤트를 한 번 수신 대기합니다.

중단 신호에서 abort 이벤트를 수신 대기하는 것은 안전하지 않으며 신호를 가진 다른 타사에서 를 호출 e.stopImmediatePropagation()할 수 있으므로 리소스 누수로 이어질 수 있습니다. 불행히도 Node.js 웹 표준을 위반하기 때문에 이를 변경할 수 없습니다. 또한 원래 API를 사용하면 수신기를 쉽게 제거할 수 있습니다.

이 API를 사용하면 수신기가 실행되지 않도록 이벤트를 stopImmediatePropagation 수신 대기하여 이러한 두 가지 문제를 해결하여 Node.js API에서 를 안전하게 사용할 AbortSignal수 있습니다.

더 쉽게 구독을 취소할 수 있도록 삭제 가능한 을 반환합니다.

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]();
  }
}
addListener<K>(string | symbol, (args: any[]) => void)

의 별칭입니다 emitter.on(eventName, listener).
complete(Message)
complete(Message, Callback<MessageCompleted>)
emit<K>(string | symbol, AnyRest)

등록된 순서대로 라는eventName 이벤트에 등록된 각 수신기를 동기적으로 호출하여 제공된 인수를 각각에 전달합니다.

이벤트에 수신기가 있으면 를 반환하고, false 그렇지 않으면 를 반환 true 합니다.

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

방출기가 수신기를 등록한 이벤트를 나열하는 배열을 반환합니다. 배열의 값은 문자열 또는 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) ]
getEventListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget, string | symbol)

라는 eventName이벤트에 대한 수신기 배열의 복사본을 반환합니다.

의 경우 EventEmitter이 동작은 방출기에서 를 호출하는 .listeners 것과 정확히 동일합니다.

이는 EventTarget이벤트 대상에 대한 이벤트 수신기를 가져오는 유일한 방법입니다. 디버깅 및 진단 용도로 유용합니다.

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] ]
}
getMaxListeners()

에 의해 EventEmitteremitter.setMaxListeners(n) 설정되거나 defaultMaxListeners로 설정된 의 현재 최대 수신기 값을 반환합니다.
getMaxListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget)

현재 설정된 최대 수신기 양을 반환합니다.

의 경우 EventEmitter이 동작은 방출기에서 를 호출하는 .getMaxListeners 것과 정확히 동일합니다.

이는 EventTarget이벤트 대상에 대한 최대 이벤트 수신기를 가져오는 유일한 방법입니다. 단일 EventTarget의 이벤트 처리기 수가 최대 집합을 초과하면 EventTarget은 경고를 출력합니다.

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
}
getTwin()
getTwin(Callback<Twin>)
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

지정된 emitter에 등록된 의 eventName수신기 수를 반환하는 클래스 메서드입니다.

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

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
listenerCount<K>(string | symbol, Function)

라는 eventName이벤트를 수신 대기하는 수신기 수를 반환합니다. 가 제공되면 listener 이벤트 수신기 목록에서 수신기가 발견된 횟수를 반환합니다.
listeners<K>(string | symbol)

라는 eventName이벤트에 대한 수신기 배열의 복사본을 반환합니다.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
off<K>(string | symbol, (args: any[]) => void)

의 별칭입니다 emitter.removeListener().
on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 
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

AsyncIterator 이벤트를 반복하는 을 반환합니다eventName. 가 를 내보내면 EventEmitter throw됩니다 'error'. 루프를 종료할 때 모든 수신기를 제거합니다. 각 반복에서 반환되는 는 value 내보낸 이벤트 인수로 구성된 배열입니다.

을 AbortSignal 사용하여 이벤트 대기를 취소할 수 있습니다.

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());
on<K>(string | symbol, (args: any[]) => void)

listener 라는 eventName이벤트에 대한 수신기 배열의 끝에 함수를 추가합니다. 가 이미 추가되었는지 확인하기 listener 위한 검사는 수행되지 않습니다. 및 listener 의 eventName동일한 조합을 전달하는 여러 호출은 listener 가 여러 번 추가되고 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

기본적으로 이벤트 수신기는 추가된 순서대로 호출됩니다. 메서드는emitter.prependListener() 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

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
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Promise 가 지정된 이벤트를 내보낸 경우 EventEmitter 처리되거나 대기하는 동안 이 내보내지면 EventEmitter 거부되는 을 'error' 만듭니다. 는 Promise 지정된 이벤트에 내보내는 모든 인수의 배열로 resolve.

이 메서드는 의도적으로 제네릭이며 특별한'error' 이벤트 의미 체계가 없고 이벤트를 수신 대기하지 않는 웹 플랫폼 EventTarget 인터페이스에서 'error' 작동합니다.

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);
}

이벤트의 특수 처리 'error' 는 가 다른 이벤트를 기다리는 데 사용되는 경우에만 사용됩니다 events.once(). 가 'error' 이벤트 자체를 기다리는 데 사용되는 경우 events.once() 특별한 처리 없이 다른 종류의 이벤트로 처리됩니다.

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

을 AbortSignal 사용하여 이벤트 대기를 취소할 수 있습니다.

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!
once(_DOMEventTarget, string, StaticEventEmitterOptions)
once<K>(string | symbol, (args: any[]) => void)

라는 eventName이벤트에 대한 일회성listener 함수를 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

기본적으로 이벤트 수신기는 추가된 순서대로 호출됩니다. 메서드는emitter.prependOnceListener() 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

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
open()
open(Callback<Connected>)
prependListener<K>(string | symbol, (args: any[]) => void)

listener 라는 eventName이벤트에 대한 수신기 배열의 시작 부분에 함수를 추가합니다. 가 이미 추가되었는지 확인하기 listener 위한 검사는 수행되지 않습니다. 및 listener 의 eventName동일한 조합을 전달하는 여러 호출은 listener 가 여러 번 추가되고 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.
prependOnceListener<K>(string | symbol, (args: any[]) => void)

라는 eventName 이벤트에 대한 일회성listener 함수를 수신기 배열의 시작 부분에 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.
rawListeners<K>(string | symbol)

모든 래퍼(예: 에서 만든 래퍼)를 포함하여 라는 eventName이벤트에 대한 수신기 배열의 복사본을 .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');
reject(Message)
reject(Message, Callback<MessageRejected>)
removeAllListeners(string | symbol)

모든 수신기 또는 지정된 eventName의 수신기를 제거합니다.

특히 일부 다른 구성 요소 또는 모듈(예: 소켓 또는 파일 스트림)에서 instance 만든 경우 EventEmitter 코드의 다른 곳에서 추가된 수신기를 제거하는 것이 좋지 않습니다.

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.
removeListener<K>(string | symbol, (args: any[]) => void)

라는eventName 이벤트의 수신기 배열에서 지정된 listener 를 제거합니다.

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

removeListener()는 수신기 배열에서 수신기의 instance 하나만 제거합니다. 단일 수신기가 지정된 eventNameremoveListener() 의 수신기 배열에 여러 번 추가된 경우 각 instance 제거하려면 여러 번 호출해야 합니다.

이벤트가 내보내지면 내보낸 시점에 연결된 모든 수신기가 순서대로 호출됩니다. 이는 내보내기 후 마지막 수신기가 실행을 완료하기 전에 또는removeListener()removeAllListeners() 호출이 진행 중에서emit() 제거되지 않음을 의미합니다. 후속 이벤트는 예상대로 동작합니다.

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

수신기는 내부 배열을 사용하여 관리되므로 이를 호출하면 수신기가 제거된 후 등록된 수신기의 위치 인덱스가 변경됩니다. 이는 수신기가 호출되는 순서에 영향을 주지 않지만 메서드에서 반환 emitter.listeners() 된 수신기 배열의 복사본을 다시 만들어야 한다는 의미입니다.

단일 함수가 단일 이벤트에 대한 처리기로 여러 번 추가된 경우(아래 예제와 같이) removeListener() 가장 최근에 추가된 instance 제거됩니다. 예제에서 수신기는 once('ping')제거됩니다.

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');

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.
sendEvent(Message)
sendEvent(Message, Callback<MessageEnqueued>)
sendEventBatch(Message[])
sendEventBatch(Message[], Callback<MessageEnqueued>)
setMaxListeners(number)

기본적으로 EventEmitter는 특정 이벤트에 대해 수신기가 추가된 경우 10 경고를 출력합니다. 이는 메모리 누수 찾기에 도움이 되는 유용한 기본값입니다. emitter.setMaxListeners() 메서드를 사용하면 이 특정 EventEmitter instance 대한 제한을 수정할 수 있습니다. 값을 (또는 0)로Infinity 설정하여 수신기 수를 제한하지 않음을 나타낼 수 있습니다.

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.
setMaxListeners(number, (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]) 
import { setMaxListeners, EventEmitter } from 'node:events';

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

setMaxListeners(5, target, emitter);
setRetryPolicy(RetryPolicy)

모든 작업에서 클라이언트가 사용하는 재시도 정책을 설정합니다. 기본값은 ExponentialBackoffWithJitter입니다.
setTransportOptions(any)
setTransportOptions(any, Callback<TransportConfigured>)
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

상속된 속성 세부 정보

captureRejections

값: 부울

모든 새 EventEmitter 개체에 대한 기본 captureRejections 옵션을 변경합니다.

static captureRejections: boolean

속성 값

boolean

상속된 From InternalClient.captureRejections

captureRejectionSymbol

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

사용자 지정 rejection handler를 작성하는 방법을 참조하세요.

static captureRejectionSymbol: typeof captureRejectionSymbol

속성 값

typeof captureRejectionSymbol

상속된 From InternalClient.captureRejectionSymbol

defaultMaxListeners

기본적으로 모든 단일 이벤트에 대해 최대 10 수신기를 등록할 수 있습니다. 메서드를 사용하여 emitter.setMaxListeners(n) 개별 EventEmitter 인스턴스에 대해 이 제한을 변경할 수 있습니다. 모든EventEmitter 인스턴스의 기본값을 events.defaultMaxListeners변경하려면 속성을 사용할 수 있습니다. 이 값이 양수가 아니면 이 RangeErrorthrow됩니다.

를 설정할 events.defaultMaxListeners 때는 변경 내용이 변경되기 전에 만든 인스턴스를 포함하여 모든EventEmitter 인스턴스에 영향을 주므로 주의해야 합니다. 그러나 호출 emitter.setMaxListeners(n) 은 여전히 보다 events.defaultMaxListeners우선합니다.

이것은 하드 제한이 아닙니다. EventEmitter instance 더 많은 수신기를 추가할 수 있지만 "가능한 EventEmitter 메모리 누수"가 검색되었음을 나타내는 추적 경고를 stderr에 출력합니다. 모든 단일EventEmitter의 경우 및 emitter.setMaxListeners()메서드를 emitter.getMaxListeners() 사용하여 이 경고를 일시적으로 방지할 수 있습니다.

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));
});

명령줄 플래그를 --trace-warnings 사용하여 이러한 경고에 대한 스택 추적을 표시할 수 있습니다.

내보낸 경고는 를 사용하여 process.on('warning') 검사할 수 있으며 이벤트 송신기 instance, 이벤트의 이름 및 count 연결된 수신기 수를 각각 참조하는 추가 emitter, type및 속성이 있습니다. 해당 name 속성은 로 설정됩니다 'MaxListenersExceededWarning'.

static defaultMaxListeners: number

속성 값

number

상속된 From InternalClient.defaultMaxListeners

errorMonitor

이 기호는 모니터링 이벤트에 대해서만 수신기를 설치하는 'error'데 사용됩니다. 이 기호를 사용하여 설치된 수신기는 일반'error' 수신기가 호출되기 전에 호출됩니다.

이 기호를 사용하여 수신기를 설치해도 이벤트가 내보내지면'error' 동작이 변경되지 않습니다. 따라서 일반 'error' 수신기가 설치되지 않은 경우에도 프로세스가 중단됩니다.

static errorMonitor: typeof errorMonitor

속성 값

typeof errorMonitor

상속된 From InternalClient.errorMonitor

메서드 세부 정보

close() 

function close(): Promise<Disconnected>

반환

Promise<Disconnected>

close(Callback<Disconnected>)

전송 연결을 닫고 클라이언트 리소스를 삭제합니다.

참고: 이 메서드를 호출한 후에는 ModuleClient 개체를 다시 사용할 수 없습니다.

function close(closeCallback?: Callback<Disconnected>)

매개 변수

closeCallback

Callback<Disconnected>

전송 연결이 끊어지고 클라이언트가 닫힌 후 호출하는 선택적 함수입니다.

fromAuthenticationProvider(AuthenticationProvider, any)

지정된 인증 방법에서 지정된 전송 형식을 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.

static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): ModuleClient

매개 변수

authenticationProvider

AuthenticationProvider

IoT Hub에 대한 인증 매개 변수를 가져오는 데 사용되는 개체입니다.

transportCtor

any

IoT Hub에 연결하는 데 사용되는 전송 프로토콜입니다.

반환

ModuleClient

fromConnectionString(string, any)

지정된 전송 유형을 사용하여 지정된 연결 문자열 IoT Hub 디바이스 클라이언트를 만듭니다.

static function fromConnectionString(connStr: string, transportCtor: any): ModuleClient

매개 변수

connStr

string

IoT Hub에 대한 "디바이스 연결" 권한을 캡슐화하는 연결 문자열.

transportCtor

any

전송 생성자입니다.

반환

ModuleClient

fromEnvironment(any) 

static function fromEnvironment(transportCtor: any): Promise<ModuleClient>

매개 변수

transportCtor

any

반환

Promise<ModuleClient>

fromEnvironment(any, Callback<ModuleClient>)

환경의 구성 정보를 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.

또는 IotHubConnectionString 라는 EdgeHubConnectionString 환경 변수가 있는 경우 해당 값이 사용되고 동작은 전달을 호출하는 fromConnectionString 것과 동일합니다. 이러한 환경 변수가 없으면 다음 변수를 정의해야 합니다.

- IOTEDGE_WORKLOADURI          URI for iotedged's workload API
- IOTEDGE_DEVICEID             Device identifier
- IOTEDGE_MODULEID             Module identifier
- IOTEDGE_MODULEGENERATIONID   Module generation identifier
- IOTEDGE_IOTHUBHOSTNAME       IoT Hub host name
- IOTEDGE_AUTHSCHEME           Authentication scheme to use; must be "sasToken"

static function fromEnvironment(transportCtor: any, callback?: Callback<ModuleClient>)

매개 변수

transportCtor

any

IoT Hub에 연결하는 데 사용되는 전송 프로토콜입니다.

callback

Callback<ModuleClient>

ModuleClient가 생성되었거나 클라이언트를 만드는 동안 오류가 발생하는 경우 호출할 선택적 콜백입니다.

fromSharedAccessSignature(string, any)

지정된 전송 형식을 사용하여 지정된 공유 액세스 서명에서 IoT Hub 모듈 클라이언트를 만듭니다.

static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): ModuleClient

매개 변수

sharedAccessSignature

string

IoT Hub에 대한 "디바이스 연결" 권한을 캡슐화하는 공유 액세스 서명입니다.

transportCtor

any

반환

ModuleClient

invokeMethod(string, MethodParams) 

function invokeMethod(deviceId: string, methodParams: MethodParams): Promise<MethodResult>

매개 변수

deviceId

string

methodParams

MethodParams

반환

Promise<MethodResult>

invokeMethod(string, MethodParams, Callback<MethodResult>)

다운스트림 디바이스 또는 동일한 IoTEdge 디바이스의 다른 모듈에서 메서드를 호출합니다. 이 기능은 모듈이 IoTEdge 디바이스의 일부로 실행되는 경우에만 작동합니다.

function invokeMethod(deviceId: string, methodParams: MethodParams, callback?: Callback<MethodResult>)

매개 변수

deviceId

string

대상 디바이스 식별자

methodParams

MethodParams

직접 메서드 호출의 매개 변수

callback

Callback<MethodResult>

Error 개체 또는 메서드 호출의 결과로 호출될 선택적 콜백입니다.

invokeMethod(string, string, MethodParams) 

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams): Promise<MethodResult>

매개 변수

deviceId

string

moduleId

string

methodParams

MethodParams

반환

Promise<MethodResult>

invokeMethod(string, string, MethodParams, Callback<MethodResult>) 

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams, callback: Callback<MethodResult>)

매개 변수

deviceId

string

moduleId

string

methodParams

MethodParams

callback

Callback<MethodResult>

onMethod(string, DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

라는 methodName메서드에 대한 콜백을 등록합니다.

function onMethod(methodName: string, callback: DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

매개 변수

methodName

string

콜백에서 처리할 메서드의 이름

callback

DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>

호출된 메서드에 대한 메서드 요청이 수신될 때마다 호출 methodName 되어야 하는 함수입니다.

sendOutputEvent(string, Message) 

function sendOutputEvent(outputName: string, message: Message): Promise<MessageEnqueued>

매개 변수

outputName

string

message
Message

반환

Promise<MessageEnqueued>

sendOutputEvent(string, Message, Callback<MessageEnqueued>)

지정된 모듈 출력에 이벤트를 보냅니다.

function sendOutputEvent(outputName: string, message: Message, callback?: Callback<MessageEnqueued>)

매개 변수

outputName

string

이벤트를 보낼 출력의 이름

message
Message

지정된 출력으로 보낼 메시지

callback

Callback<MessageEnqueued>

작업이 큐에 대기되었을 때 호출할 선택적 함수입니다.

sendOutputEventBatch(string, Message[]) 

function sendOutputEventBatch(outputName: string, messages: Message[]): Promise<MessageEnqueued>

매개 변수

outputName

string

messages

Message[]

반환

Promise<MessageEnqueued>

sendOutputEventBatch(string, Message[], Callback<MessageEnqueued>)

지정된 모듈 출력에 이벤트 배열을 보냅니다.

function sendOutputEventBatch(outputName: string, messages: Message[], callback?: Callback<MessageEnqueued>)

매개 변수

outputName

string

이벤트를 보낼 출력의 이름

messages

Message[]

callback

Callback<MessageEnqueued>

작업이 큐에 대기되었을 때 호출하는 함수입니다.

setOptions(DeviceClientOptions) 

function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>

매개 변수

options
DeviceClientOptions

반환

Promise<TransportConfigured>

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

전송을 구성하는 데 사용할 수 있는 개체에 옵션을 ModuleClient 전달합니다.

function setOptions(options: DeviceClientOptions, done?: Callback<TransportConfigured>)

매개 변수

options
DeviceClientOptions

DeviceClientOptions 개체입니다.

done

Callback<TransportConfigured>

옵션이 설정되면 호출할 선택적 콜백입니다.

상속된 메서드 세부 정보

abandon(Message) 

function abandon(message: Message): Promise<MessageAbandoned>

매개 변수

message
Message

반환

Promise<MessageAbandoned>

상속된 From InternalClient.abandon

abandon(Message, Callback<MessageAbandoned>) 

function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)

매개 변수

message
Message
abandonCallback

Callback<MessageAbandoned>

상속된 From InternalClient.abandon

addAbortListener(AbortSignal, (event: Event) => void)

제공된 signal의 abort 이벤트를 한 번 수신 대기합니다.

중단 신호에서 abort 이벤트를 수신 대기하는 것은 안전하지 않으며 신호를 가진 다른 타사에서 를 호출 e.stopImmediatePropagation()할 수 있으므로 리소스 누수로 이어질 수 있습니다. 불행히도 Node.js 웹 표준을 위반하기 때문에 이를 변경할 수 없습니다. 또한 원래 API를 사용하면 수신기를 쉽게 제거할 수 있습니다.

이 API를 사용하면 수신기가 실행되지 않도록 이벤트를 stopImmediatePropagation 수신 대기하여 이러한 두 가지 문제를 해결하여 Node.js API에서 를 안전하게 사용할 AbortSignal수 있습니다.

더 쉽게 구독을 취소할 수 있도록 삭제 가능한 을 반환합니다.

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]();
  }
}

static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable

매개 변수

signal

AbortSignal

resource

(event: Event) => void

반환

Disposable

수신기를 abort 제거하는 삭제 가능 개체입니다.

상속된 From InternalClient.addAbortListener

addListener<K>(string | symbol, (args: any[]) => void)

의 별칭입니다 emitter.on(eventName, listener).

function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

listener

(args: any[]) => void

반환

ModuleClient

상속된 From InternalClient.addListener

complete(Message) 

function complete(message: Message): Promise<MessageCompleted>

매개 변수

message
Message

반환

Promise<MessageCompleted>

상속된 From InternalClient.complete

complete(Message, Callback<MessageCompleted>) 

function complete(message: Message, completeCallback: Callback<MessageCompleted>)

매개 변수

message
Message
completeCallback

Callback<MessageCompleted>

상속된 From InternalClient.complete

emit<K>(string | symbol, AnyRest)

등록된 순서대로 라는eventName 이벤트에 등록된 각 수신기를 동기적으로 호출하여 제공된 인수를 각각에 전달합니다.

이벤트에 수신기가 있으면 를 반환하고, false 그렇지 않으면 를 반환 true 합니다.

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

function emit<K>(eventName: string | symbol, args: AnyRest): boolean

매개 변수

eventName

string | symbol

args

AnyRest

반환

boolean

상속된 From InternalClient.emit

eventNames()

방출기가 수신기를 등록한 이벤트를 나열하는 배열을 반환합니다. 배열의 값은 문자열 또는 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) ]

function eventNames(): (string | symbol)[]

반환

(string | symbol)[]

상속된 From InternalClient.eventNames

getEventListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget, string | symbol)

라는 eventName이벤트에 대한 수신기 배열의 복사본을 반환합니다.

의 경우 EventEmitter이 동작은 방출기에서 를 호출하는 .listeners 것과 정확히 동일합니다.

이는 EventTarget이벤트 대상에 대한 이벤트 수신기를 가져오는 유일한 방법입니다. 디버깅 및 진단 용도로 유용합니다.

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

static function getEventListeners(emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget, name: string | symbol): Function[]

매개 변수

emitter

EventEmitter<DefaultEventMap> | _DOMEventTarget

name

string | symbol

반환

Function[]

상속된 From InternalClient.getEventListeners

getMaxListeners()

에 의해 EventEmitteremitter.setMaxListeners(n) 설정되거나 defaultMaxListeners로 설정된 의 현재 최대 수신기 값을 반환합니다.

function getMaxListeners(): number

반환

number

상속된 From InternalClient.getMaxListeners

getMaxListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget)

현재 설정된 최대 수신기 양을 반환합니다.

의 경우 EventEmitter이 동작은 방출기에서 를 호출하는 .getMaxListeners 것과 정확히 동일합니다.

이는 EventTarget이벤트 대상에 대한 최대 이벤트 수신기를 가져오는 유일한 방법입니다. 단일 EventTarget의 이벤트 처리기 수가 최대 집합을 초과하면 EventTarget은 경고를 출력합니다.

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
}

static function getMaxListeners(emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget): number

매개 변수

emitter

EventEmitter<DefaultEventMap> | _DOMEventTarget

반환

number

상속된 From InternalClient.getMaxListeners

getTwin() 

function getTwin(): Promise<Twin>

반환

Promise<Twin>

상속된 From InternalClient.getTwin

getTwin(Callback<Twin>) 

function getTwin(done: Callback<Twin>)

매개 변수

done

Callback<Twin>

상속된 From InternalClient.getTwin

listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

경고

이 API는 이제 사용되지 않습니다.

Since v3.2.0 - Use listenerCount instead.

지정된 emitter에 등록된 의 eventName수신기 수를 반환하는 클래스 메서드입니다.

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

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

static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number

매개 변수

emitter

EventEmitter<DefaultEventMap>

쿼리할 방출기

eventName

string | symbol

이벤트 이름

반환

number

상속된 From InternalClient.listenerCount

listenerCount<K>(string | symbol, Function)

라는 eventName이벤트를 수신 대기하는 수신기 수를 반환합니다. 가 제공되면 listener 이벤트 수신기 목록에서 수신기가 발견된 횟수를 반환합니다.

function listenerCount<K>(eventName: string | symbol, listener?: Function): number

매개 변수

eventName

string | symbol

수신 대기 중인 이벤트의 이름

listener

Function

이벤트 처리기 함수

반환

number

상속된 From InternalClient.listenerCount

listeners<K>(string | symbol)

라는 eventName이벤트에 대한 수신기 배열의 복사본을 반환합니다.

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

function listeners<K>(eventName: string | symbol): Function[]

매개 변수

eventName

string | symbol

반환

Function[]

상속된 From InternalClient.listeners

off<K>(string | symbol, (args: any[]) => void)

의 별칭입니다 emitter.removeListener().

function off<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

listener

(args: any[]) => void

반환

ModuleClient

상속된 From InternalClient.off

on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 

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

AsyncIterator 이벤트를 반복하는 을 반환합니다eventName. 가 를 내보내면 EventEmitter throw됩니다 'error'. 루프를 종료할 때 모든 수신기를 제거합니다. 각 반복에서 반환되는 는 value 내보낸 이벤트 인수로 구성된 배열입니다.

을 AbortSignal 사용하여 이벤트 대기를 취소할 수 있습니다.

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

static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

매개 변수

emitter

EventEmitter<DefaultEventMap>

eventName

string

수신 대기 중인 이벤트의 이름

options

StaticEventEmitterOptions

반환

AsyncIterableIterator<any>

가 내보낸 이벤트를 반복하는 eventNameemitter

상속된 From InternalClient.on

on<K>(string | symbol, (args: any[]) => void)

listener 라는 eventName이벤트에 대한 수신기 배열의 끝에 함수를 추가합니다. 가 이미 추가되었는지 확인하기 listener 위한 검사는 수행되지 않습니다. 및 listener 의 eventName동일한 조합을 전달하는 여러 호출은 listener 가 여러 번 추가되고 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

기본적으로 이벤트 수신기는 추가된 순서대로 호출됩니다. 메서드는emitter.prependListener() 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

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

function on<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

이벤트의 이름입니다.

listener

(args: any[]) => void

콜백 함수

반환

ModuleClient

상속된 From InternalClient.on

once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Promise 가 지정된 이벤트를 내보낸 경우 EventEmitter 처리되거나 대기하는 동안 이 내보내지면 EventEmitter 거부되는 을 'error' 만듭니다. 는 Promise 지정된 이벤트에 내보내는 모든 인수의 배열로 resolve.

이 메서드는 의도적으로 제네릭이며 특별한'error' 이벤트 의미 체계가 없고 이벤트를 수신 대기하지 않는 웹 플랫폼 EventTarget 인터페이스에서 'error' 작동합니다.

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);
}

이벤트의 특수 처리 'error' 는 가 다른 이벤트를 기다리는 데 사용되는 경우에만 사용됩니다 events.once(). 가 'error' 이벤트 자체를 기다리는 데 사용되는 경우 events.once() 특별한 처리 없이 다른 종류의 이벤트로 처리됩니다.

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

을 AbortSignal 사용하여 이벤트 대기를 취소할 수 있습니다.

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!

static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>

매개 변수

emitter

EventEmitter<DefaultEventMap>

eventName

string | symbol

options

StaticEventEmitterOptions

반환

Promise<any[]>

상속된 From InternalClient.once

once(_DOMEventTarget, string, StaticEventEmitterOptions) 

static function once(emitter: _DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>

매개 변수

emitter

_DOMEventTarget

eventName

string

options

StaticEventEmitterOptions

반환

Promise<any[]>

상속된 From InternalClient.once

once<K>(string | symbol, (args: any[]) => void)

라는 eventName이벤트에 대한 일회성listener 함수를 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

기본적으로 이벤트 수신기는 추가된 순서대로 호출됩니다. 메서드는emitter.prependOnceListener() 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

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

function once<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

이벤트의 이름입니다.

listener

(args: any[]) => void

콜백 함수

반환

ModuleClient

상속된 From InternalClient.once

open() 

function open(): Promise<Connected>

반환

Promise<Connected>

상속된 From InternalClient.open

open(Callback<Connected>) 

function open(openCallback: Callback<Connected>)

매개 변수

openCallback

Callback<Connected>

상속된 From InternalClient.open

prependListener<K>(string | symbol, (args: any[]) => void)

listener 라는 eventName이벤트에 대한 수신기 배열의 시작 부분에 함수를 추가합니다. 가 이미 추가되었는지 확인하기 listener 위한 검사는 수행되지 않습니다. 및 listener 의 eventName동일한 조합을 전달하는 여러 호출은 listener 가 여러 번 추가되고 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

이벤트의 이름입니다.

listener

(args: any[]) => void

콜백 함수

반환

ModuleClient

상속된 From InternalClient.prependListener

prependOnceListener<K>(string | symbol, (args: any[]) => void)

라는 eventName 이벤트에 대한 일회성listener 함수를 수신기 배열의 시작 부분에 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

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

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

이벤트의 이름입니다.

listener

(args: any[]) => void

콜백 함수

반환

ModuleClient

상속된 From InternalClient.prependOnceListener

rawListeners<K>(string | symbol)

모든 래퍼(예: 에서 만든 래퍼)를 포함하여 라는 eventName이벤트에 대한 수신기 배열의 복사본을 .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');

function rawListeners<K>(eventName: string | symbol): Function[]

매개 변수

eventName

string | symbol

반환

Function[]

상속된 From InternalClient.rawListeners

reject(Message) 

function reject(message: Message): Promise<MessageRejected>

매개 변수

message
Message

반환

Promise<MessageRejected>

상속된 From InternalClient.reject

reject(Message, Callback<MessageRejected>) 

function reject(message: Message, rejectCallback: Callback<MessageRejected>)

매개 변수

message
Message
rejectCallback

Callback<MessageRejected>

상속된 From InternalClient.reject

removeAllListeners(string | symbol)

모든 수신기 또는 지정된 eventName의 수신기를 제거합니다.

특히 일부 다른 구성 요소 또는 모듈(예: 소켓 또는 파일 스트림)에서 instance 만든 경우 EventEmitter 코드의 다른 곳에서 추가된 수신기를 제거하는 것이 좋지 않습니다.

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

function removeAllListeners(eventName?: string | symbol): ModuleClient

매개 변수

eventName

string | symbol

반환

ModuleClient

상속된 From InternalClient.removeAllListeners

removeListener<K>(string | symbol, (args: any[]) => void)

라는eventName 이벤트의 수신기 배열에서 지정된 listener 를 제거합니다.

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

removeListener()는 수신기 배열에서 수신기의 instance 하나만 제거합니다. 단일 수신기가 지정된 eventNameremoveListener() 의 수신기 배열에 여러 번 추가된 경우 각 instance 제거하려면 여러 번 호출해야 합니다.

이벤트가 내보내지면 내보낸 시점에 연결된 모든 수신기가 순서대로 호출됩니다. 이는 내보내기 후 마지막 수신기가 실행을 완료하기 전에 또는removeListener()removeAllListeners() 호출이 진행 중에서emit() 제거되지 않음을 의미합니다. 후속 이벤트는 예상대로 동작합니다.

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

수신기는 내부 배열을 사용하여 관리되므로 이를 호출하면 수신기가 제거된 후 등록된 수신기의 위치 인덱스가 변경됩니다. 이는 수신기가 호출되는 순서에 영향을 주지 않지만 메서드에서 반환 emitter.listeners() 된 수신기 배열의 복사본을 다시 만들어야 한다는 의미입니다.

단일 함수가 단일 이벤트에 대한 처리기로 여러 번 추가된 경우(아래 예제와 같이) removeListener() 가장 최근에 추가된 instance 제거됩니다. 예제에서 수신기는 once('ping')제거됩니다.

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');

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

eventName

string | symbol

listener

(args: any[]) => void

반환

ModuleClient

상속된 From InternalClient.removeListener

sendEvent(Message) 

function sendEvent(message: Message): Promise<MessageEnqueued>

매개 변수

message
Message

반환

Promise<MessageEnqueued>

상속된 From InternalClient.sendEvent

sendEvent(Message, Callback<MessageEnqueued>) 

function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)

매개 변수

message
Message
sendEventCallback

Callback<MessageEnqueued>

상속된 From InternalClient.sendEvent

sendEventBatch(Message[]) 

function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>

매개 변수

messages

Message[]

반환

Promise<MessageEnqueued>

상속된 From InternalClient.sendEventBatch

sendEventBatch(Message[], Callback<MessageEnqueued>) 

function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)

매개 변수

messages

Message[]

sendEventBatchCallback

Callback<MessageEnqueued>

상속된 From InternalClient.sendEventBatch

setMaxListeners(number)

기본적으로 EventEmitter는 특정 이벤트에 대해 수신기가 추가된 경우 10 경고를 출력합니다. 이는 메모리 누수 찾기에 도움이 되는 유용한 기본값입니다. emitter.setMaxListeners() 메서드를 사용하면 이 특정 EventEmitter instance 대한 제한을 수정할 수 있습니다. 값을 (또는 0)로Infinity 설정하여 수신기 수를 제한하지 않음을 나타낼 수 있습니다.

호출을 연결할 수 있도록 에 대한 참조 EventEmitter를 반환합니다.

function setMaxListeners(n: number): ModuleClient

매개 변수

n

number

반환

ModuleClient

상속된 From InternalClient.setMaxListeners

setMaxListeners(number, (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]) 

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

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

setMaxListeners(5, target, emitter);

static function setMaxListeners(n?: number, eventTargets: (EventEmitter<DefaultEventMap> | _DOMEventTarget)[])

매개 변수

n

number

음수가 아닌 숫자입니다. 이벤트당 EventTarget 최대 수신기 수입니다.

eventTargets

(EventEmitter<DefaultEventMap> | _DOMEventTarget)[]

상속된 From InternalClient.setMaxListeners

setRetryPolicy(RetryPolicy)

모든 작업에서 클라이언트가 사용하는 재시도 정책을 설정합니다. 기본값은 ExponentialBackoffWithJitter입니다.

function setRetryPolicy(policy: RetryPolicy)

매개 변수

policy

RetryPolicy

{RetryPolicy} 이후의 모든 작업에 사용해야 하는 재시도 정책입니다.

상속된 From InternalClient.setRetryPolicy

setTransportOptions(any) 

function setTransportOptions(options: any): Promise<TransportConfigured>

매개 변수

options

any

반환

Promise<TransportConfigured>

상속된 From InternalClient.setTransportOptions

setTransportOptions(any, Callback<TransportConfigured>) 

function setTransportOptions(options: any, done: Callback<TransportConfigured>)

매개 변수

options

any

done

Callback<TransportConfigured>

상속된 From InternalClient.setTransportOptions

updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>) 

function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)

매개 변수

sharedAccessSignature

string

updateSasCallback

Callback<SharedAccessSignatureUpdated>

상속된 From InternalClient.updateSharedAccessSignature

[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest) 

function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)

매개 변수

error

Error

event

string | symbol

args

AnyRest

상속된 From InternalClient.__@captureRejectionSymbol@138