Collision-resistant IDs, ported for Perl
Switch branches/tags
Clone or download
zakame .travis.yml: Adjust build jobs
- Add Perl 5.28
- Remove older Perl versions no longer officially supported (see https://metacpan.org/pod/perlpolicy#MAINTENANCE-AND-SUPPORT)
Latest commit e327600 Nov 10, 2018
Permalink
Failed to load latest commit information.
lib/Data
t
xt
.appveyor.yml
.gitignore
.travis.yml
Build.PL
Changes
LICENSE
META.json
README.md
cpanfile
minil.toml

README.md

Build Status Coverage Status MetaCPAN Release Build Status

NAME

Data::Cuid - collision-resistant IDs

SYNOPSIS

use Data::Cuid qw(cuid slug);

my $id   = cuid();          # cjg0i57uu0000ng9lwvds8vb3
my $slug = slug();          # uv1nlmi

DESCRIPTION

Data::Cuid is a port of the cuid JavaScript library for Perl.

Collision-resistant IDs (also known as cuids) are optimized for horizontal scaling and binary search lookup performance, especially for web or mobile applications with a need to generate tens or hundreds of new entities per second across multiple hosts.

Data::Cuid does not export any functions by default.

FUNCTIONS

cuid

my $cuid = cuid();

Produce a cuid as described in the original JavaScript implementation. This cuid is safe to use as HTML element IDs, and unique server-side record lookups.

slug

my $slug = slug();

Produce a shorter ID in nearly the same fashion as "cuid". This slug is good for things like URL slug disambiguation (i.e., example.com/some-post-title-<slug>) but is absolutely not recommended for database unique IDs.

SEE ALSO

Cuid

LICENSE

The MIT License (MIT)

Copyright (C) Zak B. Elep.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AUTHOR

Zak B. Elep zakame@cpan.org

Original cuid JavaScript library maintained by Eric Elliott