1.0.0 • Published 5 years ago

@baethon/munci v1.0.0

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

🖤💛 Mùnči Build status

example usage

Installation

npm i @baethon/munci

About

Mùnči is a simple one-way hash function which transforms given string to an emoji face. Package uses emoji set including people with all genders and skin tones.

Due to limited number of emojis it's highly possible that resulting emoji will be generated also for different string values.

Possible use cases:

  • logging stream (like... Slack!) when one needs to identify quickly a user
  • simplified avatar system

Usage

Package exports one function, which accepts a string value. There's no way to filter the set of emojis by gender or skin tone so it's possible that it will return weird results :)

const munci = require('@baethon/munci')

const userAvatar = munci('Jon Snow')

Testing

yarn test

Building

Package uses emojis set provided by emojilib. To reload/refresh it use:

yarn build

Credits