# connectordb

> ConnectorDB javascript client

Latest version **0.0.11** (published 2017-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install connectordb
pnpm add connectordb
yarn add connectordb
bun add connectordb
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2017-02-02 |
| First published | 2016-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ConnectorDB |
| Maintainers | dkumor |

## Links

- npm: https://www.npmjs.com/package/connectordb
- Repository: https://github.com/connectordb/connectordb-javascript
- Homepage: https://connectordb.github.io
- Issues: https://github.com/connectordb/connectordb-javascript/issues
- npm.io page: https://npm.io/package/connectordb

## Dependencies (1)

- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1

## Recent versions

- 0.0.11 (latest) — 2017-02-02
- 0.0.10 — 2017-02-02
- 0.0.9 — 2017-01-19
- 0.0.8 — 2016-10-08
- 0.0.7 — 2016-05-26
- 0.0.6 — 2016-05-26
- 0.0.5 — 2016-05-20
- 0.0.4 — 2016-05-20
- 0.0.3 — 2016-05-12
- 0.0.2 — 2016-03-10
- 0.0.1 — 2016-02-06

## README

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/connectordb/connectordb-javascript/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/connectordb/connectordb-javascript.svg?branch=master)](https://travis-ci.org/connectordb/connectordb-javascript)
[![bitHound Code](https://www.bithound.io/github/connectordb/connectordb-javascript/badges/code.svg)](https://www.bithound.io/github/connectordb/connectordb-javascript) [![npm version](https://badge.fury.io/js/connectordb.svg)](https://badge.fury.io/js/connectordb)

# ConnectorDB Javascript Client
This is the official javascript client for ConnectorDB. It is compatible with node, react-native, and the browser.

## Installing
### node

```
npm install connectordb --save
```

### Browser
You can download one of the releases (release tabs).

### Building

```bash
git clone https://github.com/connectordb/connectordb-javascript
cd connectordb-javascript
npm install
npm run build
```

You can run node tests by running connectordb in test mode:

```bash
connectordb create testdb --test
connectordb start testdb
connectordb run testdb &

npm run check
```

If making modifications, you can make sure your modifications work in the browser by using `browsertest.html`

## Usage
### Browser

```html
<html>
<head>
    <!-- You can also use requirejs -->
    <script src="connectordb.min.js"></script>
</head>
<body>
    <script>
        cdb = connectordb.ConnectorDB("apikey")

        // All functions return promises
        cdb.readUser("myuser").done(function(result) {
            console.log("User Nickname: " + result.name);
        });
    </script>
</body>
</html>
```

### Node/react-native

```javascript
connectordb = require("connectordb.min.js");

cdb = connectordb.ConnectorDB("apikey")

// All functions return promises
cdb.readUser("myuser").done(function(result) {
    console.log("User Nickname: " + result.name);
});
```

---
_Source: https://npm.io/package/connectordb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
