Static
versionBoolean which expose the statuts of the PostMessage communication.
Boolean which expose if it's the parent frame.
Boolean which expose if it's the child frame (iframe).
Static
createSend a message into the postMessageChannel
The identifier of the message
Optional
data: {} = {}Associated data with the message
Optional
waitConnected: boolean = trueIf we delay communication and wait we are connected or not
Register an eventemmiter listener on every socket messages
Rest
...args: [event: string | symbol, fn: ((...args: any[]) => void), context?: any]Register an eventemmiter listener on one socket messages
Rest
...args: [event: string | symbol, fn: ((...args: any[]) => void), context?: any]Add a listener for a given event.
Rest
...args: any[]Optional
context: anyAdd a one-time listener for a given event.
Rest
...args: any[]Optional
context: anyRemove the listeners of a given event.
Optional
fn: ((...args: any[]) => void)Rest
...args: any[]Optional
context: anyOptional
once: booleanOptional
fn: ((...args: any[]) => void)Rest
...args: any[]Optional
context: anyOptional
once: booleanStatic
prefixedOptional
Readonly
targetReadonly
moduleReadonly
queryReadonly
eventReadonly
storeReadonly
pluginReadonly
contentReadonly
loaderReadonly
urlThe allowed URL for PostMessage communication
Readonly
dataThe dataserializer to use for parse and stringify object into PostMessage
used to unserialize data
used to serialize data
Protected
_channelChannel where everything will be broadcast
Optional
autoOptional
pluginOptional
contentGenerated using TypeDoc
PostMessageChannel class. This is an class which warp postMessage communication and allow to work with it with higher API. This have dataSerializer feature, auto-connect feature (with defer), ensure url of the target (security), send (with wait connect), listener on messages, and events for lisfecycle of postmessageChannel status