kami-parse-server/6.0.0.md

Parse Server 6 Migration Guide

This document only highlights specific changes that require a longer explanation. For a full list of changes in Parse Server 6 please refer to the changelog.

---

• Import Statement
• Asynchronous Initialization

---

Import Statement

The import and initialization syntax has been simplified with more intuitive naming and structure.

Parse Server 5:

// Returns a Parse Server instance
const ParseServer = require('parse-server');

// Returns a Parse Server express middleware
const { ParseServer } = require('parse-server');

Parse Server 6:

// Both return a Parse Server instance
const ParseServer = require('parse-server');
const { ParseServer } = require('parse-server');

To get the express middleware in Parse Server 6, configure the Parse Server instance, start Parse Server and use its app property. See Asynchronous Initialization for more details.

Asynchronous Initialization

Previously, it was possible to mount Parse Server before it was fully started up and ready to receive requests. This could result in undefined behavior, such as Parse Objects could be saved before Cloud Code was registered. To prevent this, Parse Server 6 requires to be started asynchronously before being mounted.

Parse Server 5:

// 1. Import Parse Server
const { ParseServer } = require('parse-server');

// 2. Create a Parse Server instance as express middleware
const server = new ParseServer(config);

// 3. Mount express middleware
app.use("/parse", server);

Parse Server 6:

// 1. Import Parse Server
const ParseServer = require('parse-server');

// 2. Create a Parse Server instance
const server = new ParseServer(config);

// 3. Start up Parse Server asynchronously
await server.start();

// 4. Mount express middleware
app.use("/parse", server.app);