Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Accessors

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

    Returns boolean

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

    Returns boolean

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

    Returns boolean

Methods

  • createIframe(target: HTMLElement, targetUrl: string | URL, initialContent: string): Coriolis
  • childFrameCheck(): void
  • parentFrameCheck(): void
  • connect(): boolean
  • disconnect(): boolean
  • addListeners(): void
  • removeListeners(): void
  • socketSend(eventName: string, data?: {}, waitConnected?: boolean): void
  • socketOn(...args: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>
  • socketOnce(...args: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>
  • eventNames(): (string | symbol)[]
  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

  • listeners<T>(event: T): ((...args: any[]) => void)[]
  • Return the listeners registered for a given event.

    Type parameters

    • T: string | symbol

    Parameters

    • event: T

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

  • listenerCount(event: string | symbol): number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

  • emit<T>(event: T, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: string | symbol

    Parameters

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

    Returns boolean

  • on<T>(event: T, fn: (...args: any[]) => void, context?: any): Coriolis
  • Add a listener for a given event.

    Type parameters

    • T: string | symbol

    Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns Coriolis

  • addListener<T>(event: T, fn: (...args: any[]) => void, context?: any): Coriolis
  • Type parameters

    • T: string | symbol

    Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns Coriolis

  • once<T>(event: T, fn: (...args: any[]) => void, context?: any): Coriolis
  • Add a one-time listener for a given event.

    Type parameters

    • T: string | symbol

    Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns Coriolis

  • removeListener<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): Coriolis
  • Remove the listeners of a given event.

    Type parameters

    • T: 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

  • off<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): Coriolis
  • Type parameters

    • T: 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

  • removeAllListeners(event?: string | symbol): 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

{parse} function used to unserialize data

property

{stringify} function used to serialize data

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

Channel where everything will be broadcast

Constructors

Generated using TypeDoc