Class ModuleLoader

A class which handles the loading of the different module and their dependencies. This will also check that both Coriolis instances have the same modules loaded and log into the console if it's not the case.

Hierarchy

EventEmitter
- ModuleLoader

Implements

ModuleLoaderInterface

Index

Properties

`Static` prefixed

prefixed: string | boolean

`Private` _postMessage

_postMessage: PostMessageChannel

Internal save of postMessage main instance

`Private` _loadedModules

_loadedModules: Map<string, ModuleBase> = ...

Internal array to save all modules that are registered

Constructors

constructor

new ModuleLoader(postMessage: PostMessageChannel): ModuleLoader
Constructor
Parameters
- postMessage: PostMessageChannel
  
  The postMessage main instance to pass to the modules
Returns ModuleLoader
Overrides EventEmitter.constructor
- Defined in src/ModuleLoader.ts:50

Methods

load

load(name: string, Module: ModuleBaseConstructable, config?: {}): ModuleBase
Add a module

Returns
return if the module is correctly added
Parameters
- name: string
  
  The name of the module
- Module: ModuleBaseConstructable
  
  A module class to instanciate
- config: {} = {}
  
  The configuration to pass to the module
Returns ModuleBase
Implementation of ModuleLoaderInterface.load
- Defined in src/ModuleLoader.ts:63

has

has(name: string): boolean
Parameters
- name: string
Returns boolean
Implementation of ModuleLoaderInterface.has
- Defined in src/ModuleLoader.ts:78

get

get(name: string): undefined | ModuleBase
Parameters
- name: string
Returns undefined | ModuleBase
Implementation of ModuleLoaderInterface.get
- Defined in src/ModuleLoader.ts:82

list

list(): Set<string>
Returns Set<string>
Implementation of ModuleLoaderInterface.list
- Defined in src/ModuleLoader.ts:86

require

require(name: string): ModuleBase
Parameters
- name: string
Returns ModuleBase
Implementation of ModuleLoaderInterface.require
- Defined in src/ModuleLoader.ts:90

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Implementation of ModuleLoaderInterface.eventNames

Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Implementation of ModuleLoaderInterface.listeners

Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Implementation of ModuleLoaderInterface.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Implementation of ModuleLoaderInterface.emit

Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): ModuleLoader
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 ModuleLoader
Implementation of ModuleLoaderInterface.on

Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): ModuleLoader
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 ModuleLoader
Implementation of ModuleLoaderInterface.addListener

Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): ModuleLoader
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 ModuleLoader
Implementation of ModuleLoaderInterface.once

Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): ModuleLoader
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 ModuleLoader
Implementation of ModuleLoaderInterface.removeListener

Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

off

off<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): ModuleLoader
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 ModuleLoader
Implementation of ModuleLoaderInterface.off

Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

removeAllListeners

removeAllListeners(event?: string | symbol): ModuleLoader
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns ModuleLoader
Implementation of ModuleLoaderInterface.removeAllListeners

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

Class ModuleLoader

Hierarchy

Implements

Index

Properties

Constructors

Methods

Properties

Static prefixed

Private _postMessage

Private _loadedModules

Constructors

constructor

Parameters

postMessage: PostMessageChannel

Returns ModuleLoader

Methods

load

Returns

Parameters

name: string

Module: ModuleBaseConstructable

config: {} = {}

Returns ModuleBase

has

Parameters

name: string

Returns boolean

get

Parameters

name: string

Returns undefined | ModuleBase

list

Returns Set<string>

require

Parameters

name: string

Returns ModuleBase

eventNames

Returns (string | symbol)[]

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

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

listenerCount

Parameters

event: string | symbol

Returns number

emit

Type Parameters

T extends string | symbol

Parameters

event: T

Rest ...args: any[]

Returns boolean

on

Type Parameters

T extends string | symbol

Parameters

event: T

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

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns ModuleLoader

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

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

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns ModuleLoader

once

`Static` prefixed

`Private` _postMessage

`Private` _loadedModules

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean

`Optional` event: string | symbol