Class IframeChildIO

The generic IO contract used throughout the library. Implementations can choose to support string-only messaging or structured clone objects.

Implements

IoInterface

Index

Constructors

Properties

capabilities name

Methods

destroy read signalDestroy write

Constructors

constructor

new IframeChildIO(): IframeChildIO
Returns IframeChildIO
- Defined in src/adapters/iframe.ts:156

Properties

capabilities

capabilities: IoCapabilities = ...

name

name: string = "iframe-child-io"

Methods

destroy

destroy(): void
Clean up resources used by the IO adapter

Returns void
Implementation of IoInterface.destroy
- Defined in src/adapters/iframe.ts:226

read

read(): Promise<null | string | IoMessage>
Returns Promise<null | string | IoMessage>
Implementation of IoInterface.read
- Defined in src/adapters/iframe.ts:198

signalDestroy

signalDestroy(): void
Signal that the IO adapter should prepare for destruction

Returns void
Implementation of IoInterface.signalDestroy
- Defined in src/adapters/iframe.ts:233

write

write(message: string | IoMessage): Promise<void>
Parameters
- message: string | IoMessage
Returns Promise<void>
Implementation of IoInterface.write
- Defined in src/adapters/iframe.ts:210