Class Coriolis

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

Hierarchy

Accessors

  • get isConnected(): boolean
  • Boolean which expose the statuts of the PostMessage communication.

    Returns

    Returns boolean

  • get isParentFrame(): boolean
  • Boolean which expose if it's the parent frame.

    Returns

    Returns boolean

  • get isChildFrame(): boolean
  • Boolean which expose if it's the child frame (iframe).

    Returns

    Returns boolean

Methods

  • Parameters

    • target: HTMLElement
    • targetUrl: string | URL
    • initialContent: string

    Returns Coriolis

  • Send a message into the postMessageChannel

    Returns

    Parameters

    • eventName: string

      The identifier of the message

    • Optional data: {} = {}

      Associated data with the message

      • Optional waitConnected: boolean = true

        If we delay communication and wait we are connected or not

      Returns void

    • Return an array listing the events for which the emitter has registered listeners.

      Returns (string | symbol)[]

    • Return the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T

      Returns ((...args: any[]) => void)[]

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

      Returns number

    • Calls each of the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Rest ...args: any[]

      Returns boolean

    • Add a listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: ((...args: any[]) => void)
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Optional context: any

      Returns Coriolis

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: ((...args: any[]) => void)
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Optional context: any

      Returns Coriolis

    • Add a one-time listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: ((...args: any[]) => void)
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Optional context: any

      Returns Coriolis

    • Remove the listeners of a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optional fn: ((...args: any[]) => void)
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Optional context: any
      • Optional once: boolean

      Returns Coriolis

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optional fn: ((...args: any[]) => void)
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Optional context: any
      • Optional once: boolean

      Returns Coriolis

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optional event: string | symbol

      Returns Coriolis

    Properties

    prefixed: string | boolean
    targetIframe?: HTMLIFrameElement
    module: ModuleLoader
    plugin: PluginModule
    content: ContentModule
    loaderUtil: LoaderUtilModule
    url: URL

    The allowed URL for PostMessage communication

    dataSerializer: DataSerializer

    The dataserializer to use for parse and stringify object into PostMessage

    Property

    used to unserialize data

    Property

    used to serialize data

    _channelListener: EventEmitter<string | symbol, any> = ...

    Channel where everything will be broadcast

    Constructors

    Generated using TypeDoc