Skip to content

Leismore Short 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/shortid-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 

Repository files navigation

Leismore ShortID Specification v4.0.0 LTS


27 February 2023

Authors

Copyright

GNU Free Documentation License Version 1.3

Canonical URLs


Introduction

Leismore ShortID 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.

Purpose and Designing Considerations

Ideally, a universally unique identifier exposing to end-users or external applications via 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

Format

  • Character set ( nolookalikes from Nanoid-Dictionary (Lashmanov [2018] 2021) ):
    •                `346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz`
      
  • Length: 20 characters
  • Canonical syntax: XXXX-XXXX-XXXX-XXXX-XXXX
  • Case-sensitive

Recommended Comparison Method

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

Chance of Collision

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

References

About

Leismore Short 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