FirefoxRDP

11 min read · 2078 words

View as Markdown

@openpolyfill/firefox-addon-playwright-harness

@openpolyfill/firefox-addon-playwright-harness / FirefoxRDP

Interface: FirefoxRDP

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:137

External Node.js Firefox RDP client. Transport owns the stream, fronts own event declarations.

Extends

EventEmitter

Properties

dictTypes

readonly dictTypes: Record<string, Record<string, string>>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:143

greeting

readonly greeting: Promise<JsonPacket>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:144

requestTimeoutMs

readonly requestTimeoutMs: number

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:139

root

readonly root: RootFront

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:140

specs

readonly specs: Record<string, ActorSpec>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:142

Schema registry, including specs generated from a Firefox checkout.

transport

readonly transport: TcpTransport

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:138

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, …args): void

Defined in: node_modules/@types/node/events.d.ts:103

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

…AnyRest

Returns

void

Inherited from

EventEmitter.[captureRejectionSymbol]

actor()

actor(actorId): ActorFront

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:177

Parameters

actorId

string

Returns

ActorFront

addListener()

addListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:642

Alias for emitter.on(eventName, listener).

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.addListener

close()

close(): void

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:189

Returns

void

emit()

emit<K>(eventName, …args): boolean

Defined in: node_modules/@types/node/events.d.ts:904

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

K

K

Parameters

eventName

string | symbol

args

…AnyRest

Returns

boolean

Since

v0.1.26

Inherited from

EventEmitter.emit

eventNames()

eventNames(): (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

EventEmitter.eventNames

forget()

forget(actorId): void

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:179

Discard a released/destroyed actor front so its ID cannot retain stale listeners.

Parameters

actorId

string

Returns

void

fromForm()

fromForm<T>(form, typeName?): T

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:163

Turn an actor form into a tracked front and keep its form available.

Type Parameters

T

T extends ActorFront = ActorFront

Parameters

form

actor

string

typeName?

string

Returns

T

front()

Call Signature

front<K>(actorId, typeName): GeneratedFront<K>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:160

Typed, generated positional API for any actor represented in the schema registry.

Type Parameters

K

Parameters

actorId

string

typeName

K

Returns

GeneratedFront<K>

Call Signature

front(actorId, typeName): ActorFront

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:161

Typed, generated positional API for any actor represented in the schema registry.

Parameters

actorId

string

typeName

string

Returns

ActorFront

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/@types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

EventEmitter.getMaxListeners

listenerCount()

listenerCount<K>(eventName, listener?): number

Defined in: node_modules/@types/node/events.d.ts:913

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event being listened for

listener?

Function

The event handler function

Returns

number

Since

v3.2.0

Inherited from

EventEmitter.listenerCount

listeners()

listeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:832

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

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

EventEmitter.listeners

longString()

longString(grip): string | LongStringFront

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:168

Reconstitute a Firefox longstring grip into an on-demand readable object.

Parameters

grip

string | { actor: string; initial: string; length: number; }

Returns

string | LongStringFront

notify()

notify(actorId, method, params?): void

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:181

Fire-and-forget invocation for oneway methods; does not occupy a FIFO reply slot.

Parameters

actorId

string

method

string

params?

Params

Returns

void

off()

off<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:792

Alias for emitter.removeListener().

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v10.0.0

Inherited from

EventEmitter.off

on()

on<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:674

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 eventName and listener will result in the listener being added, and called, multiple times.

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

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.1.101

Inherited from

EventEmitter.on

once()

once<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:704

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

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

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.3.0

Inherited from

EventEmitter.once

prependListener()

prependListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:931

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

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

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependListener

prependOnceListener()

prependOnceListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:947

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.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependOnceListener

rawListeners()

rawListeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:863

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

EventEmitter.rawListeners

registerDictTypes()

registerDictTypes(dictTypes): void

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:156

Parameters

dictTypes

Record<string, Record<string, string>>

Returns

void

registerSpecs()

registerSpecs(specs): void

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:154

Add generated schemas (e.g. build output of scripts/generate-specs.mjs).

Parameters

specs

Record<string, ActorSpec>

Returns

void

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: node_modules/@types/node/events.d.ts:803

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.

Parameters

eventName?

string | symbol

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeAllListeners

removeListener()

removeListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:787

Removes the specified listener from the listener array for the event named eventName.

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

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeListener

request()

request(actorId, method, params?): Promise<RDPResponse>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:183

Arbitrary RDP method, with no manually composed packets at call sites.

Parameters

actorId

string

method

string

params?

Params

Returns

Promise<RDPResponse>

requestBulk()

requestBulk(actorId, type, data): Promise<RDPResponse>

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:185

Send a bulk-data request and await its actor’s next reply.

Parameters

actorId

string

type

string

data

Buffer

Returns

Promise<RDPResponse>

revive()

revive(value, type?): unknown

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:174

Convert actor-form return values to the matching managed Front.

Parameters

value

unknown

type?

string

Returns

unknown

serialize()

serialize(value, type): unknown

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:158

Encode actor fronts and fields inside Firefox dictionary types.

Parameters

value

unknown

type

string

Returns

unknown

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/@types/node/events.d.ts:813

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 to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

EventEmitter.setMaxListeners

track()

track<T>(front): T

Defined in: node_modules/@openpolyfill/firefox-rdp/dist/client.d.ts:176

Cache a specialized front so incoming notifications are dispatched to it.

Type Parameters

T

T extends ActorFront

Parameters

front

T

Returns

T