🔑 Sort-Key

Tiny library for generating safe sort keys for DynamoDB.

Generating DynamoDB sort keys from multiple string parts as recommended by AWS. It uses # as separator and knows how to escape it when given on one of the key parts.

[country]#[region]#[state]#[county]#[city]#[neighborhood]

Install

npm i sort-key

Usage

import SortKey from 'sort-key';

const SK = SortKey.generate('1532208', '2020-09-11T15:30:06.822Z');
// 1532208#2020-09-11T15:30:06.822Z

const [order, time] = SortKey.parse(SK);
// "1532208" "2020-09-11T15:30:06.822Z"

It supports escaping as well:

const SK = SortKey.generate(
  'example.com',
  'foo',
  'https://example.com/foo/bar#top',
);
// example.com#foo#https://example.com/foo/bar\#top

const [domain, page, url] = SortKey.parse(SK);
// "example.com" "foo" "https://example.com/foo/bar#top"

License

MIT license © 2020 Neuledge