Skip to content

DynamoDB client for NodeJS and browser with a fluent api to build requests. We take care of the type mapping between JS and DynamoDB, customizable trough typescript decorators.

License

Notifications You must be signed in to change notification settings

shiftcode/dynamo-easy

Repository files navigation

Dynamo-Easy

Travis semantic-release latest-release Coverage Status styled with prettier All Contributors

A DynamoDB client which provides an easy to use fluent api to execute requests. It supports TypeScript decorators to define the necessary metadata for your models. You don't need to care about the mapping of JavaScript types to their DynamoDB types any more. We've got you covered.

Built with ❤️ by shiftcode.

Show me some code

import { Model, PartitionKey, DynamoStore } from '@shiftcoders/dynamo-easy'

@Model()
export class Person {
  @PartitionKey()
  id: string
  name: string
  yearOfBirth: number
}

const personStore = new DynamoStore(Person)

personStore
  .scan()
  .whereAttribute('yearOfBirth').equals(1958)
  .exec()
  .then(res => console.log('ALL items with yearOfBirth == 1958', res))

Resources

Credits

  • typescript-library-starter - Starter project which helps creating a TypeScript library project
  • vogels - To get an idea on how to build the fluent api
  • typestore - Inspiration on how to implement the model decorators

Contributors

Made with ❤️ by @michaelwittwer and all these wonderful contributors (emoji key):

Michael Wittwer
Michael Wittwer

🤔 💻 ⚠️ 📖
Simon Mumenthaler
Simon Mumenthaler

🤔 💻 ⚠️ 📖
Michael Lieberherr
Michael Lieberherr

💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!