See the version list below for details.
dotnet add package shortid --version 2.0.0
NuGet\Install-Package shortid -Version 2.0.0
<PackageReference Include="shortid" Version="2.0.0" />
paket add shortid --version 2.0.0
#r "nuget: shortid, 2.0.0"
// Install shortid as a Cake Addin #addin nuget:?package=shortid&version=2.0.0 // Install shortid as a Cake Tool #tool nuget:?package=shortid&version=2.0.0
A csharp library to generate completely random short id's. they can be used as primary keys or unique identifiers. This library is different in that you can specify the length of the id's generated. I have tested the application generating 200000 ids without duplicates.
How to use
To make use of the
shortid, add it to your project via the Nuget package manager UI or console via this command:
Add the following using command to the top of your csharp code file:
This gives your code access the classes and methods of the
To generate a unique id of any length between 7 and 14, you call the
Generate method without parameters.
string id = ShortId.Generate(); // id = KXTR_VzGVUoOY
If you want to include numbers in the generated id, then you call the
Generate method with a boolean indicating your preference.
string id = ShortId.Generate(true); // id = O_bBY-YUkJg
If you do not want special characters i.e _ and - in your generated id, then call the
Generate method with two boolean parameters, the first indicating whether or not you want numbers and the second indicating whether or not you want special characeters.
string id = ShortId.Generate(true, false); // id = waBfk3z
If you want to specify the length of the generated id, call the
Generate method with an integer parameter which is the desired length.
string id = ShortId.Generate(8); // id = M-snXzBk
If you want to control the type of id generated by specifying whether you want numbers, special characters and the length, call the
Generate method and pass three parameters, the first a boolean stating whether you want numbers, the second a boolean stating whether you want special characters, the last a number indicating your length preference.
string id = ShortId.Generate(true, false, 12); // id = VvoCDPazES_w
NOTE: when specifying the desired length, shorter lengths increase the possibility thata duplicate id would be generated
ShortId has several features that help with customizing the ids generated. Characters sets can be introduced and the random number generator can be seeded.
To change the character set in use, run the following:
string characters = //whatever you want; ShortId.SetCharacters(characters);
NOTE: the new character set must number
null, an empty string or whitespace. Also, all whitespace characters would be removed, finally the character set cannot be less than 20 characters.
ShortId also allows the seed for the random number generator to be set.
To set the seed, run the following:
int seed = 1939048828; ShortId.SetSeed(seed);
ShortId allows for all customizations to be reset using the following:
|Product||Versions Compatible and additional computed target framework versions.|
|.NET||net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed.|
|.NET Core||netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.|
|.NET Standard||netstandard1.3 is compatible. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 was computed. netstandard2.1 was computed.|
|.NET Framework||net40 is compatible. net403 was computed. net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.|
|MonoAndroid||monoandroid was computed.|
|MonoMac||monomac was computed.|
|MonoTouch||monotouch was computed.|
|Tizen||tizen30 was computed. tizen40 was computed. tizen60 was computed.|
|Universal Windows Platform||uap was computed. uap10.0 was computed.|
|Xamarin.iOS||xamarinios was computed.|
|Xamarin.Mac||xamarinmac was computed.|
|Xamarin.TVOS||xamarintvos was computed.|
|Xamarin.WatchOS||xamarinwatchos was computed.|
- No dependencies.
- No dependencies.
- No dependencies.
NuGet packages (10)
Showing the top 5 NuGet packages that depend on shortid:
Kotori core library.
Development framework accelarator
This package is not used by any popular GitHub repositories.
add thread safety and minimum length