0.1.1 • Published 2 years ago

fun-animal-names v0.1.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Fun Animal Names

This module hashes strings into fun animal names.

This project was scaffolded with TSDX.

import { funAnimalName } from 'fun-animal-names'

const name = funAnimalName('abc123')
console.log(name) // 'Perfect Duck'

You can also specify the set of animal names and adjectives to use:

import { funAnimalName } from 'fun-animal-names'

const name = funAnimalName('abc123', {
  adjectives: ['Happy'],
  animalNames: ['Goldfish'],
})
console.log(name) // 'Happy Goldfish'

Jest

You can verify functionality with:

npm run test

Bundle Analysis

size-limit is set up to calculate the real cost of the library with npm run size and visualize the bundle with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

Continuous Integration

GitHub Actions

  • main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
  • size which comments cost comparison of your library on every pull request using size-limit

License

MIT.