Skip to content

IFrameTransport

IFrameTransport = { destroy: () => Promise<void>; listenerRequest: RpcClient<IFrameRpcSchema, LifecycleMessage>["listen"]; request: RpcClient<IFrameRpcSchema, LifecycleMessage>["request"]; waitForConnection: Promise<boolean>; waitForSetup: Promise<void>; }

Defined in: types/transport.ts:8

IFrame transport interface

destroy: () => Promise<void>

Defined in: types/transport.ts:28

Function used to destroy the iframe transport

Promise<void>


listenerRequest: RpcClient<IFrameRpcSchema, LifecycleMessage>["listen"]

Defined in: types/transport.ts:24

Function used to listen to a request response via the iframe transport


request: RpcClient<IFrameRpcSchema, LifecycleMessage>["request"]

Defined in: types/transport.ts:20

Function used to perform a single request via the iframe transport


waitForConnection: Promise<boolean>

Defined in: types/transport.ts:12

Wait for the connection to be established


waitForSetup: Promise<void>

Defined in: types/transport.ts:16

Wait for the setup to be done