new ParseServer(options)
Name | Type | Description |
---|---|---|
options | ParseServerOptions | the parse server initialization options |
Methods
(async) handleShutdown() → {Promise.<void>}
Stops the parse server, cancels any ongoing requests and closes all connections.
Currently, express doesn't shut down immediately after receiving SIGINT/SIGTERM if it has client connections that haven't timed out. (This is a known issue with node - https://github.com/nodejs/node/issues/2642)
a promise that resolves when the server is stopped
- Type:
- Promise.<void>
(async) start()
Starts Parse Server as an express app; this promise resolves when Parse Server is ready to accept requests.
(async) startApp(options) → {ParseServer}
starts the parse server's express app
Name | Type | Description |
---|---|---|
options | ParseServerOptions | to use to start the server |
the parse server instance
- Type:
- ParseServer
(static) app(options)
Name | Type | Description |
---|---|---|
options | Object | let you specify the maxUploadSize when creating the express app |
(async, static) createLiveQueryServer(httpServer, config, options) → {Promise.<ParseLiveQueryServer>}
Helper method to create a liveQuery server
Name | Type | Description |
---|---|---|
httpServer | Server | an optional http server to pass |
config | LiveQueryServerOptions | options for the liveQueryServer |
options | ParseServerOptions | options for the ParseServer |
the live query server instance
- Type:
- Promise.<ParseLiveQueryServer>
(async, static) startApp(options) → {ParseServer}
Creates a new ParseServer and starts it.
Name | Type | Description |
---|---|---|
options | ParseServerOptions | used to start the server |
the parse server instance
- Type:
- ParseServer