Skip to content

marcoonroad/ocaml-cuid

Repository files navigation

cuid

CUID generator for OCaml.

Ubuntu Workflow Status Windows Workflow Status MacOS Workflow Status Project License

For further information, please refer to http://usecuid.org

Installation

If available on OPAM, it's easily installed with:

$ opam install cuid

Otherwise, this library is also installable using Dune within this root directory:

$ dune install cuid

This cuid package is just an alias/wrapper around the cuid-unix package, there is a JavaScript-target package called cuid-jv as well.

Usage

As library:

let cuid = Cuid.generate ( )
(* cuid is "c00p6veue0000072slgr067a3", for example *)

There's also an implementation of CUID slugs. They fit in cases where collision-resistance is not important and when they are not generated too frequently. For instance, we can use them as URL suffixes for blog posts. To generate a CUID slug, just use:

let slug = Cuid.slug ( )
(* slug is "u90m0y0m", for example *)

For the cuid-unix internal package, the main module is called Cuid_unix, while the cuid-jv exposes the main module Cuid_jv.

Conclusion

PRs & issues are welcome. Have fun and imagine Sisyphus happy.

About

CUID generator for OCaml. 🆔 🐫 🔢 ⚙️

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published