Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bolorundurowb/shortid
A csharp library to generate short id's. they can be used as primary keys or unique identifiers
https://github.com/bolorundurowb/shortid
csharp id-generation shortid
Last synced: 17 days ago
JSON representation
A csharp library to generate short id's. they can be used as primary keys or unique identifiers
- Host: GitHub
- URL: https://github.com/bolorundurowb/shortid
- Owner: bolorundurowb
- License: mit
- Created: 2017-06-09T09:23:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-05T01:12:06.000Z (about 1 year ago)
- Last Synced: 2024-05-16T07:40:34.847Z (6 months ago)
- Topics: csharp, id-generation, shortid
- Language: C#
- Size: 78.1 KB
- Stars: 221
- Watchers: 9
- Forks: 34
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# shortid
[](https://travis-ci.org/bolorundurowb/shortid) [](LICENSE) [](https://www.nuget.org/packages/shortid) [](https://coveralls.io/github/bolorundurowb/shortid?branch=master)
## 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 ids to be generated. This library is thread-safe and can generate millions of unique ids across multiple threads.
## Getting Started
To make use of the `shortid`, add it to your project via the Nuget package manager UI or console via this command:
#### Package Manager
```
Install-Package shortid
```
#### .NET CLI
```
> dotnet add package shortid
```
#### PackageReference
```csharp
```
## Usage
Add the following using command to the top of your csharp code file:
```csharp
using shortid;
using shortid.Configuration;
```
This gives your code access the classes and methods of the `shortid` namespace.
To generate a unique id of any length between 8 and 15, you call the `Generate` method without parameters.
```csharp
string id = ShortId.Generate();
// id = KXTR_VzGVUoOY
```
If you want to include numbers in the generated id, then you call the `Generate` method with options indicating your preference.
```csharp
var options = new GenerationOptions(useNumbers: true);
string id = ShortId.Generate(options);
// id = O_bBY-YUkJg
```
If you do not want special characters *i.e _ and -* in your generated id, then call the `Generate` method with options indicating your preferences.
```csharp
var options = new GenerationOptions(useSpecialCharacters: false);
string id = ShortId.Generate(options);
// id = waBfk3z
```
If you want to specify the length of the generated id, call the `Generate` method with options indicating your preferences.
```csharp
var options = new GenerationOptions(length: 9);
string id = ShortId.Generate(options);
// id = M-snXzBkj
```
## 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:
```csharp
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 and duplicate characters would be removed, finally the character set cannot be less than 50 characters.**
`ShortId` also allows the seed for the random number generator to be set.
To set the seed, run the following:
```csharp
int seed = 1939048828;
ShortId.SetSeed(seed);
```
Finally, `ShortId` allows for all customizations to be reset using the following:
```csharp
ShortId.Reset();
```