Twin class
Um Gêmeo de Dispositivo é um documento que descreve o estado de um dispositivo armazenado por um hub IoT do Azure e está disponível mesmo se o dispositivo estiver offline. É construído em torno de 3 seções:
- Tags: pares chave/valor acessíveis apenas do lado do serviço
- Propriedades desejadas: atualizadas por um serviço e recebidas pelo dispositivo
- Propriedades relatadas: atualizadas pelo dispositivo e recebidas pelo serviço.
Observe que, embora seja uma possibilidade, as propriedades desejadas e relatadas não precisam corresponder e que a lógica para sincronizar essas duas coleções, se necessário, é deixada para o usuário do SDK.
Para obter mais informações, consulte Noções básicas sobre gêmeos de dispositivo.
- Extends
-
EventEmitter
Propriedades
| desired |
|
| error |
|
| properties | Os dicionários de propriedades desejadas e relatadas (respectivamente em |
| user |
Métodos
| get() | |
| get(Callback<Twin>) | Obtém todo o gêmeo do serviço. |
Métodos Herdados
| add |
Alias para |
| emit<E>(string | symbol, any[]) | Chama de forma síncrona cada um dos ouvintes registrados para o evento chamado Retorna
|
| event |
Retorna uma matriz listando os eventos para os quais o emissor registrou ouvintes.
|
| get |
Retorna o valor máximo de ouvinte atual para o |
| listener |
Retorna o número de ouvintes ouvindo o evento chamado |
| listeners<E>(string | symbol) | Retorna uma cópia da matriz de ouvintes para o evento chamado
|
| off<E>(string | symbol, (args: any[]) => void) | Alias para |
| on<E>(string | symbol, (args: any[]) => void) | Adiciona a função
Retorna uma referência ao Por padrão, os ouvintes de eventos são invocados na ordem em que são adicionados. O método
|
| once<E>(string | symbol, (args: any[]) => void) | Adiciona uma função
Retorna uma referência ao Por padrão, os ouvintes de eventos são invocados na ordem em que são adicionados. O método
|
| prepend |
Adiciona a função
Retorna uma referência ao |
| prepend |
Adiciona uma
Retorna uma referência ao |
| raw |
Retorna uma cópia da matriz de ouvintes para o evento chamado
|
| remove |
Remove todos os ouvintes ou os do É uma má prática remover ouvintes adicionados em outro lugar no código, particularmente quando a instância Retorna uma referência ao |
| remove |
Remove o
Uma vez que um evento é emitido, todos os ouvintes ligados a ele no momento da emissão são chamados em ordem. Isto implica que quaisquer
Como os ouvintes são geridos através de um array interno, chamar isto altera os índices de posição de qualquer ouvinte registado após a remoção do ouvinte. Isso não afetará a ordem na qual os ouvintes são chamados, mas significa que todas as cópias da matriz de ouvintes retornadas pelo método Quando uma única função tiver sido adicionada como manipulador várias vezes para um único evento (como no exemplo abaixo),
Retorna uma referência ao |
| set |
Por padrão Retorna uma referência ao |
| [capture |
O
|
Detalhes de Propriedade
desiredPath
static desiredPath: string
Valor de Propriedade
string
errorEvent
static errorEvent: string
Valor de Propriedade
string
properties
Os dicionários de propriedades desejadas e relatadas (respectivamente em properties.desired e properties.reported).
properties: TwinProperties
Valor de Propriedade
userRegisteredDesiredPropertiesListener
userRegisteredDesiredPropertiesListener: boolean
Valor de Propriedade
boolean
Detalhes de Método
get()
get(Callback<Twin>)
Obtém todo o gêmeo do serviço.
function get(callback?: Callback<Twin>)
Parâmetros
- callback
-
Callback<Twin>
função opcional que deve ser chamada de volta com o gémeo ou um erro se o transporte não conseguir recuperar o gémeo.
Detalhes do Método Herdado
addListener<E>(string | symbol, (args: any[]) => void)
Alias para emitter.on(eventName, listener).
function addListener<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluções
herdado de EventEmitter.addListener
emit<E>(string | symbol, any[])
Chama de forma síncrona cada um dos ouvintes registrados para o evento chamado eventName, na ordem em que foram registrados, passando os argumentos fornecidos para cada um.
Retorna true se o evento teve ouvintes false caso contrário.
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<E>(eventName: string | symbol, args: any[]): boolean
Parâmetros
- eventName
-
string | symbol
- args
-
any[]
Devoluções
boolean
herdado de EventEmitter.emit
eventNames()
Retorna uma matriz listando os eventos para os quais o emissor registrou ouvintes.
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)[]
Devoluções
(string | symbol)[]
herdado de EventEmitter.eventNames
getMaxListeners()
Retorna o valor máximo de ouvinte atual para o EventEmitter que é definido por emitter.setMaxListeners(n) ou padrão como events.defaultMaxListeners.
function getMaxListeners(): number
Devoluções
number
herdado de EventEmitter.getMaxListeners
listenerCount<E>(string | symbol, (args: any[]) => void)
Retorna o número de ouvintes ouvindo o evento chamado eventName.
Se listener for fornecido, ele retornará quantas vezes o ouvinte é encontrado na lista dos ouvintes do evento.
function listenerCount<E>(eventName: string | symbol, listener?: (args: any[]) => void): number
Parâmetros
- eventName
-
string | symbol
O nome do evento que está sendo escutado
- listener
-
(args: any[]) => void
A função de manipulador de eventos
Devoluções
number
herdado de EventEmitter.listenerCount
listeners<E>(string | symbol)
Retorna uma cópia da matriz de ouvintes para o evento chamado eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
function listeners<E>(eventName: string | symbol): (args: any[]) => void[]
Parâmetros
- eventName
-
string | symbol
Devoluções
(args: any[]) => void[]
herdado de EventEmitter.listeners
off<E>(string | symbol, (args: any[]) => void)
Alias para emitter.removeListener().
function off<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluções
herdado de EventEmitter.off
on<E>(string | symbol, (args: any[]) => void)
Adiciona a função listener ao final da matriz de ouvintes do evento chamado eventName. Nenhuma verificação é feita para ver se o listener já foi adicionado. Várias chamadas que passam a mesma combinação de eventName e listener resultarão no listener sendo adicionado e chamado várias vezes.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
Por padrão, os ouvintes de eventos são invocados na ordem em que são adicionados. O método emitter.prependListener() pode ser usado como uma alternativa para adicionar o ouvinte de eventos ao início da matriz de ouvintes.
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<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
O nome do evento.
- listener
-
(args: any[]) => void
A função de retorno de chamada
Devoluções
herdado de EventEmitter.on
once<E>(string | symbol, (args: any[]) => void)
Adiciona uma funçãolistener única para o evento chamado eventName. Na próxima vez que eventName for acionado, esse ouvinte será removido e, em seguida, invocado.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
Por padrão, os ouvintes de eventos são invocados na ordem em que são adicionados. O método emitter.prependOnceListener() pode ser usado como uma alternativa para adicionar o ouvinte de eventos ao início da matriz de ouvintes.
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<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
O nome do evento.
- listener
-
(args: any[]) => void
A função de retorno de chamada
Devoluções
herdado de EventEmitter.once
prependListener<E>(string | symbol, (args: any[]) => void)
Adiciona a função listener já foi adicionado. Várias chamadas que passam a mesma combinação de eventName e listener resultarão no listener sendo adicionado e chamado várias vezes.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
function prependListener<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
O nome do evento.
- listener
-
(args: any[]) => void
A função de retorno de chamada
Devoluções
herdado de EventEmitter.prependListener
prependOnceListener<E>(string | symbol, (args: any[]) => void)
Adiciona uma eventName for acionado, esse ouvinte será removido e, em seguida, invocado.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
function prependOnceListener<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
O nome do evento.
- listener
-
(args: any[]) => void
A função de retorno de chamada
Devoluções
herdado de EventEmitter.prependOnceListener
rawListeners<E>(string | symbol)
Retorna uma cópia da matriz de ouvintes para o evento chamado eventName, incluindo quaisquer wrappers (como os criados por .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<E>(eventName: string | symbol): (args: any[]) => void[]
Parâmetros
- eventName
-
string | symbol
Devoluções
(args: any[]) => void[]
herdado de EventEmitter.rawListeners
removeAllListeners<E>(string | symbol)
Remove todos os ouvintes ou os do eventNameespecificado.
É uma má prática remover ouvintes adicionados em outro lugar no código, particularmente quando a instância EventEmitter foi criada por algum outro componente ou módulo (por exemplo, soquetes ou fluxos de arquivos).
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
function removeAllListeners<E>(eventName?: string | symbol): Twin
Parâmetros
- eventName
-
string | symbol
Devoluções
herdado de EventEmitter.removeAllListeners
removeListener<E>(string | symbol, (args: any[]) => void)
Remove o listener especificado da matriz de ouvinte do evento chamado eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() removerá, no máximo, uma instância de um ouvinte da matriz do ouvinte. Se qualquer ouvinte tiver sido adicionado várias vezes à matriz de ouvinte para o eventNameespecificado, removeListener() deverá ser chamado várias vezes para remover cada instância.
Uma vez que um evento é emitido, todos os ouvintes ligados a ele no momento da emissão são chamados em ordem. Isto implica que quaisquer removeListener() chamadas removeAllListeners()de ou após a emissão e antes do último ouvinte terminar a execução não as removerá do emit() processo em andamento. Os acontecimentos subsequentes comportam-se como esperado.
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
Como os ouvintes são geridos através de um array interno, chamar isto altera os índices de posição de qualquer ouvinte registado após a remoção do ouvinte. Isso não afetará a ordem na qual os ouvintes são chamados, mas significa que todas as cópias da matriz de ouvintes retornadas pelo método emitter.listeners() precisarão ser recriadas.
Quando uma única função tiver sido adicionada como manipulador várias vezes para um único evento (como no exemplo abaixo), removeListener() removerá a instância adicionada mais recentemente. No exemplo, o ouvinte once('ping') é removido:
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');
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
function removeListener<E>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parâmetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluções
herdado de EventEmitter.removeListener
setMaxListeners(number)
Por padrãoEventEmitters imprimirá um aviso se mais de 10 ouvintes forem adicionados para um evento específico. Este é um padrão útil que ajuda a encontrar vazamentos de memória. O método emitter.setMaxListeners() permite que o limite seja modificado para esta instância EventEmitter específica. O valor pode ser definido como Infinity (ou 0) para indicar um número ilimitado de ouvintes.
Retorna uma referência ao EventEmitter, para que as chamadas possam ser encadeadas.
function setMaxListeners(n: number): Twin
Parâmetros
- n
-
number
Devoluções
herdado de EventEmitter.setMaxListeners
[captureRejectionSymbol](Error, string | symbol, any[])
O Symbol.for('nodejs.rejection') método é chamado caso ocorra uma rejeição de promessa ao emitir um evento e captureRejections está ativado no emissor.
É possível usar events.captureRejectionSymbol em vez de Symbol.for('nodejs.rejection').
import { EventEmitter, captureRejectionSymbol } from 'node:events';
class MyClass extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
[captureRejectionSymbol](err, event, ...args) {
console.log('rejection happened for', event, 'with', err, ...args);
this.destroy(err);
}
destroy(err) {
// Tear the resource down here.
}
}
function [captureRejectionSymbol](error: Error, event: string | symbol, args: any[])
Parâmetros
- error
-
Error
- event
-
string | symbol
- args
-
any[]
Herdado de EventEmitter.__@captureRejectionSymbol@129