Skip to content
.NET implementation of ai's nanoid
Branch: master
Clone or download
codeyu Merge pull request #3 from plaptov/master
Use char[] instead of StringBuilder for perfomance
Latest commit 8bcacc1 Apr 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src/Nanoid
test/Nanoid.Test
.gitignore
.travis.yml
LICENSE
README.md
appveyor.yml
nanoid-net.sln

README.md

nanoid-net

Build Status Build status NuGet Badge License

This package is .NET implementation of ai's nanoid!

Safe. It uses cryptographically strong random generator.

Compact. It uses more symbols than UUID (A-Za-z0-9_~) and has the same number of unique options in just 22 symbols instead of 36.

Fast. Nanoid is as fast as UUID but can be used in URLs.

Install

Install with nuget:

PM> Install-Package Nanoid

Usage

Normal

The default method uses URL-friendly symbols (A-Za-z0-9_~) and returns an ID with 21 characters (to have a collision probability similar to UUID v4).

var id = Nanoid.Generate() //=> "Uakgb_J5m9g~0JDMbcJqLJ"

Symbols -,.() are not encoded in the URL. If used at the end of a link they could be identified as a punctuation symbol.

If you want to reduce ID length (and increase collisions probability), you can pass the size as an argument:

var id = Nanoid.Generate(size:10) //=> "IRFa~VaY2b"

Custom Alphabet or Length

If you want to change the ID's alphabet or length you can pass alphabet and size.

var id = Nanoid.Generate('1234567890abcdef', 10) //=> "4f90d13a42"

Alphabet must contain 256 symbols or less. Otherwise, the generator will not be secure.

Custom Random Bytes Generator

You can replace the default safe random generator using the System.Random class. For instance, to use a seed-based generator.

var random = Random(10);
var id = Nanoid.Generate(random, "abcdef", 10) //=> "fbaefaadeb"

Credits

License

The MIT License (MIT). Please see License File for more information.

You can’t perform that action at this time.