https://github.com/atrox/haikunatordart
Generate Heroku-like random names to use in your dart applications
https://github.com/atrox/haikunatordart
dart haikunator heroku
Last synced: 3 months ago
JSON representation
Generate Heroku-like random names to use in your dart applications
- Host: GitHub
- URL: https://github.com/atrox/haikunatordart
- Owner: Atrox
- License: bsd-3-clause
- Created: 2015-04-02T16:22:00.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-08-09T08:28:48.000Z (almost 8 years ago)
- Last Synced: 2024-04-16T02:16:00.180Z (about 2 years ago)
- Topics: dart, haikunator, heroku
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/haikunator
- Size: 5.86 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HaikunatorDART
[](https://travis-ci.org/Atrox/haikunatordart)
[](https://pub.dartlang.org/packages/haikunator)
Generate Heroku-like random names to use in your dart applications.
## Installation
Add the following to your `pubspec.yaml` and run `pub get`:
```yaml
dependencies:
haikunator: any
```
## Usage
Haikunator is pretty simple.
```dart
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:
```dart
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:
- [Report bugs](https://github.com/Atrox/haikunatordart/issues)
- Fix bugs and [submit pull requests](https://github.com/Atrox/haikunatordart/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
## Other Languages
Haikunator is also available in other languages. Check them out:
- Node: https://github.com/Atrox/haikunatorjs
- PHP: https://github.com/Atrox/haikunatorphp
- Python: https://github.com/Atrox/haikunatorpy
- Ruby: https://github.com/usmanbashir/haikunator
- Go: https://github.com/yelinaung/go-haikunator