variations.d.ts 1.1 KB

1234567891011121314151617181920212223242526272829
  1. /**
  2. * Get qualified sequence, adding optional `FE0F` wherever it might exist
  3. *
  4. * This might result in sequence that is not actually valid, but considering
  5. * that `FE0F` is always treated as optional, full sequence used in regex will
  6. * catch both qualified and unqualified emojis, so proper sequence will get
  7. * caught anyway. This function just makes sure that in case if sequence does
  8. * have `FE0F`, it will be caught by regex too.
  9. */
  10. declare function guessQualifiedEmojiSequence(sequence: number[]): number[];
  11. /**
  12. * Base type to extend
  13. */
  14. interface BaseSequenceItem {
  15. sequence: number[];
  16. sequenceKey?: string;
  17. }
  18. /**
  19. * Get qualified variations for emojis
  20. *
  21. * Also converts list to UTF-32 as needed and removes duplicate items
  22. */
  23. declare function getQualifiedEmojiVariation<T extends BaseSequenceItem>(item: T): T;
  24. /**
  25. * Get qualified emoji variations for set of emojis, ignoring duplicate entries
  26. */
  27. declare function getQualifiedEmojiVariations<T extends BaseSequenceItem>(items: T[]): T[];
  28. export { getQualifiedEmojiVariation, getQualifiedEmojiVariations, guessQualifiedEmojiSequence };