paragasu / nativescript-couchdb

nativescript plugin for couchdb

nativescript-couchdb

Nativescript plugin for couchdb A simple wrapper using nativescript http api to implement subset api compatible with PouchDB.

Install

tns plugin install nativescript-couchdb

API

constructor(couchdb_url, extraHeaders) Setup the database to connect to

• url string eg: https://localhost:5984
• extraHeaders Map specify extra map to pass as http header

put(doc)

• doc string valid couchdb json doc with _id key
• return promise

get(docId)

• docId string document id
• return promise

remove(doc)

• doc json object couchdb json db or json with _id, _rev key
• return promise

allDocs(options)

• options json object couchdb params as in http://docs.couchdb.org/en/2.0.0/api/database/bulk-api.html
• return promise

query(design_view)

• design_view string eg /_design/design_name/_view/view_name will be design_name/view_name
• return promise

Usage

import * as dialog from "ui/dialogs";
import { CouchDB } from "nativescript-couchdb";

let db = new CouchDB("https://couchdb.server/dbname", {
  "Authorization": "Basic base64\_encoded\_string"
});
let data = {
  _id: "hello",
  name: "world" 
}


// create and update
db.put(data)
  .then(res => dialog.alert("saved"))
  .catch(err => dialog.alert("Failed"));

// get data
db.get("hello")
  .then(res => dialog.alert(JSON.stringify(res)))
  .catch(err => dialog.alert("Data not found"));

// delete doc
db.remove(data)
  .then(res => dialog.alert("Data deleted"))
  .catch(err => dialog.alert("Delete failed"));

// alldocs
db.allDocs(options)
  .then(res => dialog.alert(res))
  .catch(err => dialog.alert(err));

// query views
db.query("user/top_contributor", { group_level: 1, reduce: true })
  .then(res => dialog.alert(res))
  .catch(err => dialog.alert(err));

nativescript-couchdb's Issues

Add support for `key` on query params

Currently using the params key is not supported. Only can use start_key and end_key query

Invalid json request error when keys params present on alldocs

It seem there is an issue related to encoding the keys array value.

Add support for authentication

Support couchdb authentication header

Support PouchDB?

Can this plugin support PouchDB ?
Because I want to use PouchDB offline, and to sync CouchDB online.
thanks.

CouchDB sync

If this is compatible with PouchDB, can i use syncing to sync my local db with remote CouchDB server?