Router

Router

Router class for event routing

Constructor

new Router(client)

Source:
Properties:
Name Type Description
events Object

Event map

Creates a new Router instance

Parameters:
Name Type Description
client Client

Client instance

Methods

attach(Module) → {Router}

Source:

Attaches a module

Parameters:
Name Type Description
Module AbstractModule

Module class, object or function

Returns:
Type
Router

destroy() → {Router}

Source:

Destroys all modules and unloads them

Returns:
Type
Router

initAll() → {Router}

Source:

Initialises all modules

Returns:
Type
Router

record(event) → {Router}

Source:

Registers an event

Parameters:
Name Type Description
event String

Event name

Returns:
Type
Router

register(modules) → {Client}

Source:

Registers modules

Parameters:
Name Type Description
modules String | Object | Array

An object, array or relative path to a folder or file to load modules from

Returns:
Type
Client

reload() → {Client}

Source:

Reloads module files (only those that have been added from by file path)

Returns:
Type
Client

unregister() → {Router}

Source:

Unregisters all modules

Returns:
Type
Router