Coder Social home page Coder Social logo

sqids / sqids-gdscript Goto Github PK

View Code? Open in Web Editor NEW
6.0 2.0 1.0 11 KB

Official GDScript (Godot Engine) port of Sqids. Generate short unique IDs from numbers.

Home Page: https://sqids.org/gdscript

License: MIT License

GDScript 100.00%
gdscript gdscript-language godot godot-engine hashids id id-generator short short-id short-url sqids uid unique-id unique-id-generator

sqids-gdscript's Introduction

Sqids (pronounced "squids") is a small library that lets you generate unique IDs from numbers. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups.

Features:

  • Encode multiple numbers - generate short IDs from one or several non-negative numbers
  • Quick decoding - easily decode IDs back into numbers
  • Unique IDs - generate unique IDs by shuffling the alphabet once
  • ID padding - provide minimum length to make IDs more uniform
  • URL safe - auto-generated IDs do not contain common profanity
  • Randomized output - ential input provides nonconsecutive IDs
  • Many implementations - Support for 40+ programming languages

๐Ÿงฐ Use-cases

Good for:

  • Generating IDs for public URLs (eg: link shortening)
  • Generating IDs for internal systems (eg: event tracking)
  • Decoding for quicker database lookups (eg: by primary keys)

Not good for:

  • Sensitive data (this is not an encryption library)
  • User IDs (can be decoded revealing user count)

๐Ÿ“ฆ Version compatibility

Supports Godot 4.2.2 and above.

๐Ÿ‘ฉโ€๐Ÿ’ป Examples

Simple encode & decode:

var sqids = Sqids.new()
var id = sqids.encode([1, 2, 3]) # "86Rf07"
var numbers = sqids.decode(id) # [1, 2, 3]

Note ๐Ÿšง Because of the algorithm's design, multiple IDs can decode back into the same sequence of numbers. If it's important to your design that IDs are canonical, you have to manually re-encode decoded numbers and check that the generated ID matches.

Enforce a minimum length for IDs:

var sqids = Sqids.new({
  min_length = 10
})
var id = sqids.encode([1, 2, 3]) # "86Rf07xd4z"
var numbers = sqids.decode(id) # [1, 2, 3]

Randomize IDs by providing a custom alphabet:

var sqids = Sqids.new({
  alphabet = "FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE",
})
var id = sqids.encode([1, 2, 3]) # "B4aajs"
var numbers = sqids.decode(id) # [1, 2, 3]

Prevent specific words from appearing anywhere in the auto-generated IDs:

var sqids = Sqids.new({
  blocklist = ["86Rf07"]
})
var id = sqids.encode([1, 2, 3]) # "se8ojk"
var numbers = sqids.decode(id) # [1, 2, 3]

๐Ÿชฒ Error handling

Any error produced during Sqids.new() will trigger an assertion in the debugger. This is to help you catch mistakes during development.

It is within sqids specification for sqids.encode() to fail. Since assertion only triggers in debug build, a failed encode will return null instead and print the reason to console. This is to make sure users can still handle the error in production.

๐Ÿ“ License

MIT

sqids-gdscript's People

Contributors

4kimov avatar tsfreddie avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

tsfreddie

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.