Home Original page

mage | mage

MAGE API Documentation

MAGE logo

Here you will find both the API documentation for MAGE.

New to MAGE? Looking for a list of features or configuration options? You should have a look at the user documentation first.

Frequently Used APIs

Name Description
MAGE MAGE general APIs (start, stop, initialization and configuration)
State Transactional state object (mostly provided by user commands)
Archivist Database access layer
Logger Logging and log levels
Configuration Configuration access
Core MAGE Core APIs (HTTP Server, MsgServer, etc.)

See also

Index

Type aliases

AuthenticateCallback

AuthenticateCallback: function

Type declaration

    • (error: Error | null, userId: string | number, acl: string[]): void

    • Parameters

      • error: Error | null
      • userId: string | number
      • acl: string[]

      Returns void

BanCallback

BanCallback: function

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

ChangePasswordCallback

ChangePasswordCallback: function

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

ConfigurationLabel

ConfigurationLabel: string | string[]

LoginCallback

LoginCallback: function

Type declaration

    • (error: Error | null, session: Session): void

    • Parameters

      • error: Error | null
      • session: Session

      Returns void

MmrpEnvelopeFlag

MmrpEnvelopeFlag: "NONE" | "TRACK_ROUTE" | number

MmrpEnvelopeMessage

MmrpEnvelopeMessage: string | Buffer

MmrpEnvelopeRoute

MmrpEnvelopeRoute: string[]

RegisterCallback

RegisterCallback: function

Type declaration

    • (error: Error | null, userId: string): void

    • Parameters

      • error: Error | null
      • userId: string

      Returns void

ServiceErrorEventHandler

ServiceErrorEventHandler: function

Type declaration

    • (error: Error): void

    • Parameters

      • error: Error

      Returns void

ServiceEventHandler

ServiceEventHandler: function

Type declaration

ServiceEventName

ServiceEventName: "up" | "down" | "error"

TimeConfig

TimeConfig: object

Type declaration

  • accelerationFactor: number
  • offset: number
  • startAt: number

UnbanCallback

UnbanCallback: function

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

VaultOperation

VaultOperation: "add" | "set" | "del" | "touch"

Variables

Export assignment config