0xbradock / dynamaster Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 74 KB

🪶Lightweight and 🔐Typed interaction with DynamoDB

License: MIT License

JavaScript 2.15% TypeScript 97.85%

dynamaster's Introduction

DynaMaster 🧨

🚧 WORK IN PROGRESS 🚧

🪶Lightweight and 🔐Typed interaction with DynamoDB

For information on Dynamo SDK, visit their docs

Why I wrote this library:

I think it is strange that number is passed as a string in the SDK
I don't think is convenient that binary SDK requires the user to pass in the binary instead of a string
I think the keys used to index the AttributeValue are confusing (i.e. S, SS, M, etc.)
The creation of a Map is very confusing and verbose

🎯 The goal

Write the smallest typed library that interfaces with DynamoDB using native TS variables and objects.

Features

Usage

import { AttrType, writeToItem } from "dynamaster";
import {
  BatchWriteItemCommand,
  BatchWriteItemCommandOutput,
  DynamoDBClient,
  WriteRequest,
} from '@aws-sdk/client-dynamodb';

// string 👇
const myStringItem = writeToItem({
  type: AttrType.STRING,
  colName: "myColumnName",
  value: "payload"
})

// number 👇
const myNumberItem = writeToItem({
  type: AttrType.NUMBER,
  colName: "myColumnName",
  value: 123
})

// boolean 👇
const myBoolItem = writeToItem({
  type: AttrType.BOOLEAN,
  colName: "boolColFalse",
  value: false,
})

const tableName = "yourTableName"
const input = {
  "RequestItems": {
    [tableName]: [
      //                        👇            👇            👇
      { "PutRequest": { "Item": myStringItem, myNumberItem, myBoolItem } }
    ]
  }
}
const command = new BatchWriteItemCommand(input);
await client.send(command);

Recommend Projects