Transports

Functions

checkOsraMessageKey()

function checkOsraMessageKey(message: any, key: string): message is Message

Defined in: utils/transport.ts:118

Parameters

message

any

key

string

Returns

message is Message

---

getWebExtensionGlobal()

function getWebExtensionGlobal(): WebExtGlobal | undefined

Defined in: utils/transport.ts:114

Returns

WebExtGlobal | undefined

---

getWebExtensionRuntime()

function getWebExtensionRuntime(): WebExtRuntime | undefined

Defined in: utils/transport.ts:116

Returns

WebExtRuntime | undefined

---

registerOsraMessageListener()

Guide: Low-level API

function registerOsraMessageListener(__namedParameters: {
  key?: string
  listener: (message: Message, messageContext: MessageContext) => void
  origin?: string
  remoteName?: string
  transport: ReceiveTransport
  unregisterSignal?: AbortSignal
}): void

Defined in: utils/transport.ts:131

Parameters

__namedParameters

key?

string = OSRA_DEFAULT_KEY

listener

(message: Message, messageContext: MessageContext) => void

origin?

string = '*'

remoteName?

string

transport

ReceiveTransport

unregisterSignal?

AbortSignal

Returns

void

---

sendOsraMessage()

Guide: Low-level API

function sendOsraMessage(
  transport: EmitTransport,
  message: Message,
  origin?: string,
  transferables?: Transferable[],
): void

Defined in: utils/transport.ts:221

Parameters

transport

EmitTransport

message

Message

origin?

string = '*'

transferables?

Transferable[] = []

Returns

void

Type Aliases

Context

type Context = {
  abort?: () => void
  origin?: string
  port?: MessagePort | WebExtPort
  sender?: WebExtSender
  source?: MessageEventSource | null
}

Defined in: utils/transport.ts:21

What the local side knows about the realm on the other end of a connection.

origin and source are only OBSERVABLE on window transports. A MessagePort message carries origin “” and source null, so for a port the identity has to be declared by whoever created the transport, which is the side that received the port over a trustworthy window message. That is why expose takes a context option rather than only reporting what it can see: without it, every port-based consumer would rebuild the same out-of-band handshake to learn who it is talking to.

Properties

abort?

optional abort?: () => void;

Defined in: utils/transport.ts:25

Tears down THIS connection and nothing else: the peer is sent a close, its revivables are torn down, and it stops being tracked. unregisterSignal is the whole-expose equivalent; this is the one a server reaches for when a single realm misbehaves or is finished with.

Returns

void

origin?

optional origin?: string;

Defined in: utils/transport.ts:26

port?

optional port?: MessagePort | WebExtPort;

Defined in: utils/transport.ts:28

sender?

optional sender?: WebExtSender;

Defined in: utils/transport.ts:29

source?

optional source?: MessageEventSource | null;

Defined in: utils/transport.ts:27

---

CustomEmitTransport

Guide: Custom transports

type CustomEmitTransport = Extract<
  CustomTransport,
  {
    emit: any
  }
>

Defined in: utils/transport.ts:54

---

CustomReceiveTransport

Guide: Custom transports

type CustomReceiveTransport = Extract<
  CustomTransport,
  {
    receive: any
  }
>

Defined in: utils/transport.ts:55

---

CustomTransport

Guide: Custom transports

type CustomTransport = {
  isJson?: boolean;
} &
  | {
  emit: CustomEmit;
  receive: CustomReceive;
}
  | {
  receive: CustomReceive;
}
  | {
  emit: CustomEmit;
};

Defined in: utils/transport.ts:46

Type Declaration

isJson?

optional isJson?: boolean;

---

EmitHandler

Guide: Custom transports

type EmitHandler = (message: Message, transferables?: Transferable[]) => void

Defined in: utils/transport.ts:41

Parameters

message

Message

transferables?

Transferable[]

Returns

void

---

EmitJsonPlatformTransport

type EmitJsonPlatformTransport = WebSocket | WebExtPort | WebExtRuntime

Defined in: utils/transport.ts:57

---

EmitPlatformTransport

type EmitPlatformTransport =
  | EmitJsonPlatformTransport
  | Window
  | ServiceWorker
  | Worker
  | SharedWorker
  | MessagePort
  | WorkerSelf

Defined in: utils/transport.ts:81

---

EmitTransport

type EmitTransport = EmitPlatformTransport | CustomEmitTransport

Defined in: utils/transport.ts:103

---

JsonPlatformTransport

type JsonPlatformTransport =
  | {
      isJson: true
    }
  | EmitJsonPlatformTransport
  | ReceiveJsonPlatformTransport

Defined in: utils/transport.ts:69

---

MessageContext

Guide: Low-level API

type MessageContext = {
  origin?: string
  port?: MessagePort | WebExtPort
  receiveTransport?: ReceivePlatformTransport
  sender?: WebExtSender
  source?: MessageEventSource | null
}

Defined in: utils/transport.ts:32

Properties

origin?

optional origin?: string;

Defined in: utils/transport.ts:37

port?

optional port?: MessagePort | WebExtPort;

Defined in: utils/transport.ts:33

receiveTransport?

optional receiveTransport?: ReceivePlatformTransport;

Defined in: utils/transport.ts:35

sender?

optional sender?: WebExtSender;

Defined in: utils/transport.ts:34

source?

optional source?: MessageEventSource | null;

Defined in: utils/transport.ts:36

---

PlatformTransport

Guide: Transports

type PlatformTransport = EmitPlatformTransport | ReceivePlatformTransport

Defined in: utils/transport.ts:99

---

ReceiveHandler

Guide: Custom transports

type ReceiveHandler = (
  listener: (event: Message, messageContext: MessageContext) => void,
) => void | (() => void)

Defined in: utils/transport.ts:40

Parameters

listener

(event: Message, messageContext: MessageContext) => void

Returns

void | (() => void)

---

ReceiveJsonPlatformTransport

type ReceiveJsonPlatformTransport =
  WebSocket | WebExtPort | WebExtOnConnect | WebExtOnMessage | WebExtRuntime

Defined in: utils/transport.ts:62

---

ReceivePlatformTransport

type ReceivePlatformTransport =
  | ReceiveJsonPlatformTransport
  | Window
  | ServiceWorkerContainer
  | Worker
  | SharedWorker
  | MessagePort
  | WorkerSelf

Defined in: utils/transport.ts:90

---

ReceiveTransport

type ReceiveTransport = ReceivePlatformTransport | CustomReceiveTransport

Defined in: utils/transport.ts:104

---

Transport

Guide: Transports

type Transport = PlatformTransport | CustomTransport

Defined in: utils/transport.ts:106

---

WorkerSelf

type WorkerSelf = {
  addEventListener: void
  postMessage: void
  removeEventListener: void
}

Defined in: utils/transport.ts:75

Methods

addEventListener()

addEventListener(type: string, listener: (event: any) => void): void;

Defined in: utils/transport.ts:77

Parameters

type

string

listener

(event: any) => void

Returns

void

postMessage()

postMessage(...args: any[]): void;

Defined in: utils/transport.ts:76

Parameters

args

…any[]

Returns

void

removeEventListener()

removeEventListener(type: string, listener: (event: any) => void): void;

Defined in: utils/transport.ts:78

Parameters

type

string

listener

(event: any) => void

Returns

void