Transport
Transport =
object
Defined in: packages/postal/src/transport.ts:45
A transport bridges postal across execution boundaries (iframes, workers, tabs).
Implementers provide send (push envelopes to the remote) and subscribe
(receive envelopes from the remote). Postal handles the wiring — echo
prevention, filtering, and local dispatch are managed internally.
Properties
Section titled “Properties”dispose()?
Section titled “dispose()?”
optionaldispose: () =>void
Defined in: packages/postal/src/transport.ts:51
Optional cleanup when the transport is removed or reset.
Returns
Section titled “Returns”void
send()
Section titled “send()”send: (
envelope,meta?) =>void
Defined in: packages/postal/src/transport.ts:47
Send an envelope to the remote side.
Parameters
Section titled “Parameters”envelope
Section titled “envelope”Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe: (
callback) => () =>void
Defined in: packages/postal/src/transport.ts:49
Listen for envelopes arriving from the remote side. Returns an unsubscribe function.
Parameters
Section titled “Parameters”callback
Section titled “callback”(envelope) => void
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void