https://github.com/spaceuptech/space-api-js
https://github.com/spaceuptech/space-api-js
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/spaceuptech/space-api-js
- Owner: spaceuptech
- License: apache-2.0
- Created: 2018-05-15T12:21:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T15:16:17.000Z (over 3 years ago)
- Last Synced: 2025-09-08T23:05:15.399Z (10 months ago)
- Language: JavaScript
- Homepage: https://spaceuptech.com
- Size: 1.51 MB
- Stars: 20
- Watchers: 3
- Forks: 7
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Client API for Space Cloud
## Installation
Install via. npm
```bash
$ npm install space-api --save
```
or import as a stand alone library
```html
```
## Documentation
The complete documentation can be found [here](https://github.com/spaceuptech/space-api-js/wiki).
Documentation for specific databases is given below:
- [MongoDB](https://github.com/spaceuptech/space-api-js/wiki/Mongo)
- [SQL Databases](https://github.com/spaceuptech/space-api-js/wiki/SQL)
Documentation for real time feature is given below:
- [Realtime Feature](https://github.com/spaceuptech/space-api-js/wiki/Realtime)
## Quick Start
### Create Client Instance
```js
import { API, and, or, cond } from 'space-api';
const api = new API('demo-project', 'http://localhost:4122');
const db = api.DB("mongo") // Put your database alias name here to create DB instance
```
**Note: Multiple databases may be used simultaneously.**
### Insert a document into the database
```js
const doc = {_id: 1, title: "Title 1", content: "My first record"};
db.insert('COLLECTION_NAME').doc(doc).apply().then(res => {
if (res.status === 200) {
// Document inserted successfully
return;
}
}).catch(ex => {
// Exception occured while processing request
});
```
**Note: Always insert documents with a id in order to use the realtime feature.**
### Query documents in database
```js
const find = and(cond('title', '==', 'Title1'), cond('author', '==', 'Jon'));
db.get('COLLECTION_NAME').where(find)
.skip(10).limit(10)
.apply()
.then(res => {
if (res.status === 200) {
// res.data contains the documents returned by the database
console.log('Response:', res.data);
return;
}
}).catch(ex => {
// Exception occured while processing request
});
```
### Update documents in database
```js
const find = and(cond('author', '==', 'Jon'));
db.update('COLLECTION_NAME').where(find)
.set({ author: 'John' })
.apply()
.then(res => {
if (res.status === 200) {
// Document updated successfully
return;
}
}).catch(ex => {
// Exception occured while processing request
});
```
### Delete documents in database
```js
const find = and(cond('author', '==', 'John'));
db.delete('COLLECTION_NAME').where(find)
.apply()
.then(res => {
if (res.status === 200) {
// Document deleted successfully
return;
}
}).catch(ex => {
// Exception occured while processing request
});
```
### Get real time updates
```js
const onSnapshot = (docs, type, find, changedDoc) => {
if (type === 'initial') {
console.log('Initial docs ', docs)
return
}
console.log(docs, type, find, changedDoc)
}
const onError = (err) => {
console.log('Monitor error', err)
}
let subscription = db.liveQuery('posts').where().subscribe(onSnapshot, onError)
subscription.unsubscribe()
```
### Upload file
```js
const fileInput = document.querySelector('#your-file-input');
api.FileStore().uploadFile("/some-path", fileInput.files[0])
.then(res => {
if (res.status === 200) {
console.log("File uploaded successfully");
}
}).catch(ex => {
// Exception occured while uploading file
})
```
### Call functions directly (Function as a Service)
```js
api.call('my-engine', 'my-func', { msg: 'Function as a Service is awesome!' }, 1000)
.then(res => {
if (res.status === 200) {
console.log('Response: ', res.data)
}
}).catch(ex => {
// Exception occured while processing request
})
```
## License
Copyright 2018 Noorain Panjwani
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.