Type guards

Functions

assertEmitTransport()

function assertEmitTransport(transport: Transport): asserts transport is EmitTransport

Defined in: utils/type-guards.ts:205

Parameters

transport

Transport

Returns

asserts transport is EmitTransport

assertReceiveTransport()

function assertReceiveTransport(transport: Transport): asserts transport is ReceiveTransport

Defined in: utils/type-guards.ts:219

Parameters

transport

Transport

Returns

asserts transport is ReceiveTransport

instanceOfAny()

function instanceOfAny(value: unknown, ctors: readonly (AnyConstructor | undefined)[]): boolean

Defined in: utils/type-guards.ts:93

True if value is an instance of any of the given constructors. Tolerates undefined entries (constructors missing on this platform).

Parameters

value

unknown

ctors

readonly (AnyConstructor | undefined)[]

Returns

boolean

isCustomEmitTransport()

function isCustomEmitTransport(value: unknown): value is CustomEmitTransport

Defined in: utils/type-guards.ts:232

Parameters

value

unknown

Returns

value is CustomEmitTransport

isCustomReceiveTransport()

function isCustomReceiveTransport(value: unknown): value is CustomReceiveTransport

Defined in: utils/type-guards.ts:238

Parameters

value

unknown

Returns

value is CustomReceiveTransport

isCustomTransport()

function isCustomTransport(value: unknown): value is CustomTransport

Defined in: utils/type-guards.ts:244

Parameters

value

unknown

Returns

value is CustomTransport

isDedicatedWorker()

function isDedicatedWorker(value: unknown): value is DedicatedWorkerGlobalScopeLike

Defined in: utils/type-guards.ts:76

Parameters

value

unknown

Returns

value is DedicatedWorkerGlobalScopeLike

isEmitJsonOnlyTransport()

function isEmitJsonOnlyTransport(value: unknown): value is EmitJsonPlatformTransport

Defined in: utils/type-guards.ts:177

Parameters

value

unknown

Returns

value is EmitJsonPlatformTransport

isEmitTransport()

function isEmitTransport(value: unknown): value is EmitTransport

Defined in: utils/type-guards.ts:195

Parameters

value

unknown

Returns

value is EmitTransport

isJsonOnlyTransport()

function isJsonOnlyTransport(
  value: unknown,
): value is WebSocket | WebExtPort | WebExtRuntime | WebExtEvent<(args: any[]) => any>

Defined in: utils/type-guards.ts:190

Parameters

value

unknown

Returns

value is WebSocket | WebExtPort | WebExtRuntime | WebExtEvent<(args: any[]) => any>

isOsraMessage()

function isOsraMessage(value: unknown): value is Message

Defined in: utils/type-guards.ts:83

Parameters

value

unknown

Returns

value is Message

isReceiveJsonOnlyTransport()

function isReceiveJsonOnlyTransport(value: unknown): value is ReceiveJsonPlatformTransport

Defined in: utils/type-guards.ts:182

Parameters

value

unknown

Returns

value is ReceiveJsonPlatformTransport

isReceiveTransport()

function isReceiveTransport(value: unknown): value is ReceiveTransport

Defined in: utils/type-guards.ts:209

Parameters

value

unknown

Returns

value is ReceiveTransport

isServiceWorker()

function isServiceWorker(value: unknown): value is ServiceWorker

Defined in: utils/type-guards.ts:70

Parameters

value

unknown

Returns

value is ServiceWorker

isServiceWorkerContainer()

function isServiceWorkerContainer(value: unknown): value is ServiceWorkerContainer

Defined in: utils/type-guards.ts:69

Parameters

value

unknown

Returns

value is ServiceWorkerContainer

isSharedArrayBuffer()

function isSharedArrayBuffer(value: unknown): boolean

Defined in: utils/type-guards.ts:102

Parameters

value

unknown

Returns

boolean

isSharedWorker()

function isSharedWorker(value: unknown): value is SharedWorker

Defined in: utils/type-guards.ts:80

Parameters

value

unknown

Returns

value is SharedWorker

isTransferable()

function isTransferable(value: unknown): value is Transferable

Defined in: utils/type-guards.ts:106

Parameters

value

unknown

Returns

value is Transferable

isTransport()

function isTransport(value: unknown): value is Transport

