# @sadorlovsky/lowdb-s3

> lowdb AWS S3 adapter

Latest version **1.0.5** (published 2021-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sadorlovsky/lowdb-s3
pnpm add @sadorlovsky/lowdb-s3
yarn add @sadorlovsky/lowdb-s3
bun add @sadorlovsky/lowdb-s3
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-10-13 |
| First published | 2019-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Zach Orlovsky |
| Maintainers | sadorlovsky |
| Keywords | lowdb, amazon, s3 |

## Links

- npm: https://www.npmjs.com/package/@sadorlovsky/lowdb-s3
- Repository: https://github.com/sadorlovsky/lowdb-s3
- Homepage: https://github.com/sadorlovsky/lowdb-s3#readme
- Issues: https://github.com/sadorlovsky/lowdb-s3/issues
- npm.io page: https://npm.io/package/@sadorlovsky/lowdb-s3

## Dependencies (2)

- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.783.0

## Recent versions

- 1.0.5 (latest) — 2021-10-13
- 1.0.4 — 2021-10-13
- 1.0.3 — 2020-10-31
- 1.0.2 — 2020-02-07
- 1.0.1 — 2019-06-21
- 1.0.0 — 2019-06-21

## README

# lowdb-s3

> Lowdb AWS S3 adapter

Adapter for [lowdb](https://github.com/typicode/lowdb) which uses AWS S3 to store data.

Requires [lowdb@1.0](https://github.com/typicode/lowdb/tree/v1.0.0).

## Usage

```bash
npm install @sadorlovsky/lowdb-s3@1
```

```js
const low = require('lowdb')
const S3 = require('@sadorlovsky/lowdb-s3')

const adapter = new S3({ bucket: 'bucket', key: 'db.json' })
const db = await low(adapter)
```

Custom S3 config

```js
const low = require('lowdb')
const S3 = require('@sadorlovsky/lowdb-s3')

const adapter = new S3({ bucket: 'bucket', key: 'db.json' }, {
  accessKeyId: 'ACCESS_KEY_ID',
  secretAccessKey: 'SECRET_ACCESS_KEY',
  region: 'custom-region',
  endpoint: 'custom.endpoint.com'
})
const db = await low(adapter)
```

## License

MIT

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