# basho-riak-client

> Basho's officially supported NodeJS client for Riak

Latest version **2.4.0** (published 2016-12-12) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install basho-riak-client
pnpm add basho-riak-client
yarn add basho-riak-client
bun add basho-riak-client
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2016-12-12 |
| First published | 2015-04-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ~0.12 |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+13 in 3 direct dependencies) |
| Install scripts | no |
| Author | Brian Roach |
| Maintainers | basho |
| Keywords | riak, node, nodejs, distributed, nosql, driver, riak-nodejs-client, client, basho |

## Links

- npm: https://www.npmjs.com/package/basho-riak-client
- Repository: https://github.com/basho/riak-nodejs-client
- Homepage: https://github.com/basho/riak-nodejs-client/wiki
- Issues: https://github.com/basho/riak-nodejs-client/issues
- npm.io page: https://npm.io/package/basho-riak-client

## Dependencies (8)

- [joi](https://npm.io/package/joi.md) ~6.0
- [long](https://npm.io/package/long.md) ~3.2
- [async](https://npm.io/package/async.md) ~2.0
- [backoff](https://npm.io/package/backoff.md) ~2.5
- [hashmap](https://npm.io/package/hashmap.md) ~2.0
- [winston](https://npm.io/package/winston.md) ~2.2
- [bytebuffer](https://npm.io/package/bytebuffer.md) ~5.0
- [protobufjs](https://npm.io/package/protobufjs.md) ~5.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 2.4.0 (latest) — 2016-12-12
- 2.2.0-beta1 (beta) — 2016-04-26
- 2.3.0 — 2016-11-17
- 2.2.2 — 2016-07-07
- 2.2.1 — 2016-07-06
- 2.2.0 — 2016-06-17
- 2.1.2 — 2016-03-14
- 2.1.2-beta4 — 2016-03-11
- 2.1.2-beta3 — 2016-03-06
- 2.1.2-beta2 — 2016-03-06
- 2.1.1 — 2016-01-16
- 2.1.0 — 2016-01-13
- 2.0.0 — 2015-12-21
- 1.8.1 — 2015-10-14
- 1.8.0 — 2015-10-14
- … 15 more at https://npm.io/package/basho-riak-client/versions

## README

# Riak Node.js Client

**Riak Node.js Client** is a client which makes it easy to communicate with [Riak](http://basho.com/riak/), an open source, distributed database that focuses on high availability, horizontal scalability, and *predictable* latency. Both Riak and this code is maintained by [Basho](http://www.basho.com/).

## Build Status

* Master: [![Build Status](https://travis-ci.org/basho/riak-nodejs-client.svg?branch=master)](https://travis-ci.org/basho/riak-nodejs-client)

# Installation

`npm install basho-riak-client --save`

# Documentation

Most documentation is living in the [wiki](https://github.com/basho/riak-nodejs-client/wiki). For specifics on our progress here, see the [release notes](https://github.com/basho/riak-nodejs-client/blob/master/RELNOTES.md). 

# Testing / Contributing

This repository's maintainers are engineers at Basho and we welcome your contribution to the project! Review the details in [CONTRIBUTING.md](CONTRIBUTING.md) in order to give back to this project.

*Note:* Please clone this repository in such a manner that submodules are also cloned:

```
git clone --recursive https://github.com/basho/riak-nodejs-client

OR:

git clone https://github.com/basho/riak-nodejs-client
git submodule update --init --recursive
```

## Unit Tests

```sh
make unit-test
```

## Integration Tests

You have two options to run Riak locally - either build from source, or use a pre-installed Riak package.

### Source

To setup the default test configuration, build a Riak node from a clone of `github.com/basho/riak`:

```sh
# check out latest release tag
git checkout riak-2.1.4
make locked-deps
make rel
```

[Source build documentation](http://docs.basho.com/riak/kv/latest/setup/installing/source/).

When building from source, the protocol buffers port will be `8087` and HTTP will be `8098`.

### Package

Install using your platform's package manager ([docs](http://docs.basho.com/riak/kv/latest/setup/installing/))

When installing from a package, the protocol buffers port will be `8087` and HTTP will be `8098`.

### Running Integration Tests

* Ensure you've initialized this repo's submodules:

```sh
git submodule update --init
```

* Run the following:

```sh
./tools/setup-riak
make integration-test
```

# Roadmap

The **Riak Node.js Client** will support Node.js releases according to the [LTS schedule](https://github.com/nodejs/LTS#lts-schedule).

## License and Authors
**The Riak Node.js** Client is Open Source software released under the Apache 2.0 License. Please see the [LICENSE](LICENSE) file for full license details.

* Author: [Brian Roach](https://github.com/broach)
* Author: [Luke Bakken](http://bakken.io/)
* Author: [Bryce Kerley](https://github.com/bkerley)

## Contributors

Thank you to all of our contributors!

* [Tim Kennedy](https://github.com/stretchkennedy)
* [Doug Luce](https://github.com/dougluce) 
* [Charlie Zhang](https://github.com/charliezhang) 
* [Colin Hemmings](https://github.com/gonzohunter)
* [Timothy Stonis](https://github.com/tstonis)
* [Aleksandr Popov](https://github.com/mogadanez)
* [Josh Yudaken](https://github.com/qix)
* [Gabriel Nicolas Avellaneda](https://github.com/GabrielNicolasAvellaneda)
* [Iain Proctor](https://github.com/iproctor)
* [Brian Edgerton](https://github.com/brianedgerton)
* [Samuel](https://github.com/faust64)
* [Bryan Burgers](https://github.com/bryanburgers)

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