-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# koa-generic-session-rethinkdb | ||
|
||
This is a module for storing sessions from the [koa-generic-session](https://github.com/koajs/generic-session) | ||
module in [RethinkDB](http://rethinkdb.com). | ||
|
||
|
||
## Installation | ||
|
||
```bash | ||
npm i --save koa-generic-session-rethinkdb | ||
``` | ||
|
||
## Usage | ||
|
||
### Example | ||
```JavaScript | ||
var koa = require('koa') | ||
// for use with koa-generic-session | ||
var session = require('koa-generic-session') | ||
var RethinkSession = require('koa-generic-session-rethinkdb') | ||
var rethinkdb = require('rethinkdbdash') | ||
|
||
var connection = rethinkdb({ | ||
host: 'localhost', | ||
port: 28015 | ||
}) | ||
|
||
var sessionStore = new RethinkSession({connection: connection}) | ||
// create the db, table and indexes to store sessions | ||
sessionStore.setup() | ||
|
||
|
||
|
||
var app = koa() | ||
// used for cookie stuffs | ||
app.keys = ['foo', 'bar'] | ||
|
||
app.use(session({ | ||
store: sessionStore | ||
}) | ||
``` | ||
### `new RethinkSession(opts)` | ||
Return a new RethinkSession store. `opts` are options. | ||
#### Options | ||
* `connection` - a [rethinkdbdash](https://github.com/neumino/rethinkdbdash) | ||
connection to a rethink server or cluster. required. | ||
* `dbName` - the name of a db to connnect to or create. optional. | ||
* `tableName` - the name of the table to store session in. optional. | ||
## Contributing | ||
Run the tests with `npm test`. Please add tests to cover new functionality. |