ActorFront

3 min read · 548 words

View as Markdown

@openpolyfill/firefox-rdp

@openpolyfill/firefox-rdp / ActorFront

Class: ActorFront

Defined in: src/client.ts:44

A generic actor client: use call() or the methods proxy to invoke actor methods.

Extended by

Constructors

Constructor

new ActorFront(client, actorId): ActorFront

Defined in: src/client.ts:58

Parameters

client

FirefoxRDP

actorId

string

Returns

ActorFront

Properties

actorId

readonly actorId: string

Defined in: src/client.ts:60

api

readonly api: Record<string, (…args) => Promise<unknown>>

Defined in: src/client.ts:52

Firefox-spec positional method calls; arguments are marshalled by Arg/Option templates.

client

readonly client: FirefoxRDP

Defined in: src/client.ts:59

form

form: Params | undefined

Defined in: src/client.ts:49

Most recent actor form, when supplied by the remote actor.

methods

readonly methods: Record<string, (params?) => Promise<RDPResponse>>

Defined in: src/client.ts:50

spec?

protected optional spec?: ActorSpec

Defined in: src/client.ts:53

Accessors

specTypeName

Get Signature

get specTypeName(): string | undefined

Defined in: src/client.ts:54

Returns

string | undefined

Methods

adoptFrom()

adoptFrom(other): this

Defined in: src/client.ts:190

Preserve listeners when a generic actor is upgraded to a specialized front.

Parameters

other

ActorFront

Returns

this

call()

call(method, params?): Promise<RDPResponse>

Defined in: src/client.ts:109

Parameters

method

string

params?

Params = {String.fromCharCode(123)}{String.fromCharCode(125)}

Returns

Promise<RDPResponse>

dispatch()

dispatch(packet): void

Defined in: src/client.ts:208

Parameters

packet

RDPResponse

Returns

void

invoke()

invoke(method, …args): Promise<unknown>

Defined in: src/client.ts:92

Call the named Firefox actor method with its original positional JS signature.

Parameters

method

string

args

…unknown[]

Returns

Promise<unknown>

isEvent()

isEvent(packet): boolean

Defined in: src/client.ts:202

Parameters

packet

RDPResponse

Returns

boolean

listen()

listen(type, listener): this

Defined in: src/client.ts:114

Subscribe with Firefox’s native positional Front event signature.

Parameters

type

string

listener

(…args) => void

Returns

this

off()

off(type, listener): this

Defined in: src/client.ts:176

Parameters

type

string

listener

PacketListener

Returns

this

on()

on(type, listener): this

Defined in: src/client.ts:168

Parameters

type

string

listener

PacketListener

Returns

this

once()

once(type, listener): this

Defined in: src/client.ts:181

Parameters

type

string

listener

PacketListener

Returns

this

registerEvents()

registerEvents(…types): this

Defined in: src/client.ts:163

Mark event packet types explicitly, even if no listener is currently attached.

Parameters

types

…string[]

Returns

this

unlisten()

unlisten(type, listener): this

Defined in: src/client.ts:122

Parameters

type

string

listener

(…args) => void

Returns

this

useSpec()

useSpec(spec): this

Defined in: src/client.ts:85

Attach an actor spec to enable schema-based calls and automatic event routing.

Parameters

spec

ActorSpec

Returns

this

waitFor()

waitFor(type, options?): Promise<RDPResponse>

Defined in: src/client.ts:128

Await one event, optionally with cancellation and timeout.

Parameters

type

string

options?

signal?

AbortSignal

timeoutMs?

number

Returns

Promise<RDPResponse>