Table of content
Edit this page Create an issue
Table of Contents

Setting up the JS SDK

Follow this guide to use javascript client SDK in your web app or any Javascript/Node.js project.

Step 1: Install Space Cloud API

Install via npm:

npm install space-api --save

Or import as a stand-alone library:

<script src="https://storage.googleapis.com/space-cloud/libraries/space-api.js"></script>

Step 2: Create an API instance

An api instance of Space Cloud on the frontend helps you talk to space-cloud binary and perform backend operations directly from the frontend.

The API constructor takes two parameters:

PROJECT_ID: Unique identifier of a project. It’s derived by converting your project name to lowercase. For example TodoApp becomes todoapp.
SPACE_CLOUD_URL: This is the URL of your space-cloud binary. It’s http://localhost:4122 or https://localhost:4126 for HTTP and HTTPS endpoints respectively.

Note: Replace localhost with the address of your Space Cloud if you are not running it locally.

For ES6:

import { API } from 'space-api';

const api = new API('todo_app', 'http://localhost:4122');

For ES5/CommonJS:

const { API } = require('space-api');

const api = new API('todo_app', 'http://localhost:4122');

For stand-alone:

var api = new Space.API("todo_app", "http://localhost:4122");

Step 3: Create a DB instance

The API instance created above helps you to use file storage and services modules directly. However, to use database and realTime modules, you also have to create a db instance.

Note: You can use multiple db instances in the same project as space cloud supports multiple databases.

This is how you create an instance of db in your project:

const db = api.DB(<db-alias-name>);

Let’s say you have provided the alias name for your database as mydb while adding your database in Mission Control, then your db initialization code will be:

const db = api.DB("mydb");

The alias name identifies a database in your project uniquely. You can find out the alias name for your database from the database selector of the topbar in the Database section of Mission Control.