Mage | mage

Hierarchy

EventEmitter
- Mage

Index

Properties

MageError

auth

auth: object

Type declaration

authenticate: function
- authenticate(state: IState, username: string, password: string, callback: AuthenticateCallback): void
- Parameters
  - state: IState
  - username: string
  - password: string
  - callback: AuthenticateCallback
  Returns void
ban: function
- ban(state: IState, username: string, callback: BanCallback): void
- Parameters
  - state: IState
  - username: string
  - callback: BanCallback
  Returns void
changePassword: function
- changePassword(state: IState, username: string, newPassword: string, callback: ChangePasswordCallback): void
- Parameters
  - state: IState
  - username: string
  - newPassword: string
  - callback: ChangePasswordCallback
  Returns void
login: function
- login(state: IState, username: string, password: string, callback: LoginCallback): void
- Parameters
  - state: IState
  - username: string
  - password: string
  - callback: LoginCallback
  Returns void
loginAnonymous: function
- loginAnonymous(state: IState, options: IAuthOptions): Session
- Parameters
  - state: IState
  - options: IAuthOptions
  Returns Session
register: function
- register(state: IState, username: string, password: string, options: IAuthOptions, callback: RegisterCallback): void
- Parameters
  - state: IState
  - username: string
  - password: string
  - options: IAuthOptions
  - callback: RegisterCallback
  Returns void
unban: function
- unban(state: IState, username: string, callback: UnbanCallback): void
- Parameters
  - state: IState
  - username: string
  - callback: UnbanCallback
  Returns void

cli

cli: object

Type declaration

program: CommanderStatic
run: function
- run(): void
- Returns void

core

logger

magePackage

magePackage: any

rootPackage

rootPackage: any

session

session: object

Type declaration

reassign: function
- reassign(state: IState, fromActorId: string, toActorId: string, callback: Function): void
- Parameters
  - state: IState
  - fromActorId: string
  - toActorId: string
  - callback: Function
  Returns void
register: function
- register(state: IState, actorId: string, language: string, meta: any): void
- Parameters
  - state: IState
  - actorId: string
  - language: string
  - meta: any
  Returns void

task

task: object

Type declaration

name: string
options: any

time

time: object

Type declaration

bend: function
- bend(offset: number, accelerationFactor: number, startAt: number): void
- Parameters
  - offset: number
  - accelerationFactor: number
  - startAt: number
  Returns void
getConfig: function
- getConfig(): TimeConfig
- Returns TimeConfig
msec: function
- msec(): number
- Returns number
sec: function
- sec(): number
- Returns number
translate: function
- translate(timestamp: number, msecOut?: boolean): number
- Parameters
  - timestamp: number
  - Optional msecOut: boolean
  Returns number
  
  The translated timestamp according to the current time rules enforced by mage.time.bend
unbend: function
- unbend(): void
- Returns void

version

version: string

Optional workerId

workerId: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addModulesPath

addModulesPath(path: string): void

Parameters
- path: string
Returns void

boot

boot(allback?: function): void

Parameters
- Optional allback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Returns Array<string | symbol>

exit

exit(exitCode?: number, hard?: boolean): never

Parameters
- Optional exitCode: number
- Optional hard: boolean
Returns never

getClientConfig

getClientConfig(appName: string, baseUrl: string): any

Parameters
- appName: string
- baseUrl: string
Returns any

getMaxListeners

getMaxListeners(): number

Returns number

getModulePath

getModulePath(name: string): string

Parameters
- name: string
Returns string

getRunState

getRunState(): "setup" | "running" | "quitting"

Returns "setup" | "running" | "quitting"

getTask

getTask(): ITask

Returns ITask

isCodeFileExtension

isCodeFileExtension(ext: string): boolean

Parameters
- ext: string
Returns boolean

True if the extension is for a source code file

isDevelopmentMode

isDevelopmentMode(feature?: string): boolean

Parameters
- Optional feature: string
Returns boolean

listModules

listModules(): string[]

Returns string[]

listenerCount

listenerCount(type: string | symbol): number

Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

quit

quit(exitCode?: number, hard?: boolean): never

Parameters
- Optional exitCode: number
- Optional hard: boolean
Returns never

rawListeners

rawListeners(event: string | symbol): Function[]

Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

require

require(packageName: string): any

Parameters
- packageName: string
Returns any

setMaxListeners

setMaxListeners(n: number): this

Parameters
- n: number
Returns this

setRunState

setRunState(state: "setup" | "running" | "quitting"): string

Parameters
- state: "setup" | "running" | "quitting"
Returns string

setTask

setTask(name: string, options: any): void

Parameters
- name: string
- options: any
Returns void

setup

setup(cb?: function): Mage

Parameters
- Optional cb: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns Mage

setupModules

setupModules(cb: function): void

Parameters
- cb: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

start

start(cb?: function): Mage

Parameters
- Optional cb: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns Mage

useApplicationModules

useApplicationModules(): this

Returns this

useModules

useModules(moduleNames: string[]): this

Parameters
- moduleNames: string[]
Returns this

Hierarchy

Index

Properties

MageError

auth

Type declaration

authenticate: function

Parameters

state: IState

username: string

password: string

callback: AuthenticateCallback

Returns void

ban: function

Parameters

state: IState

username: string

callback: BanCallback

Returns void

changePassword: function

Parameters

state: IState

username: string

newPassword: string

callback: ChangePasswordCallback

Returns void

login: function

Parameters

state: IState

username: string

password: string

callback: LoginCallback

Returns void

loginAnonymous: function

Parameters

state: IState

options: IAuthOptions

Returns Session

register: function

Parameters

state: IState

username: string

password: string

options: IAuthOptions

callback: RegisterCallback

Returns void

unban: function

Parameters

state: IState

username: string

callback: UnbanCallback

Returns void

cli

Type declaration

program: CommanderStatic

run: function

Returns void

core

logger

magePackage

rootPackage

session

Type declaration

reassign: function

Parameters

state: IState

fromActorId: string

toActorId: string

callback: Function

Returns void

register: function

Parameters

state: IState

actorId: string

language: string

meta: any

Returns void

task

Type declaration

name: string