Skip to content

Leismore Shorter ID is a universally unique identifier based on [Nano ID](https://github.com/ai/nanoid). This document describes its purpose, format, recommended comparison method, and other technical details.

License

Notifications You must be signed in to change notification settings

leismore/shorterid-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

Leismore ShorterID Specification v2.0.0 LTS


28 February 2023

Authors

Copyright

GNU Free Documentation License Version 1.3

Canonical URLs


Introduction

Leismore ShorterID is a universally unique identifier based on Nano ID (Sitnik [2017] 2021). This document describes its purpose, format, recommended comparison method, and other technical details.

Differences from Leismore ShortID

Leismore ShortID (Chine [2021] 2021) is designed for digital medias, while Leismore ShorterID is for non-digital medias such as paper and with more considerations for human readability or sharing requirements.

Comparison to Leismore ShortID (Chine [2021] 2021), Leismore ShorterID is:

  1. Shorter
  2. Case-insensitive
  3. Increased collision chance

Purpose and Designing Considerations

Ideally, a universally unique identifier exposing to end-users or external applications via non-digital medias, should be:

  1. No collision in the near future
  2. Friendly for human readers
  3. URL friendly character set
  4. Short and fixed length
  5. Case-insensitive

Format

  • Character set ( inspired by nolookalikes from Nanoid-Dictionary (Lashmanov [2018] 2021) ):
    •                `346789ABCDEFGHJKMNPQRTWXY`
      
  • Length: 16 characters
  • Canonical syntax: XXXX-XXXX-XXXX-XXXX (Uppercase)
  • Case-insensitive

Recommended Comparison Method

The - characters are used purely for the human readability reason. It must not be considered as a semantics part in Leismore ShorterID. While doing ID comparison, it must be removed from the IDs.

Chance of Collision

When 1,000 IDs are being generated per hour, in order to have a 1% probability of at least one collision, ~2 thousand years are needed, according to the calculation of Nano ID CC (Zhuravlёv n.d.)

References

About

Leismore Shorter ID is a universally unique identifier based on [Nano ID](https://github.com/ai/nanoid). This document describes its purpose, format, recommended comparison method, and other technical details.

Resources

License

Stars

Watchers

Forks

Packages

No packages published