# dynaflo

> Dynaflo makes working with DynamoDB easier.

Latest version **0.6.0-alpha** (published 2019-06-26) · BSD license · 0 weekly downloads

## Install

```sh
npm install dynaflo
pnpm add dynaflo
yarn add dynaflo
bun add dynaflo
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0-alpha |
| Published | 2019-06-26 |
| First published | 2016-12-11 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 138 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Trevor Hanus |
| Maintainers | trevorhanus |

## Links

- npm: https://www.npmjs.com/package/dynaflo
- Repository: https://github.com/trevorhanus/dynaflo
- Homepage: https://dynaflo.js.org/
- Issues: https://github.com/trevorhanus/dynaflo/issues
- npm.io page: https://npm.io/package/dynaflo

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.2
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.7.4
- [randomstring](https://npm.io/package/randomstring.md) ^1.1.5

## Recent versions

- 0.6.0-alpha (latest) — 2019-06-26
- 0.5.1-alpha — 2019-02-28
- 0.5.0-alpha — 2019-01-22
- 0.4.0 — 2018-01-08
- 0.3.0 — 2016-12-29
- 0.2.5 — 2016-12-21
- 0.2.4 — 2016-12-21
- 0.2.3 — 2016-12-20
- 0.2.2 — 2016-12-20
- 0.2.1 — 2016-12-20
- 0.2.0 — 2016-12-20
- 0.1.4 — 2016-12-11

## README

# Dynaflo

Dynaflo is a wrapper around the AWS DynamoDB SDK for node. Dynaflo's goal is to make it easier to 
work with the AWS SDK while staying true to the DynamoDB way of doing things. Wherever possible, it uses
the termonology set forth in the AWS SDK.

## Quick Start

```bash
$ npm install --save dynaflo
```

```javascript
import Dynaflo from 'dynaflo';
const d = new Dynaflo(config);

d.table('Movies')
  .get({title: 'Fantastic Beasts'})
  .run()
  .then(movie => {
    console.log(movie.title); // Fantastic Beasts
  })
  .catch(err => {
    console.error(err);
  });
```

## Deeper Dive

Read through the full documentation [here](http://dynaflo-docs.s3-website-us-west-2.amazonaws.com/).

## Contributing

### Running DynamoDB locally

Make sure you have docker installed and run the docker image...

```
$ docker run -p 7777:7777 trevorhanus/dynamodb-local
```

### Testing

clone repo

```
$ git clone <clone url>
```

install dependencies

```
$ npm install
```

run tests

```
$ npm test
```

## Todo
- Get docs hosted on Gitlab
- Verify query method has all modifiers it needs
- Finish scan method
- Finish BatchGet
- Finish BatchWrite

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