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

idb-key-to-string

v0.2.0

Published

A simple string serialization for IndexedDB-like keys

Downloads

68

Readme

IDB Key to String

A simple string serialization for IndexedDB-like keys.

Many key-value stores only support string-based keys, but in JavaScript we'd like to use (composed) IndexedDB-like keys.

The goal of this format is human readability, minimal tagging, and leaving regular strings unmodified, so that the most common case carries no extra weight.

For tagging other types, 2 extra characters are used. This is the smallest sensible choice I could think of. Perhaps there's cleverer ways than prefixing, but hopefully not a simpler way.

Below are some notable examples:

'some key'        => 'some key' // (no extra quotes)
300               => 'n:300'
new Date(0)       => 'd:1970-01-01T00:00:00.000Z'
['foo', 'bar']    => '<foo|bar>'
['foo', [1, 2]]   => '<foo|<n:1|n:2>>'
'with|re<served>' => 's:with%7Cre%3Cserved%3E' // URL encoding iff necessary
'e:vil'           => 's:e%3Avil'

The last two examples show how strings containing array delimiters or conforming to the 2-char tagging schema are processed.

While mostly arbitrary, pointy brackets and pipes (<, >, |) were chosen as delimiters because

  1. they're part of ASCII (occupy single byte),
  2. less likely to be found in english text than parens and commas, and
  3. not part of stringified JSON. Even though it's bad practice to stringify JSON objects for use as keys, I don't want to make it worse by url-encoding the entire thing.

Round-tripping a key will process it according to KV Storage working draft: https://wicg.github.io/kv-storage/#key-round-trip