tfaker
Version:
Lightweight, Targaryen-themed lil' brother of faker.js
73 lines (70 loc) • 4.57 kB
Markdown
# tfaker.js
## Faking Targaryen data has never been easier
[](https://www.npmjs.com/package/tfaker)
[](https://travis-ci.org/TheRealBarenziah/tfaker.js)
[](https://snyk.io/test/github/TheRealBarenziah/tfaker.js?targetFile=package.json)
[](https://www.codacy.com/manual/TheRealBarenziah/tfaker.js?utm_source=github.com&utm_medium=referral&utm_content=TheRealBarenziah/tfaker.js&utm_campaign=Badge_Grade)
## Compatibility
[](https://nodejs.org/ca/blog/release/v0.10.48/)
Zero dependencies policy is to ensure **tfaker** long-term compatibility with 0.10.48.
## Import
```javascript
var tfaker = require("tfaker"); // everywhere with npm (tfaker is in node_modules)
var tfaker = require("./tfaker"); // locally with git clone (absolute path to tfaker/index.js)
```
## Methods
### Targaryens
- tfaker.firstName() `// random output => "Aegon"`
- tfaker.lastName() `// output => "Targaryen"`
- tfaker.fullName() `// random output => "Visenya Targaryen"`
- tfaker.dragon() `// random output => "Meraxes"`
- tfaker.email() `// random output => "dragonchan35@dragonstone.wst"`
- tfaker.country() `// random output => "Westeros"`
- tfaker.region() `// random output => "The Red Waste"`
- tfaker.city() `// random output => "Braavos"`
### Kittens
- tfaker.placeKitten() `// display 100px kitten image. output => "http://placekitten.com/100/100"`
**NB**: this method can also use one or two **Integer** arguments, translating into *width* & *height* in pixels:
```javascript
tfaker.placeKitten(420); // one parameter for squares => "http://placekitten.com/420/420"
tfaker.placeKitten(800, 600); // two for width & height => "http://placekitten.com/800/600"
```
### Utils
- tfaker.realDate() `// random Date(last century) => "Wed Jul 31 1985 00:10:18 GMT+0100(CEST)"`
- tfaker.islamicDate() `// islamic new Date(); output => "Jumuah, 28 Muharram 1441 AH"`
**NB**: this method accepts either an *adjustment* **Integer** parameter, or a *"zif"* / *"fake"* **string** parameter:
```javascript
tfaker.islamicDate(1); // returns islamicDate(1) +1 day => "Jumuah, 29 Muharram 1441 AH".
tfaker.islamicDate("zif"); // returns random past date within 8O years => "Sabt, 4 Jumadal Ula 1384 AH"
tfaker.islamicDate("fake"); // works the same
```
*Stumbled upon [this function][6] while searching for lunar calendars for Westeros. Since faker.js doesn't have this feature, I've thought it would be cool to have. Afterall the [Valyrian Freehold was very tolerant of other religions][7].*
___
## EZ Tweaks
Each file in `./content` is named after the method calling it, and is basically an array of content. You can customize any of those methods by dropping your stuff into the array.
___
## F.A.Q
### Have you heard about Babeljs
[Babeljs][5] is an awesome, one of a kind library * *thumbs up* *
### Issues (jk! if anything PLEASE DO)
### Pull Requests
### What's next
`./TODO.md`
## Credits
- [faker.js][1] obviously the main inspiration source. Excellent library that I intend to continue to use in harmony with mine.
- [Dany][2] for the `"bEsT sEaSoN eVEr"` and also best eyebrows.
- [placekitten.com][3] for the awesome free service. Click 'em
- [jeffreylancaster][4] This goldmine helped me to parse stuff like cities & regions. Thank you !
- [al-habib.info][6] Liked your function for being both concise and digestible.
[1]: https://github.com/marak/Faker.js/
[2]: https://www.instagram.com/emilia_clarke/
[3]: http://placekitten.com/
[4]: https://github.com/jeffreylancaster/game-of-thrones
[5]: https://github.com/babel/babel
[6]: https://www.al-habib.info/islamic-calendar/hijricalendartext.htm
[7]: https://gameofthrones.fandom.com/wiki/Valyrian_religion#In_the_books