Defined in: utils/type-guards.ts:248

Parameters

value

unknown

Returns

value is Transport

isTypedArray()

function isTypedArray(value: unknown): value is TypedArray

Defined in: utils/type-guards.ts:66

Parameters

value

unknown

Returns

value is TypedArray

isWebExtensionOnConnect()

function isWebExtensionOnConnect(value: unknown): value is WebExtEvent<(args: any[]) => any>

Defined in: utils/type-guards.ts:151

Parameters

value

unknown

Returns

value is WebExtEvent<(args: any[]) => any>

isWebExtensionOnMessage()

function isWebExtensionOnMessage(value: unknown): value is WebExtEvent<(args: any[]) => any>

Defined in: utils/type-guards.ts:157

Parameters

value

unknown

Returns

value is WebExtEvent<(args: any[]) => any>

isWebExtensionPort()

function isWebExtensionPort(value: unknown, connectPort?: boolean): value is WebExtPort

Defined in: utils/type-guards.ts:133

Parameters

value

unknown

connectPort?

boolean = false

Returns

value is WebExtPort

isWebExtensionRuntime()

function isWebExtensionRuntime(value: unknown): value is WebExtRuntime

Defined in: utils/type-guards.ts:127

Parameters

value

unknown

Returns

value is WebExtRuntime

isWebSocket()

function isWebSocket(value: unknown): value is WebSocket

Defined in: utils/type-guards.ts:68

Parameters

value

unknown

Returns

value is WebSocket

isWindow()

function isWindow(value: unknown): value is Window

Defined in: utils/type-guards.ts:160

Parameters

value

unknown

Returns

value is Window

isWorker()

function isWorker(value: unknown): value is Worker

Defined in: utils/type-guards.ts:71

Parameters

value

unknown

Returns

value is Worker

typedArrayToType()

function typedArrayToType(
  value: TypedArray,
):
  | 'Int8Array'
  | 'Uint8Array'
  | 'Uint8ClampedArray'
  | 'Int16Array'
  | 'Uint16Array'
  | 'Int32Array'
  | 'Uint32Array'
  | 'Float16Array'
  | 'Float32Array'
  | 'Float64Array'
  | 'BigInt64Array'
  | 'BigUint64Array'

Defined in: utils/type-guards.ts:50

Parameters

value

TypedArray

Returns

typedArrayTypeToTypedArrayConstructor()

function typedArrayTypeToTypedArrayConstructor(
  value:
    | 'Int8Array'
    | 'Uint8Array'
    | 'Uint8ClampedArray'
    | 'Int16Array'
    | 'Uint16Array'
    | 'Int32Array'
    | 'Uint32Array'
    | 'Float16Array'
    | 'Float32Array'
    | 'Float64Array'
    | 'BigInt64Array'
    | 'BigUint64Array',
): TypedArrayConstructor

Defined in: utils/type-guards.ts:60

Parameters

value

Returns

TypedArrayConstructor

Type Aliases

DedicatedWorkerGlobalScopeLike

type DedicatedWorkerGlobalScopeLike = typeof globalThis & {
  name: string
  postMessage: (message: unknown, transfer?: Transferable[]) => void
}

Defined in: utils/type-guards.ts:72

Type Declaration

name

name: string

postMessage

(message: unknown, transfer?: Transferable[]) => void

IsJsonOnlyTransport

type IsJsonOnlyTransport<T> = T extends JsonPlatformTransport ? true : false

Defined in: utils/type-guards.ts:189

Type Parameters

T

T extends Transport

TypedArray

type TypedArray = InstanceType<TypedArrayConstructor>

Defined in: utils/type-guards.ts:46

TypedArrayConstructor

type TypedArrayConstructor = NonNullable<(typeof typedArrayConstructorsByName)[TypedArrayType]>

Defined in: utils/type-guards.ts:45

TypedArrayType

type TypedArrayType = keyof typeof typedArrayConstructorsByName

Defined in: utils/type-guards.ts:44

WebExtEvent

type WebExtEvent<TListener> = {
  addListener: void
  hasListener: boolean
  removeListener: void
}

Defined in: utils/webext-types.ts:21

The three members osra uses on an extension event (runtime.onMessage, port.onDisconnect, …).

Type Parameters

TListener

TListener extends (…args: any[]) => any = (…args: any[]) => any

Methods

addListener()

addListener(listener: TListener, ...rest: any[]): void;

Defined in: utils/webext-types.ts:22

Parameters

listener

TListener

rest

…any[]

Returns

void

hasListener()

hasListener(listener: TListener): boolean;

Defined in: utils/webext-types.ts:24

Parameters

listener

TListener

Returns

boolean

removeListener()

removeListener(listener: TListener): void;

Defined in: utils/webext-types.ts:23

Parameters

listener

TListener

Returns

void

WebExtGlobal

type WebExtGlobal = {
  runtime?: WebExtRuntime
}

Defined in: utils/webext-types.ts:69

The browser / chrome global, as much of it as osra looks at.

Properties

runtime?

optional runtime?: WebExtRuntime;

Defined in: utils/webext-types.ts:70

WebExtOnConnect

type WebExtOnConnect = WebExtRuntime['onConnect']

Defined in: utils/webext-types.ts:65

WebExtOnMessage

type WebExtOnMessage = WebExtRuntime['onMessage']

Defined in: utils/webext-types.ts:66

WebExtPort

type WebExtPort = {
  name: string
  onDisconnect: WebExtEvent
  onMessage: WebExtEvent
  sender?: WebExtSender
  disconnect: void
  postMessage: void
}

Defined in: utils/webext-types.ts:47

Methods

disconnect()

disconnect(): void;

Defined in: utils/webext-types.ts:50

Returns

void

postMessage()

postMessage(message: any): void;

Defined in: utils/webext-types.ts:51

Parameters

message

any

Returns

void

Properties

name

name: string

Defined in: utils/webext-types.ts:48

onDisconnect

onDisconnect: WebExtEvent

Defined in: utils/webext-types.ts:53

onMessage

onMessage: WebExtEvent

Defined in: utils/webext-types.ts:52

sender?

optional sender?: WebExtSender;

Defined in: utils/webext-types.ts:49

WebExtRuntime

type WebExtRuntime = {
  id?: string
  onConnect: WebExtEvent
  onConnectExternal?: WebExtEvent
  onMessage: WebExtEvent
  connect: WebExtPort
  sendMessage: any
}

Defined in: utils/webext-types.ts:56

Methods

connect()

connect(...args: any[]): WebExtPort;

Defined in: utils/webext-types.ts:58

Parameters

args

…any[]

Returns

WebExtPort

sendMessage()

sendMessage(...args: any[]): any;

Defined in: utils/webext-types.ts:59

Parameters

args

…any[]

Returns

any

Properties

id?

optional id?: string;

Defined in: utils/webext-types.ts:57

onConnect

onConnect: WebExtEvent

Defined in: utils/webext-types.ts:61

onConnectExternal?

optional onConnectExternal?: WebExtEvent;

Defined in: utils/webext-types.ts:62

onMessage

onMessage: WebExtEvent

Defined in: utils/webext-types.ts:60

WebExtSender

type WebExtSender = {
  documentId?: string
  frameId?: number
  id?: string
  origin?: string
  tab?: {
    active?: boolean
    id?: number
    index?: number
    title?: string
    url?: string
    windowId?: number
  }
  tlsChannelId?: string
  url?: string
}

Defined in: utils/webext-types.ts:30

Who a message came from, as the browser reported it. osra never builds one, it only hands the browser’s own object through to your code, so the fields are all optional and the engine may carry more than these.

Properties

documentId?

optional documentId?: string;

Defined in: utils/webext-types.ts:35

frameId?

optional frameId?: number;

Defined in: utils/webext-types.ts:34

id?

optional id?: string;

Defined in: utils/webext-types.ts:31

origin?

optional origin?: string;

Defined in: utils/webext-types.ts:33

tab?

optional tab?: {
  active?: boolean;
  id?: number;
  index?: number;
  title?: string;
  url?: string;
  windowId?: number;
};

Defined in: utils/webext-types.ts:37

active?

optional active?: boolean;

id?

optional id?: number;

index?

optional index?: number;

title?

optional title?: string;

url?

optional url?: string;

windowId?

optional windowId?: number;

tlsChannelId?

optional tlsChannelId?: string;

Defined in: utils/webext-types.ts:36

url?

optional url?: string;

Defined in: utils/webext-types.ts:32