Maintenance

Maintenance checks whether maintenance mode is currently active on EML AdminTool. When it is, you are responsible for blocking the launcher and displaying the maintenance screen.

Call getMaintenance() at startup, before showing the home view.

import { Maintenance } from 'eml-lib'

applyMaintenanceStatus()

async function applyMaintenanceStatus() {
  const maintenance = new Maintenance('https://at.myserver.com')

  try {
    const status = await maintenance.getMaintenance()

    if (status !== null) {
      showMaintenanceView(status.message)
    } else {
      showHomeView()
    }
  } catch (err) {
    console.error(err)
  }
}

Constructor

Parameter	Type	Description	Required?
url	string	The URL of your EML AdminTool instance.	Yes

Methods

getMaintenance()

Fetches the current maintenance status from EML AdminTool.

Returns: Promise<null> — If no maintenance is active. • Promise<IMaintenance> — If maintenance is active.

Throws: FETCH_ERROR — If the request to EML AdminTool fails.