https://github.com/travishorn/connect-lowdb

lowdb session store for Connect
https://github.com/travishorn/connect-lowdb

Last synced: 28 days ago
JSON representation

lowdb session store for Connect

• Host: GitHub
• URL: https://github.com/travishorn/connect-lowdb
• Owner: travishorn
• License: mit
• Created: 2022-02-06T19:51:44.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-03T15:30:36.000Z (4 months ago)
• Last Synced: 2024-12-03T18:15:18.252Z (about 1 month ago)
• Language: JavaScript
• Size: 39.1 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# connect-lowdb

**connect-lowdb** provides [lowdb](https://github.com/typicode/lowdb) session

storage for Express. Requires lowdb ^7.0.0.

## Installation

```bash

npm install lowdb connect-lowdb express-session

```

## API

```javascript

import session from "express-session";

import { JSONFilePreset } from "lowdb/node";

import lowdbStore from "connect-lowdb";

const db = await JSONFilePreset("db.json", null);

const LowdbStore = lowdbStore(session);

app.use(

  session({

    store: new LowdbStore({ db }),

    resave: false,

    saveUninitialized: false,

    secret: "keyboard cat",

  }),

);

```

### LowdbStore(options)

The `LowdbStore` requires an existing [lowdb](https://github.com/typicode/lowdb)

database object.

#### Options

##### db

An instance of `Low` created by [lowdb](https://github.com/typicode/lowdb).

## License

The MIT License (MIT)

Copyright © 2024 Travis Horn

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the “Software”), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.