Skip to main content
The SDK detects maintenance mode reactively via 503 responses. Write operations are blocked; reads are still allowed.

Event Handlers

The simplest way to handle maintenance is via constructor callbacks:
Or attach/remove handlers dynamically:

Write Behavior

Write operations throw MaintenanceError immediately if the SDK is already in maintenance state — they do not hit the server:

Read Behavior

Read operations (listRecords, getRecord, paginateRecords, getSchema, getBootstrap) are allowed during maintenance and may succeed depending on server behavior.

Automatic Recovery

Maintenance mode clears automatically — if any request succeeds after a 503, the SDK exits maintenance mode and fires maintenanceEnd.

Proactive Detection

The SDK only detects maintenance reactively. For proactive detection before a write fails, implement your own status poller:

getStatus(signal?)

Fetches the current app status without triggering maintenance mode detection.