A library that gives you access to the powerful Parse Server backend from your JavaScript app. For more information on Parse and its features, see the website, the JavaScript guide, the Cloud Code guide or API Reference.

• Compatibility
  • Parse Server
  • Node.js
• Getting Started
  • Using Parse on Different Platforms
    • Core Manager
• 3rd Party Authentications
  • Experimenting
• Contributing

Compatibility

Parse Server

Parse JS SDK is compatible with the following versions of Parse Server.

Node.js

Parse JS SDK is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the Node.js Long Term Support plan and only test against versions that are officially supported and have not reached their end-of-life date.

Getting Started

The easiest way to integrate the Parse SDK into your JavaScript project is through the npm module. However, if you want to use a pre-compiled file, you can fetch it from unpkg. The development version is available at https://unpkg.com/parse/dist/parse.js, and the minified production version is at https://unpkg.com/parse/dist/parse.min.js.

Using Parse on Different Platforms

The JavaScript ecosystem is wide and incorporates a large number of platforms and execution environments. To handle this, the Parse npm module contains special versions of the SDK tailored to use in Node.js and React Native environments. Not all features make sense in all environments, so using the appropriate package will ensure that items like local storage, user sessions, and HTTP requests use appropriate dependencies. For server side rendered applications, you may set the SERVER_RENDERING variable to prevent warnings at runtime.

To use the npm modules for a browser based application, include it as you normally would:

const Parse = require('parse');
// ES6 Minimized
import Parse from 'parse/dist/parse.min.js';

For web worker or browser applications, indexedDB storage is available:

Parse.CoreManager.setStorageController(Parse.IndexedDB);

For server-side applications or Node.js command line tools, include 'parse/node':

// In a node.js environment
const Parse = require('parse/node');

For React Native applications, include 'parse/react-native.js':

// In a React Native application
const Parse = require('parse/react-native.js');

// On React Native >= 0.50 and Parse >= 1.11.0, set the Async
const AsyncStorage = require('@react-native-async-storage/async-storage');
Parse.setAsyncStorage(AsyncStorage);

For WeChat miniprogram, include 'parse/weapp':

// In a WeChat miniprogram
const Parse = require('parse/weapp');

If you want to use a pre-compiled file, you can fetch it from unpkg. The development version is available at https://unpkg.com/parse/dist/parse.weapp.js, and the minified production version is at https://unpkg.com/parse/dist/parse.weapp.min.js.

For TypeScript applications, install '@types/parse':

$ npm install @types/parse

Types are updated manually after every release. If a definition doesn't exist, please submit a pull request to @types/parse

Core Manager

The SDK has a Core Manager that handles all configurations and controllers. These modules can be swapped out for customization before you initialize the SDK. For full list of all available modules take a look at the Core Manager Documentation.

// Configuration example
Parse.CoreManager.set('REQUEST_ATTEMPT_LIMIT', 1)

// Controller example
Parse.CoreManager.setRESTController(MyRESTController);

3rd Party Authentications

Parse Server supports many 3rd Party Authenications. It is possible to linkWith any 3rd Party Authentication by creating a custom authentication module.

Experimenting

You can also use your own forks, and work in progress branches by specifying them:

npm install github:myUsername/Parse-SDK-JS#my-awesome-feature

And don't forget, if you plan to deploy it remotely, you should run npm install with the --save option.

Contributing

We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the Contributing to Parse Javascript SDK guide.