npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dynamoo

v0.1.0

Published

Serialize and parse DynamoDB items

Downloads

950

Readme

_______
< dynamoo >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

dynamoo

npm version npm downloads Build Status Coverage Status

Serialize and parse DynamoDB items.

API

serialize

Serializing data to store in DynamoDB is hard, but dynamoo makes it easier. Suppose you have this item you want to putItem to DynamoDB:

const item = {
  bool: true,
  func: Function.prototype,
  list: ['a', 1, false, null, { key: 'val' }],
  map: { key: 'val', nested: ['list'] },
  null: null,
  num: 42,
  set: new Set(['a', 'a', 'b']),
  string: 'strung',
  undef: undefined
}

Just serialize that data before sending, like this:

const AWS = require('aws-sdk')
const { serialize } = require('dynamoo')

const dynamo = new AWS.DynamoDB()

dynamo.putItem({ Item: serialize(item), TableName }, console.log)

The serialized Item that gets sent looks like this:

const Item = {
  bool: { BOOL: true },
  list: {
    L: [
      { S: 'a' },
      { N: '1' },
      { BOOL: false },
      { NULL: true },
      { M: { key: { S: 'val' } } }
    ]
  },
  map: {
    M: {
      key: { S: 'val' },
      nested: { L: [{ S: 'list' }] }
    }
  },
  null: { NULL: true },
  num: { N: '42' },
  set: { SS: ['a', 'b'] },
  string: { S: 'strung' }
}

Wow! It's like magic! Notice that any Function or undefined attributes are ignored, since the former doesn't serialize, and the latter technically doesn't exist.

parse

But wait... what about querying DynamoDB? The data.Items that are found need to be parsed. Got you covered on that as well:

const { parse } = require('dynamoo')

dynamo.query(params, (err, data) =>
  console.log(data.Items.map(parse))
)

Notice that parse accepts a single Item. So for query you'll need to .map(), but for getItem, you can use it like this:

dynamo.getItem({ Key, TableName }, (err, data) =>
  console.log(parse(data.Item))
)

The careful observer will notice that - with the exception of Function and undefined attributes - the serialize and parse functions are isomorphic! :heart_eyes:

const { expect } = require('chai')

expect(parse(serialize(item))).to.eql(item)

Caveat emptor

By design, dynamoo only supports the following data types for attributes:

  • Array
  • Boolean
  • null
  • Number
  • Object
  • Set (of strings)
  • String

If you want to use any other fancier types, such as Map, or Set of numbers, etc., then you may need to do some additional work. Or file an issue. :wink: