Atrox / haikunatordart

Generate Heroku-like random names to use in your dart applications

Home Page:https://pub.dartlang.org/packages/haikunator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HaikunatorDART

Build Status Latest Version

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

Installation

Add the following to your pubspec.yaml and run pub get:

dependencies:
  haikunator: any

Usage

Haikunator is pretty simple.

import 'package:haikunator/haikunator.dart';

// 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"

Options

The following options are available:

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:

About

Generate Heroku-like random names to use in your dart applications

https://pub.dartlang.org/packages/haikunator

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Dart 100.0%