shortid 2.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package shortid --version 2.0.2
NuGet\Install-Package shortid -Version 2.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="shortid" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add shortid --version 2.0.2
#r "nuget: shortid, 2.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install shortid as a Cake Addin
#addin nuget:?package=shortid&version=2.0.2

// Install shortid as a Cake Tool
#tool nuget:?package=shortid&version=2.0.2

shortid

Build Status License: MIT NuGet Badge Coverage Status

About ShortId

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 180000 id's 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:

Install-Package shortid

Add the following using command to the top of your csharp code file:

using shortid;

This gives your code access the classes and methods of the shortid namespace.

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: v2.0.0 introduced a change that prevents lengths of less than 7

Customize ShortId

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 not be 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);

Finally, ShortId allows for all customizations to be reset using the following:

ShortId.Reset();
Product 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.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.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.1 is compatible.  netstandard1.2 was computed.  netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 was computed.  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. 
Windows Phone wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 1.1

    • No dependencies.
  • .NETStandard 1.3

    • No dependencies.
  • .NETStandard 1.6

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on shortid:

Package Downloads
Dmaal.Core.Helper

Package Description

kotori-core

Kotori core library.

Programatica.Framework.Mvc

Development framework accelarator

Yamf.Multitenancy

Package Description

PigeonMessenger

PigeonMessenger is supposed to act like Microsofts MessageCenter for Xamarin.Forms

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 1,134,167 4/21/2022
3.0.2 151 11/5/2023
3.0.1 815,528 4/11/2021
3.0.0 302,232 8/27/2020
2.0.4 38,891 8/26/2020
2.0.3 63,990 7/4/2020
2.0.2 6,857 6/29/2020
2.0.1 141,119 3/26/2020
2.0.0 451,595 3/9/2018
1.0.4 4,883 2/6/2018
1.0.3 9,971 11/27/2017
1.0.2 6,173 7/5/2017
1.0.1 1,101 6/13/2017
1.0.0 1,418 6/10/2017

- add a new configuration option
- add better thread safety features