LiveQueryServerOptions

Properties
NameTypeDescription
appIdString

This string should match the appId in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same appId.

cacheTimeoutNumber

Number in milliseconds. When clients provide the sessionToken to the LiveQuery server, the LiveQuery server will try to fetch its ParseUser's objectId from parse server and store it in the cache. The value defines the duration of the cache. Check the following Security section and our protocol specification for details, defaults to 5 * 1000 ms (5 seconds).

keyPairsAny

A JSON object that serves as a whitelist of keys. It is used for validating clients when they try to connect to the LiveQuery server. Check the following Security section and our protocol specification for details.

logLevelString

This string defines the log level of the LiveQuery server. We support VERBOSE, INFO, ERROR, NONE, defaults to INFO.

masterKeyString

This string should match the masterKey in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same masterKey.

portNumber

The port to run the LiveQuery server, defaults to 1337.

pubSubAdapterAdapter.<PubSubAdapter>

LiveQuery pubsub adapter

redisOptionsAny

parse-server's LiveQuery redisOptions

redisURLString

parse-server's LiveQuery redisURL

serverURLString

This string should match the serverURL in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same serverURL.

websocketTimeoutNumber

Number of milliseconds between ping/pong frames. The WebSocket server sends ping/pong frames to the clients to keep the WebSocket alive. This value defines the interval of the ping/pong frame from the server to clients, defaults to 10 * 1000 ms (10 s).

wssAdapterAdapter.<WSSAdapter>

Adapter module for the WebSocketServer