sort-key
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

🔑 Sort-Key

Tiny library for generating and parsing DynamoDB sort keys.

View On NPM Build Status Dependency Status Coverage Status License


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

Package Sidebar

Install

npm i sort-key

Weekly Downloads

52

Version

1.0.0

License

MIT

Unpacked Size

12 kB

Total Files

7

Last publish

Collaborators

  • moshe