sort-key
v1.0.0TypeScript
Tiny library for generating and parsing DynamoDB sort keys.
0/weekUpdated 3 years agoMITUnpacked: 12.0 KB
Published by Moshe Simantov
npm install sort-key🔑 Sort-Key
Tiny library for generating and parsing DynamoDB sort keys.
alt="Coverage Status" />
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
`bash`
npm i sort-key
Usage
`ts
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:
`ts
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"
``