Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahamas10/fskv-client
A Node fskv client
https://github.com/bahamas10/fskv-client
Last synced: about 2 months ago
JSON representation
A Node fskv client
- Host: GitHub
- URL: https://github.com/bahamas10/fskv-client
- Owner: bahamas10
- Created: 2013-05-13T05:21:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-09-21T23:37:38.000Z (over 11 years ago)
- Last Synced: 2024-10-14T11:48:02.918Z (2 months ago)
- Language: JavaScript
- Size: 129 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
fskv-client
===========
A Node [fskv](https://github.com/bahamas10/fskv) client
Installation
------------
First, install [Node.JS](http://nodejs.org/). Then:
npm install fskv-client
Example
-------
Given:
``` js
var FSKVClient = require('fskv-client').FSKVClient;
var db = new FSKVClient('http://localhost:9000');
```
### `PUT`
``` js
db.put('my key', 'my value', function(err, res, body) {
console.log(res.statusCode);
// => 200
console.dir(body);
// => { message: 'saved', status: 'ok' }
});
```
### `GET`
``` js
db.get('my key', function(err, res, body) {
console.log(res.statusCode);
// => 200
console.log(body);
// => 'my value'
});
```
### `DELETE`
``` js
db.del('my key', function(err, res, body) {
console.log(res.statusCode);
// => 200
console.dir(body);
// => { message: 'deleted', status: 'ok' }
});
```
Functions
---------
### `new FSKVClient(uri, [useragent])`
Create a new database object that can be used to get and put data
`User-Agent` is optional and defaults to `fskv-client (vX.Y.Z)` with the version number
---
All callbacks given below will be fired as `function(err, res, body)`, which is passed directly
from the `request` module
### `db.get(key, [etag], [cb])`
Execute a `GET` request for the given `key`.
- `etag`: An optional etag to use when making the request. If the etag matches, a 304 is returned with no data
- `cb`: An optional callback. If not callback is supplied, the request is returned as an event emitter that can be piped
``` js
// EventEmitter Example
db.get('my key').pipe(process.stdout);
```
### `db.head(key, [etag], [cb])`
Same as `GET` above, but no data is ever returned.
### `db.put(key, [value], [opts], [cb])`
Execute a `PUT` on the database with the given `key`.
- `value`: An Optional value to put in the database. If not supplied, it is assumed an EventEmmiter will be piped into the object.
- `opts`: An optional object to pass in as a query string. Example: `{exclusive: true}` for exclusive requests.
- `cb`: An optional callback
``` js
// EventEmitter Example
var fs = require('fs');
var rs = fs.createReadStream('/etc/passwd');
var put = db.put(key);
put.on('error', function(e) {
console.error(e.message);
});
rs.pipe(put);
```
``` js
// EventEmitter Example whith a callback
var fs = require('fs');
var rs = fs.createReadStream('/etc/passwd');
var req = db.put(key, function(err, res, body) {
console.log(res.statusCode);
// => 200
});
rs.pipe(req);
```
### `db.del(key, [cb])`
Execute a `DELETE` on the database with the given `key`.
- `cb`: An optional callback
### `db.ping(cb)`
Ping the server, you can test that `res.statusCode === 200` and `body === 'pong\n'`
### `db.stats(cb)`
`body` will be set to a parsed object that represents the servers stats
License
-------
MIT