koalaified
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

Koalaified

A unique friendly name ID generator for JavaScript, with Australian animals

Generate unique IDs like distracted-corroboree-frog, perceptive-pacific-heron, uncreative-musk-lorikeet, or unprofessional-cockatoo. They're identifiers that's uniquely Aussie; they definitely stand out!

NPM Version Validate tests Release to NPM Release to Github Packages

Install

Add to your project:

yarn add koalaified

or

npm install koalaified

Usage

Both CommonJS and ESM bundles are built and available to use.

ESM

import { generate } from 'koalaified';

CJS

const { generate } = require('koalaified');

Usage

const friendlyName = generate();
console.log('Generated Friendly Name: ', friendlyName);

API

generate()

const friendlyName = generate({
    adjectiveCount: 2, // number, default: 1
    seperator: '_', // string, default: -
});

Develop

Install

yarn --dev

Build

yarn build

Test

yarn test

Contributions

This is a quick and dirty project, but feel free to contribute! Just pull a PR upstream and tag @pooh-bear.

This can generate 120k unique combinations with the default adjective count, but feel free to contribute more animals/adjectives.

License

MIT License

Copyright (c) Gabe Palomares

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact

Gabe PB (github.com/pooh-bear)
dev@gabe.pw

Dedication

To you cheeky countrypeople back down under.

Package Sidebar

Install

npm i koalaified

Weekly Downloads

23

Version

1.0.6

License

MIT

Unpacked Size

70.5 kB

Total Files

17

Last publish

Collaborators

  • pooh-bear