emojify.js

/** @module emojify-hashes */

/**
 * A predefined Array of unicode emojis
 */
export const emojiArray = [
  '⌚', '⌨', '⏏', '⏯', '⏰', '⏱', '⏳', '☀', '☂', '☄', '☎', '☑', '☔', '☘', '☝', '☠', '☢', '☮', '☯', '♀', '♂', '♟', '♠', '♣', '♥', '♨', '♻', '♾', '♿', '⚒', '⚓', '⚔', '⚕', '⚖', '⚙', '⚛', '⚠', '⚧', '⚪', '⚰', '⚽', '⛄', '⛈', '⛏', '⛑', '⛓', '⛔', '⛩', '⛪', '⛰', '⛲', '⛴', '⛵', '⛷', '⛸', '⛺', '⛽', '✂', '✅', '✈', '✉', '✊', '✋', '✍', '✏', '✒', '✔', '✖', '❗', '❣', '❤', '⭐', '⭕', '🀄', '🃏', '🌀', '🌁', '🌂', '🌃', '🌄', '🌅', '🌆', '🌇', '🌈', '🌉', '🌊', '🌋', '🌍', '🌐', '🌑', '🌓', '🌕', '🌙', '🌚', '🌛', '🌝', '🌟', '🌡', '🌭', '🌮', '🌰', '🌲', '🌴', '🌶', '🌷', '🌸', '🌹', '🌺', '🌻', '🌼', '🌽', '🌾', '🌿', '🍀', '🍁', '🍂', '🍃', '🍄', '🍅', '🍆', '🍇', '🍈', '🍉', '🍋', '🍌', '🍍', '🍎', '🍐', '🍑', '🍒', '🍓', '🍔', '🍕', '🍖', '🍗', '🍘', '🍙', '🍚', '🍛', '🍜', '🍝', '🍞', '🍟', '🍠', '🍡', '🍢', '🍣', '🍤', '🍥', '🍦', '🍧', '🍨', '🍩', '🍪', '🍫', '🍬', '🍭', '🍮', '🍯', '🍰', '🍱', '🍲', '🍳', '🍴', '🍵', '🍶', '🍷', '🍸', '🍹', '🍺', '🍼', '🍽', '🍾', '🎀', '🎁', '🎂', '🎃', '🎄', '🎅', '🎆', '🎇', '🎈', '🎉', '🎊', '🎋', '🎌', '🎍', '🎎', '🎏', '🎐', '🎑', '🎒', '🎖', '🎙', '🎚', '🎞', '🎠', '🎡', '🎢', '🎣', '🎤', '🎥', '🎦', '🎧', '🎨', '🎩', '🎪', '🎫', '🎬', '🎭', '🎮', '🎯', '🎰', '🎱', '🎲', '🎳', '🎴', '🎵', '🎶', '🎷', '🎸', '🎹', '🎺', '🎻', '🎼', '🎽', '🎾', '🎿', '🏀', '🏁', '🏂', '🏃', '🏅', '🏆', '🏇', '🏈', '🏉', '🏊', '🏋', '🏌', '🏍', '🏏', '🏐', '🏑', '🏒', '🏔', '🏕', '🏖', '🏗', '🏘', '🏙', '🏚', '🏛', '🏜', '🏝', '🏞', '🏠', '🏡', '🏢', '🏤', '🏥', '🏦', '🏧', '🏨', '🏩', '🏪', '🏫', '🏬', '🏭', '🏮', '🏯', '🏳', '🏴', '🏵', '🏷', '🏸', '🏹', '🏺', '🏻', '🏼', '🏽', '🏾', '🏿', '🐀', '🐁', '🐂', '🐃', '🐄', '🐅', '🐆', '🐈', '🐉', '🐊', '🐌', '🐍', '🐏', '🐑', '🐓', '🐔', '🐕', '🐖', '🐗', '🐘', '🐙', '🐚', '🐛', '🐜', '🐝', '🐞', '🐟', '🐠', '🐡', '🐢', '🐣', '🐤', '🐥', '🐦', '🐧', '🐨', '🐪', '🐫', '🐬', '🐭', '🐮', '🐯', '🐰', '🐱', '🐲', '🐳', '🐴', '🐵', '🐶', '🐷', '🐸', '🐹', '🐺', '🐻', '🐼', '🐽', '🐿', '👀', '👁', '👂', '👃', '👄', '👅', '👆', '👇', '👈', '👉', '👊', '👋', '👌', '👍', '👎', '👏', '👐', '👑', '👒', '👓', '👔', '👕', '👖', '👗', '👘', '👙', '👚', '👛', '👜', '👝', '👞', '👟', '👠', '👡', '👢', '👣', '👥', '👦', '👧', '👨', '👩', '👪', '👬', '👮', '👯', '👰', '👱', '👲', '👳', '👴', '👵', '👶', '👷', '👸', '👹', '👺', '👻', '👼', '👽', '👾', '👿', '💀', '💁', '💂', '💃', '💄', '💅', '💆', '💇', '💈', '💉', '💊', '💋', '💌', '💍', '💎', '💏', '💐', '💑', '💒', '💓', '💔', '💕', '💖', '💗', '💘', '💙', '💚', '💛', '💜', '💝', '💞', '💟', '💠', '💡', '💢', '💣', '💤', '💥', '💦', '💧', '💨', '💩', '💪', '💫', '💭', '💮', '💯', '💰', '💱', '💲', '💳', '💴', '💶', '💸', '💹', '💺', '💻', '💼', '💽', '💾', '💿', '📀', '📁', '📂', '📃', '📄', '📅', '📆', '📇', '📈', '📉', '📊', '📋', '📌', '📍', '📎', '📏', '📐', '📑', '📒', '📓', '📔', '📕', '📖', '📗', '📘', '📙', '📚', '📛', '📜', '📝', '📞', '📟', '📠', '📡', '📢', '📣', '📤', '📥', '📦', '📧', '📨', '📩', '📪', '📬', '📮', '📯', '📰', '📱', '📲', '📳', '📵', '📶', '📸', '📹', '📺', '📻', '📽', '📿', '🔀', '🔁', '🔃', '🔄', '🔅', '🔆', '🔈', '🔉', '🔊', '🔋', '🔌', '🔍', '🔎', '🔏', '🔐', '🔑', '🔒', '🔓', '🔕', '🔖', '🔗', '🔘', '🔙', '🔚', '🔛', '🔜', '🔝', '🔞', '🔟', '🔠', '🔡', '🔢', '🔣', '🔤', '🔥', '🔦', '🔧', '🔨', '🔩', '🔪', '🔬', '🔮', '🔯', '🔰', '🔱', '🔲', '🔳', '🔴', '🔵', '🔶', '🔷', '🔸', '🔹', '🔺', '🔻', '🔼', '🕉', '🕋', '🕌', '🕍', '🕐', '🕯', '🕳', '🕴', '🕵', '🕶', '🕷', '🕸', '🕺', '🖇', '🖊', '🖋', '🖌', '🖐', '🖕', '🖤', '🖥', '🖨', '🖱', '🖼', '🗂', '🗃', '🗑', '🗒', '🗜', '🗝', '🗡', '🗣', '🗨', '🗯', '🗳', '🗺', '🗻', '🗼', '🗽', '🗾', '😀', '😁', '😂', '😃', '😄', '😅', '😇', '😉', '😊', '😋', '😌', '😎', '😏', '😐', '😑', '😒', '😓', '😕', '😖', '😗', '😘', '😙', '😚', '😛', '😜', '😝', '😟', '😠', '😡', '😢', '😣', '😤', '😦', '😨', '😩', '😪', '😬', '😭', '😮', '😰', '😱', '😲', '😴', '😵', '😶', '😷', '😸', '😹', '😺', '😻', '😼', '😽', '😾', '😿', '🙁', '🙂', '🙃', '🙅', '🙆', '🙇', '🙈', '🙉', '🙊', '🙋', '🙌', '🙍', '🙎', '🚀', '🚁', '🚃', '🚄', '🚆', '🚇', '🚈', '🚉', '🚊', '🚌', '🚍', '🚎', '🚏', '🚐', '🚑', '🚒', '🚔', '🚕', '🚖', '🚗', '🚘', '🚙', '🚛', '🚜', '🚝', '🚞', '🚟', '🚠', '🚢', '🚣', '🚤', '🚦', '🚧', '🚨', '🚩', '🚪', '🚫', '🚬', '🚮', '🚯', '🚰', '🚲', '🚳', '🚴', '🚶', '🚷', '🚹', '🚺', '🚻', '🚼', '🚽', '🚿', '🛀', '🛁', '🛂', '🛃', '🛄', '🛋', '🛌', '🛍', '🛎', '🛐', '🛑', '🛕', '🛖', '🛠', '🛡', '🛢', '🛣', '🛤', '🛩', '🛫', '🛰', '🛳', '🛴', '🛵', '🛷', '🛹', '🛺', '🛻', '🟠', '🟡', '🟢', '🟣', '🟤', '🤌', '🤍', '🤎', '🤐', '🤑', '🤒', '🤓', '🤔', '🤕', '🤖', '🤗', '🤙', '🤚', '🤛', '🤜', '🤝', '🤟', '🤠', '🤡', '🤢', '🤣', '🤤', '🤥', '🤦', '🤨', '🤩', '🤪', '🤫', '🤬', '🤭', '🤮', '🤰', '🤱', '🤳', '🤴', '🤵', '🤶', '🤷', '🤸', '🤹', '🤼', '🤽', '🤿', '🥀', '🥁', '🥂', '🥃', '🥄', '🥇', '🥈', '🥉', '🥊', '🥌', '🥍', '🥎', '🥐', '🥑', '🥒', '🥓', '🥔', '🥕', '🥖', '🥗', '🥘', '🥙', '🥚', '🥛', '🥜', '🥝', '🥟', '🥠', '🥡', '🥢', '🥣', '🥤', '🥥', '🥦', '🥧', '🥨', '🥩', '🥪', '🥬', '🥭', '🥮', '🥯', '🥱', '🥲', '🥳', '🥴', '🥵', '🥷', '🥺', '🥻', '🥼', '🥽', '🥾', '🦀', '🦁', '🦂', '🦃', '🦅', '🦆', '🦇', '🦈', '🦉', '🦊', '🦋', '🦌', '🦍', '🦎', '🦏', '🦐', '🦒', '🦓', '🦔', '🦕', '🦖', '🦘', '🦙', '🦚', '🦛', '🦜', '🦝', '🦞', '🦟', '🦠', '🦡', '🦣', '🦥', '🦦', '🦧', '🦨', '🦩', '🦫', '🦬', '🦮', '🦰', '🦱', '🦲', '🦳', '🦴', '🦵', '🦶', '🦷', '🦸', '🦺', '🦻', '🦼', '🦽', '🦾', '🧀', '🧁', '🧃', '🧄', '🧅', '🧆', '🧇', '🧈', '🧉', '🧋', '🧍', '🧎', '🧐', '🧑', '🧒', '🧓', '🧔', '🧕', '🧖', '🧗', '🧘', '🧙', '🧚', '🧛', '🧜', '🧝', '🧞', '🧟', '🧠', '🧡', '🧢', '🧣', '🧤', '🧥', '🧧', '🧨', '🧩', '🧪', '🧫', '🧬', '🧭', '🧮', '🧯', '🧰', '🧱', '🧲', '🧳', '🧴', '🧵', '🧶', '🧷', '🧸', '🧹', '🧺', '🧻', '🧼', '🧽', '🧾', '🩰', '🩱', '🩲', '🩴', '🩸', '🩹', '🪀', '🪁', '🪃', '🪄', '🪅', '🪐', '🪑', '🪒', '🪓', '🪔', '🪖', '🪗', '🪘', '🪙', '🪚', '🪛', '🪜', '🪝', '🪞', '🪟', '🪠', '🪡', '🪢', '🪣', '🪤', '🪥', '🪦', '🪧', '🪰', '🪱', '🪲', '🪳', '🪴', '🪵', '🫀', '🫁', '🫐', '🫑', '🫒', '🫓', '🫔', '🫕'
]

/**
 * Crates a visualisation of hashes using unicode emoji
 * 
 * @param {string} hexString The hash to visualise
 * @param {Array=} emojis The alphabet to encode the `hexString` in
 * @returns {Array} An Array of 4 symbols (one-char Strings)
 * @throws {RangeError} Will throw if the input is not hexadecimal
 */
export default function emojify (hexString, emojis = emojiArray) {
  const hexRegEx = /^[0-9a-fA-F]+$/
  const numEmojis = 4
  const sliceSize = hexString.length / numEmojis
  const result = []

  if (!hexRegEx.test(hexString)) {
    throw RangeError(`Input "${hexString}" is not hexadecimal.`)
  }

  for (let i = 0; i < numEmojis; i++) {
    const startIndex = i * sliceSize
    const part = hexString.slice(startIndex, startIndex + sliceSize)
    result.push(emojis[BigInt('0x' + part) % BigInt(emojis.length)])
  }
  return result
}