Skip to content

Atrox/haikunator.net

Repository files navigation

Haikunator.NET

Build Status Latest Version Coverage Status

Generate Heroku-like random names to use in your .NET applications.

Installation

dotnet add package Haikunator

Usage

Haikunator is pretty simple.

var haikunator = new Haikunator();

// default usage
haikunator.Haikunate() // => "wispy-dust-1337"

// custom length (default=4)
haikunator.Haikunate(tokenLength: 6) // => "patient-king-887265"

// use hex instead of numbers
haikunator.Haikunate(tokenHex: true) // => "purple-breeze-98e1"

// use custom chars instead of numbers/hex
haikunator.Haikunate(tokenChars: "HAIKUNATE") // => "summer-atom-IHEA"

// don't include a token
haikunator.Haikunate(tokenLength: 0) // => "cold-wildflower"

// use a different delimiter
haikunator.Haikunate(delimiter: ".") // => "restless.sea.7976"

// no token, space delimiter
haikunator.Haikunate(tokenLength: 0, delimiter: " ") // => "delicate haze"

// no token, empty delimiter
haikunator.Haikunate(tokenLength: 0, delimiter: "") // => "billowingleaf"

// custom adjectives and nouns
haikunator.Adjectives = new[] {"red", "green", "blue"};
haikunator.Nouns = new[] {"reindeer", "cow", "kangaroo"};
haikunator.Haikunate() // => "green-cow-5426"

Options

The following options are available:

var haikunator = new Haikunator();
// var haikunator = new Haikunator(1234); // seed

haikunator.Adjectives = new[] {"set", "custom", "adjectives"};
haikunator.Nouns = new[] {"set", "custom", "nouns"};

haikunator.Haikunate(
  delimiter: "-",
  tokenLength: 4,
  tokenHex: false,
  tokenChars: "0123456789"
)

If tokenHex is true, it overrides any tokens specified in tokenChars

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

Other Languages

Haikunator is also available in other languages. Check them out: