createEmoji - Photon

createEmoji(customEmoji?: T): { 100: EmojiValue; angry: EmojiValue; arrow_down: EmojiValue; arrow_left: EmojiValue; arrow_right: EmojiValue; arrow_up: EmojiValue; balloon: EmojiValue; beer: EmojiValue; bell: EmojiValue; black_circle: EmojiValue; blue_circle: EmojiValue; boom: EmojiValue; bug: EmojiValue; calendar: EmojiValue; chart_down: EmojiValue; chart_up: EmojiValue; check: EmojiValue; clap: EmojiValue; clipboard: EmojiValue; clock: EmojiValue; cloud: EmojiValue; coffee: EmojiValue; confetti: EmojiValue; confused: EmojiValue; cool: EmojiValue; cry: EmojiValue; email: EmojiValue; exclamation: EmojiValue; eyes: EmojiValue; facepalm: EmojiValue; file: EmojiValue; fire: EmojiValue; folder: EmojiValue; gear: EmojiValue; gift: EmojiValue; green_circle: EmojiValue; grimace: EmojiValue; hammer: EmojiValue; heart: EmojiValue; hourglass: EmojiValue; hug: EmojiValue; inbox: EmojiValue; info: EmojiValue; key: EmojiValue; laugh: EmojiValue; lightbulb: EmojiValue; lightning: EmojiValue; link: EmojiValue; lock: EmojiValue; love_eyes: EmojiValue; medal: EmojiValue; megaphone: EmojiValue; memo: EmojiValue; mind_blown: EmojiValue; muscle: EmojiValue; neutral: EmojiValue; ok_hand: EmojiValue; outbox: EmojiValue; package: EmojiValue; party: EmojiValue; pin: EmojiValue; pizza: EmojiValue; point_down: EmojiValue; point_left: EmojiValue; point_right: EmojiValue; point_up: EmojiValue; pray: EmojiValue; question: EmojiValue; rain: EmojiValue; rainbow: EmojiValue; raised_hands: EmojiValue; red_circle: EmojiValue; refresh: EmojiValue; relieved: EmojiValue; rocket: EmojiValue; rolling_eyes: EmojiValue; sad: EmojiValue; shrug: EmojiValue; sick: EmojiValue; sleeping: EmojiValue; smile: EmojiValue; snow: EmojiValue; sparkles: EmojiValue; speech_bubble: EmojiValue; star: EmojiValue; stop: EmojiValue; sun: EmojiValue; surprised: EmojiValue; thinking: EmojiValue; thumbs_down: EmojiValue; thumbs_up: EmojiValue; trophy: EmojiValue; unlock: EmojiValue; warning: EmojiValue; wave: EmojiValue; white_circle: EmojiValue; wink: EmojiValue; worried: EmojiValue; wrench: EmojiValue; x: EmojiValue; yellow_circle: EmojiValue; zany: EmojiValue } & { custom: (name: string) => EmojiValue } & unknown

Create a type-safe emoji helper with custom emoji. Returns immutable singleton EmojiValue objects that support:

Object identity comparison (event.emoji === emoji.thumbs_up)
Template string interpolation (${emoji.thumbs_up} → “{{emoji:thumbs_up}}”)

Custom emoji are automatically registered with the default resolver, so placeholders will convert correctly in messages.

// First, extend the CustomEmojiMap type (usually in a .d.ts file)
declare module "chat" {
  interface CustomEmojiMap {
    unicorn: EmojiFormats;
    company_logo: EmojiFormats;
  }
}

// Then create the emoji helper with your custom emoji
const emoji = createEmoji({
  unicorn: { slack: "unicorn_face", gchat: "🦄" },
  company_logo: { slack: "company", gchat: "🏢" },
});

// Object identity works for comparisons
if (event.emoji === emoji.unicorn) { ... }

// Template strings work for messages
await thread.post(`${emoji.unicorn} Magic!`);
// Slack: ":unicorn_face: Magic!"
// GChat: "🦄 Magic!"

Parameters

T

Returns

EmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValueEmojiValue

⌘I