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

debif-ts

v0.0.3

Published

Encoder & decoder of the deterministic binary format

Downloads

7

Readme

Deterministic Binary Format DeBiF

Subject to change, don't use this.

A schemaless, type-length-value binary format that can express most of JSON. Basically CBOR but stricter and with an emphasis on the reader. The exact differences:

  • field names must be ordered (so reader can stop early if needed field is missing)
  • arrays/dicts have their size in bytes, not number of elements (so reader can easily skip the whole array/dict)
  • no indefinite lengths
  • every value must use the most compact packing
  • no integers are allowed that won't fit into a float64, i.e. -(1^53 - 1) … (1^53 - 1)
  • compact integer format for powers of two

TODO

  • Allow only specific types as key? Implement a special key type?
  • There is still a type free (7), maybe padded buffers
  • Really worth adding the offsets for numbers? (main reason: reader doesn't have to check for compactness)
  • Think on a equivalent float compactness scheme
  • Define proper order of map keys
  • Make this more formal

Format

A value is encoded as:

  • 3 bits as type:
  1. positive int
  2. negative int
  3. binary blob
  4. UTF-8 text string
  5. array of elements
  6. dictionary, alternating key and value
  7. float and special values (boolean)
  • 5 bits as length l
    • when < 16: l
    • when < 28: l is 2^(l - 12), i.e. 16, 32, 64, …, 32768
    • when = 28: l is next 1 byte + 16
    • when = 29: l is next 2 LE bytes + 16 + 2^8
    • when = 30: l is next 4 LE bytes + 16 + 2^8 + 2^16
    • when = 31: l is next 8 LE bytes + 16 + 2^8 + 2^16 + 2^32
  • the value:
    • if type is 0, 1, or 6 its value is the length
    • otherwise its value is the next n bytes, where n is the length