IotEdgeAuthenticationProvider class
トークンの生成を iotedged に委任する AuthenticationProvider
実装を提供します。 この実装は、Azure IoT Edge でモジュール クライアントを使用する場合に使用するためのものです。
この型は SharedAccessKeyAuthenticationProvider
から継承され、_sign
メソッドを実装してオーバーライドするトークン生成部分を除き、機能的にはその型と同じです。
- Extends
継承されたプロパティ
capture |
値: ブール すべての新しい |
capture |
値: カスタム |
default |
既定では、任意の 1 つのイベントに対して最大 変更は、変更前に作成されたものも含め、すべての これはハード制限ではありません。
生成された警告は、 |
error |
このシンボルは、 このシンボルを使用してリスナーをインストールしても、 |
type |
メソッド
get |
継承されたメソッド
add |
指定された 中止信号で この API では、 より簡単に登録を解除できるように、破棄可能なメソッドを返します。
|
add |
|
emit<K>(string | symbol, Any |
イベントにリスナーがある場合は
|
event |
エミッターがリスナーを登録したイベントを一覧表示する配列を返します。 配列内の値は文字列または
|
from |
接続文字列から新しい |
get |
|
get |
このメソッドは、トランスポートによって、 |
get |
|
get |
|
get |
現在設定されているリスナーの最大量を返します。
|
listener |
指定した
|
listener |
|
listeners<K>(string | symbol) |
|
off<K>(string | symbol, (args: any[]) => void) |
|
on(Event |
イベントを反復処理する
|
on(Event |
|
on<K>(string | symbol, (args: any[]) => void) |
呼び出しをチェーンできるように、 既定では、イベント リスナーは追加された順序で呼び出されます。
|
once(Event |
このメソッドは意図的に汎用であり、EventTarget インターフェイス
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) |
呼び出しをチェーンできるように、 既定では、イベント リスナーは追加された順序で呼び出されます。
|
prepend |
呼び出しをチェーンできるように、 |
prepend |
呼び出しをチェーンできるように、 |
raw |
ラッパー (
|
remove |
すべてのリスナー、または指定した 特に、 呼び出しをチェーンできるように、 |
remove |
イベントが生成されると、出力時にそれにアタッチされているすべてのリスナーが順番に呼び出されます。 これは、最後のリスナーの実行が完了する前に、 の出力と
リスナーは内部配列を使用して管理されるため、これを呼び出すと、削除されるリスナー 後に (次の例のように) 1 つのイベントに対して 1 つの関数がハンドラーとして複数回追加された場合、
呼び出しをチェーンできるように、 |
set |
既定では、 呼び出しをチェーンできるように、 |
set |
|
set |
このメソッドを使用すると、呼び出し元は認証の更新に新しい値を設定できます。 この関数は同期的に完了しますが、アクションは非同期的に実行されます。 プロバイダーが既にトークンの更新を行っている場合 (たとえば、ネットワーク接続が確立されている場合)、この関数を呼び出すと、ほぼ即座に新しい更新が行われます。 プロトコルによっては、切断と再接続が発生する可能性があります。 ただし、更新が現在発生していない場合は、後で使用するために新しい値を保存するだけです。 |
stop() | SAS トークンへの更新に使用されるタイマーを停止します。 |
[capture |
継承されたプロパティの詳細
captureRejections
値: ブール
すべての新しい EventEmitter
オブジェクトの既定の captureRejections
オプションを変更します。
static captureRejections: boolean
プロパティ値
boolean
SharedAccessKeyAuthenticationProvider.captureRejectionsから継承
captureRejectionSymbol
値: Symbol.for('nodejs.rejection')
カスタム rejection handler
を記述する方法を参照してください。
static captureRejectionSymbol: typeof captureRejectionSymbol
プロパティ値
typeof captureRejectionSymbol
defaultMaxListeners
既定では、任意の 1 つのイベントに対して最大 10
リスナーを登録できます。 この制限は、emitter.setMaxListeners(n)
メソッドを使用して個々の EventEmitter
インスタンスに対して変更できます。 すべてのRangeError
がスローされます。
変更は、変更前に作成されたものも含め、すべてのemitter.setMaxListeners(n)
の呼び出しは引き続き events.defaultMaxListeners
よりも優先されます。
これはハード制限ではありません。
EventEmitter
インスタンスでは、より多くのリスナーを追加できますが、"EventEmitter メモリ リークの可能性" が検出されたことを示すトレース警告が stderr に出力されます。 単一の EventEmitter
の場合、emitter.getMaxListeners()
メソッドと emitter.setMaxListeners()
メソッドを使用して、この警告を一時的に回避できます。
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')
で検査でき、イベント エミッタ インスタンス、イベントの名前、アタッチされたリスナーの数をそれぞれ参照する追加の emitter
、type
、および count
プロパティを持つことになります。
その name
プロパティは 'MaxListenersExceededWarning'
に設定されます。
static defaultMaxListeners: number
プロパティ値
number
SharedAccessKeyAuthenticationProvider.defaultMaxListenersから継承
errorMonitor
このシンボルは、'error'
イベントのみを監視するためのリスナーをインストールするために使用されます。 このシンボルを使用してインストールされたリスナーは、通常の 'error'
リスナーが呼び出される前に呼び出されます。
このシンボルを使用してリスナーをインストールしても、'error'
イベントが生成された後の動作は変更されません。 そのため、通常の 'error'
リスナーがインストールされていない場合でも、プロセスはクラッシュします。
static errorMonitor: typeof errorMonitor
プロパティ値
typeof errorMonitor
sharedAccessKeyAuthenticationProvider.errorMonitor
type
type: AuthenticationType
プロパティ値
AuthenticationType
sharedAccessKeyAuthenticationProvider.type
メソッドの詳細
getTrustBundle((err?: Error, ca?: string) => void)
function getTrustBundle(callback: (err?: Error, ca?: string) => void)
パラメーター
- callback
-
(err?: Error, ca?: string) => void
継承済みメソッドの詳細
addAbortListener(AbortSignal, (event: Event) => void)
指定された signal
の abort
イベントを 1 回リッスンします。
中止信号で abort
イベントをリッスンすることは安全ではなく、信号を持つ別のサードパーティが e.stopImmediatePropagation()
を呼び出すことができるため、リソースリークにつながる可能性があります。 残念ながら、Node.js は Web 標準に違反するため、これを変更できません。 また、元の API を使用すると、リスナーの削除を忘れやすくなります。
この API では、stopImmediatePropagation
がリスナーの実行を妨げるようなイベントをリッスンすることで、これらの 2 つの問題を解決することで、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
リスナーを削除する破棄可能。
sharedAccessKeyAuthenticationProvider.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
emitter.on(eventName, listener)
のエイリアス。
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
sharedAccessKeyAuthenticationProvider.addListener
emit<K>(string | symbol, AnyRest)
eventName
という名前のイベントに登録された各リスナーを、登録された順序で同期的に呼び出し、指定された引数を各リスナーに渡します。
イベントにリスナーがある場合は true
を返します。それ以外の場合 false
返します。
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
sharedAccessKeyAuthenticationProvider.emit
eventNames()
エミッターがリスナーを登録したイベントを一覧表示する配列を返します。 配列内の値は文字列または Symbol
です。
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)[]
fromConnectionString(string, number, number)
接続文字列から新しい SharedAccessKeyAuthenticationProvider
を作成します
static function fromConnectionString(connectionString: string, tokenValidTimeInSeconds?: number, tokenRenewalMarginInSeconds?: number): SharedAccessKeyAuthenticationProvider
パラメーター
- connectionString
-
string
IoT ハブでの認証に必要なパラメーターを含むデバイス接続文字列。
- tokenValidTimeInSeconds
-
number
[省略可能]トークンが有効であるはずの秒数。
- tokenRenewalMarginInSeconds
-
number
[省略可能]SharedAccessKeyAuthenticationProvider
がトークンを更新する有効期間が終了するまでの秒数。
戻り値
sharedAccessKeyAuthenticationProvider.fromConnectionString
getDeviceCredentials()
function getDeviceCredentials(): Promise<TransportConfig>
戻り値
Promise<TransportConfig>
sharedAccessKeyAuthenticationProvider.getDeviceCredentials
getDeviceCredentials(Callback<TransportConfig>)
このメソッドは、トランスポートによって、TransportConfig
オブジェクトの形式で最新のデバイス資格情報を取得するために使用されます。
function getDeviceCredentials(callback?: Callback<TransportConfig>)
パラメーター
- callback
-
Callback<TransportConfig>
IoT ハブでの認証に使用できるエラーまたはデバイス資格情報のセットで呼び出される省略可能な関数。
sharedAccessKeyAuthenticationProvider.getDeviceCredentials
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, 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> | EventTarget, name: string | symbol): Function[]
パラメーター
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
戻り値
Function[]
sharedAccessKeyAuthenticationProvider.getEventListeners
getMaxListeners()
function getMaxListeners(): number
戻り値
number
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
現在設定されているリスナーの最大量を返します。
EventEmitter
の場合、これはエミッターでの .getMaxListeners
の呼び出しとまったく同じように動作します。
EventTarget
の場合、これはイベント ターゲットの最大イベント リスナーを取得する唯一の方法です。 1 つの 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> | EventTarget): number
パラメーター
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
戻り値
number
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
SharedAccessKeyAuthenticationProvider.listenerCountから継承
listenerCount<K>(string | symbol, Function)
eventName
という名前のイベントをリッスンしているリスナーの数を返します。
listener
指定すると、イベントのリスナーの一覧でリスナーが見つかった回数が返されます。
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
パラメーター
- eventName
-
string | symbol
リッスンするイベントの名前
- listener
-
Function
イベント ハンドラー関数
戻り値
number
SharedAccessKeyAuthenticationProvider.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[]
sharedAccessKeyAuthenticationProvider.listeners
off<K>(string | symbol, (args: any[]) => void)
emitter.removeListener()
のエイリアス。
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
sharedAccessKeyAuthenticationProvider.off
on(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterIteratorOptions)
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
が '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());
close
オプションを使用して、イテレーションを終了するイベント名の配列を指定します。
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'
static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterIteratorOptions): AsyncIterableIterator<any[]>
パラメーター
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterIteratorOptions
戻り値
AsyncIterableIterator<any[]>
emitter
によって生成 eventName
イベントを反復処理する AsyncIterator
SharedAccessKeyAuthenticationProvider.onから継承
on(EventTarget, string, StaticEventEmitterIteratorOptions)
static function on(emitter: EventTarget, eventName: string, options?: StaticEventEmitterIteratorOptions): AsyncIterableIterator<any[]>
パラメーター
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterIteratorOptions
戻り値
AsyncIterableIterator<any[]>
SharedAccessKeyAuthenticationProvider.onから継承
on<K>(string | symbol, (args: any[]) => void)
eventName
という名前のイベントのリスナー配列の末尾に listener
関数を追加します。
listener
が既に追加されているかどうかを確認するチェックは行われません。
eventName
と listener
の同じ組み合わせを渡す複数の呼び出しでは、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): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
イベントの名前。
- listener
-
(args: any[]) => void
コールバック関数
戻り値
SharedAccessKeyAuthenticationProvider.onから継承
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
EventEmitter
が特定のイベントを生成したときに満たされる Promise
を作成します。または、EventEmitter
が待機中に 'error'
を出力した場合に拒否されます。
Promise
は、指定されたイベントに出力されるすべての引数の配列で解決されます。
このメソッドは意図的に汎用であり、EventTarget インターフェイス
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()
を使用して別のイベントを待機する場合にのみ使用されます。
events.once()
を使用して 'error'
イベント自体を待機する場合は、特別な処理を行わずに他の種類のイベントとして扱われます。
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[]>
SharedAccessKeyAuthenticationProvider.onceから継承
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
パラメーター
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
戻り値
Promise<any[]>
SharedAccessKeyAuthenticationProvider.onceから継承
once<K>(string | symbol, (args: any[]) => void)
eventName
という名前のイベント 1 回限りの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): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
イベントの名前。
- listener
-
(args: any[]) => void
コールバック関数
戻り値
SharedAccessKeyAuthenticationProvider.onceから継承
prependListener<K>(string | symbol, (args: any[]) => void)
listener
が既に追加されているかどうかを確認するチェックは行われません。
eventName
と listener
の同じ組み合わせを渡す複数の呼び出しでは、listener
が複数回追加され、呼び出されます。
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
呼び出しをチェーンできるように、EventEmitter
への参照を返します。
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
イベントの名前。
- listener
-
(args: any[]) => void
コールバック関数
戻り値
sharedAccessKeyAuthenticationProvider.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
eventName
がトリガーされると、このリスナーが削除され、呼び出されます。
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
呼び出しをチェーンできるように、EventEmitter
への参照を返します。
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
イベントの名前。
- listener
-
(args: any[]) => void
コールバック関数
戻り値
sharedAccessKeyAuthenticationProvider.prependOnceListener
rawListeners<K>(string | symbol)
ラッパー (.once()
によって作成されたものなど) を含む、eventName
という名前のイベントのリスナーの配列のコピーを返します。
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[]
removeAllListeners(string | symbol)
すべてのリスナー、または指定した eventName
のリスナーを削除します。
特に、EventEmitter
インスタンスが他のコンポーネントまたはモジュール (ソケットやファイル ストリームなど) によって作成された場合に、コード内の他の場所に追加されたリスナーを削除するのは不適切な方法です。
呼び出しをチェーンできるように、EventEmitter
への参照を返します。
function removeAllListeners(eventName?: string | symbol): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
戻り値
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()
は、リスナー配列からリスナーのインスタンスを最大で 1 つ削除します。 指定した eventName
のリスナー配列に 1 つのリスナーが複数回追加されている場合は、各インスタンスを削除するために removeListener()
を複数回呼び出す必要があります。
イベントが生成されると、出力時にそれにアタッチされているすべてのリスナーが順番に呼び出されます。 これは、最後のリスナーの実行が完了する前に、 の出力と
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()
メソッドによって返されるリスナー配列のコピーを再作成する必要があることを意味します。
(次の例のように) 1 つのイベントに対して 1 つの関数がハンドラーとして複数回追加された場合、removeListener()
は最後に追加されたインスタンスを削除します。 この例では、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): IotEdgeAuthenticationProvider
パラメーター
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
sharedAccessKeyAuthenticationProvider.removeListener
setMaxListeners(number)
既定では、EventEmitter
s は、特定のイベントに対して 10
を超えるリスナーが追加された場合に警告を出力します。 これは、メモリ リークの検出に役立つ便利な既定値です。
emitter.setMaxListeners()
メソッドを使用すると、この特定の EventEmitter
インスタンスの制限を変更できます。 この値を Infinity
(または 0
) に設定すると、リスナーの数に制限はありません。
呼び出しをチェーンできるように、EventEmitter
への参照を返します。
function setMaxListeners(n: number): IotEdgeAuthenticationProvider
パラメーター
- n
-
number
戻り値
SharedAccessKeyAuthenticationProvider.setMaxListenersから継承
setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[])
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> | EventTarget)[])
パラメーター
- n
-
number
負以外の数値。
EventTarget
イベントあたりのリスナーの最大数。
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
SharedAccessKeyAuthenticationProvider.setMaxListenersから継承
setTokenRenewalValues(number, number)
このメソッドを使用すると、呼び出し元は認証の更新に新しい値を設定できます。
この関数は同期的に完了しますが、アクションは非同期的に実行されます。 プロバイダーが既にトークンの更新を行っている場合 (たとえば、ネットワーク接続が確立されている場合)、この関数を呼び出すと、ほぼ即座に新しい更新が行われます。 プロトコルによっては、切断と再接続が発生する可能性があります。 ただし、更新が現在発生していない場合は、後で使用するために新しい値を保存するだけです。
function setTokenRenewalValues(tokenValidTimeInSeconds: number, tokenRenewalMarginInSeconds: number)
パラメーター
- tokenValidTimeInSeconds
-
number
トークンが有効であるはずの秒数。
- tokenRenewalMarginInSeconds
-
number
SharedAccessKeyAuthenticationProvider
がトークンを更新する有効期間が終了するまでの秒数。
sharedAccessKeyAuthenticationProvider.setTokenRenewalValues
stop()
SAS トークンへの更新に使用されるタイマーを停止します。
function stop()
sharedAccessKeyAuthenticationProvider.stop
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
パラメーター
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
SharedAccessKeyAuthenticationProvider から継承。[captureRejectionSymbol]