Code Monkey home page Code Monkey logo

ksuid's Introduction

KSUID

Clojars Project

KSUID implemented in Clojure.

What is a KSUID?

KSUID is a K-Sortable Unique Identifier. It stores a time component besides the random payload and thus can be sorted based on generation time. This library follows the original Segment's KSUID implementation which has a 1 second precision on the timestamp.

Read more here on why to use it over other identifiers.

Install

Leiningen

[com.github.toanphan19/ksuid "0.2.0"]

Clojure CLI/deps.edn

com.github.toanphan19/ksuid {:mvn/version "0.2.0"}

Usage

Import into your namespace

(ns my.ns
  (:require [ksuid.core :as ksuid]))

Generate a new KSUID

(ksuid/new-random)
=> {:timestamp 261641632,
    :payload [-104, -49, ...],
    :bytes [15, -104, 85, -96, -104, -49, ...]}

;; Get the string representation
(ksuid/to-string (ksuid/new-random))
=> "2DdhyDxLNUQWoag0Webut0ahEVc"
;; Extract the time
(ksuid/time-instant (ksuid/new-random))
=> #object[java.time.Instant 0xda0dc02 "2022-08-27T23:17:06Z"]

;; Comparison using their string representation
(let [a (ksuid/new-random)
      b (ksuid/new-random)]
  (compare (ksuid/to-string a) (ksuid/to-string b)))

KSUID from string

;; Decode a ksuid string
(ksuid/from-string "2DdhyDxLNUQWoag0Webut0ahEVc")
=> {:timestamp 261641632,
    :payload [-104, -49, ...],
    :bytes [15, -104, 85, -96, -104, -49, ...]}

ksuid's People

Contributors

toanphan19 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

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.