{"id":13912410,"url":"https://github.com/vinhvn/randimals","last_synced_at":"2025-07-18T12:30:48.064Z","repository":{"id":43126469,"uuid":"374008263","full_name":"vinhvn/randimals","owner":"vinhvn","description":"Generate adorable and unique animal IDs for your projects","archived":false,"fork":false,"pushed_at":"2022-03-17T17:31:21.000Z","size":686,"stargazers_count":10,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-05T06:24:32.722Z","etag":null,"topics":["adjective","animal","generator","random","string"],"latest_commit_sha":null,"homepage":"https://vinhvn.github.io/randimals","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vinhvn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-05T03:06:42.000Z","updated_at":"2023-04-04T16:37:43.000Z","dependencies_parsed_at":"2022-08-29T23:50:52.840Z","dependency_job_id":null,"html_url":"https://github.com/vinhvn/randimals","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhvn%2Frandimals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhvn%2Frandimals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhvn%2Frandimals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhvn%2Frandimals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vinhvn","download_url":"https://codeload.github.com/vinhvn/randimals/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226403770,"owners_count":17619720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adjective","animal","generator","random","string"],"created_at":"2024-08-07T01:01:26.097Z","updated_at":"2024-11-25T21:31:10.818Z","avatar_url":"https://github.com/vinhvn.png","language":"TypeScript","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"\u003cdiv style=\"text-align:center\"\u003e\n  \u003cimg src=\"./docs/randimals-banner.png\" width=\"1024px\"\u003e\n\u003c/div\u003e\n\n\u003e Generate adorable and unique animal IDs for your projects.\n\nYou can find the package on NPM at [npmjs.com/package/randimals](https://www.npmjs.com/package/randimals)\n\n## Demo\n\nYou can find a live demo at [vinhvn.github.io/randimals](https://vinhvn.github.io/randimals).\n\n## Usage\n\nStart by installing the package locally into your project:\n\n```bash\n$ npm install randimals\n# or\n$ yarn add randimals\n```\n\n### Examples\n\n```js\nconst randimals = require('randimals');\n\n// Default arguments generate an animal with one adjective\nconsole.log(randimals());\n// =\u003e \"Astronomical Wallaby\"\n\n// Using a number as an argument specifies the amount of adjectives\nconsole.log(randimals(3));\n// =\u003e \"Wearable Ceramic Responsible Grizzlybear\"\n\n// Using a string as an argument specifies the naming convention\nconsole.log(randimals('snake'));\n// =\u003e \"depressed_alligator\"\n\n// Combine and mess around with different options!\nconsole.log(randimals({\n  adjectives: 2,\n  animals: 2,\n  case: 'upper',\n  separator: '.'\n}));\n// \"DESIROUS.UNINSPIRED.COW.GRUB\"\n```\n\n## Command Line Tool\n\nIf you install the package globally, you can use the command line tool:\n\n```bash\n$ npm install -g randimals\n# or\n$ yarn global add randimals\n```\n\n### CLI Examples\n\n```shell\n# default with no arguments\n$ randimals\nBouncy Goose\n\n# change amount of adjectives and animals\n$ randimals -a 3 -n 2\nBeamy Illtimed Comparable Neonbluehermitcrab Hoiho\n\n# set the naming convention\n$ randimals -f path\nprolific/galapagosalbatross\n\n# mix and match options\n$ randimals -a 2 -c capital -s \"_\"\nGimmicky_Slippery_Raven\n```\n\n### CLI Usage\n\n```shell\n$ randimals -h\n\n  Usage: randimals [options]\n\n  Options:\n    -V, --version              output the version number\n    -a, --adjectives \u003cnumber\u003e  set the number of adjectives to output (default: \"1\")\n    -n, --animals \u003cnumber\u003e     set the number of animals to output (default: \"1\")\n    -f, --format \u003cstring\u003e      set the naming convention for each word (ex: 'pascal', 'snake', 'capital', etc.) (default: \"capital\")\n    -c, --case \u003cstring\u003e        set the case for each word (ex: 'lower', 'upper', 'capital')\n    -s, --separator \u003cstring\u003e   set the separator string between each adjective and noun\n    -h, --help                 display help for command\n```\n\n## About\n\nA simple package that I made to emulate the random string generation that Twitch and GfyCat use for their sites. I wanted to use the strings as unique IDs in another project of mine so I decided to try writing a package myself. In the process, I learned a lot more about the TypeScript, Gulp, Browserify, and module ecosystem 😓\n\n## Notes\n\nBig thank you to GfyCat for the adjective and animal lists. Logo image is taken from [OpenMoji 13.0](https://openmoji.org/)\n\n## License\n\nUnder the MIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinhvn%2Frandimals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvinhvn%2Frandimals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinhvn%2Frandimals/lists"}