README
¶
GoMoji 🔥
A high-performance Go library for working with emojis in strings, offering fast emoji detection, manipulation, and information retrieval.
Table of Contents
Installation
Prerequisites
- Go 1.11 or higher (for module support)
Installing
go get -u github.com/forPelevin/gomoji
Features
- 🔎 Fast emoji detection in strings
- 👪 Find all emoji occurrences with detailed information
- 🌐 Access comprehensive emoji database
- 🧹 Remove emojis from strings
- ↔️ Replace emojis with custom characters
- ↕️ Custom emoji replacement functions
- 🧐 Detailed emoji information lookup
Usage Examples
Check for Emojis
package main
import "github.com/forPelevin/gomoji"
func main() {
hasEmoji := gomoji.ContainsEmoji("hello world 🤗")
println(hasEmoji) // true
}
Find All Emojis
emojis := gomoji.FindAll("🧖 hello 🦋 world")
// Returns slice of Emoji structs with detailed information
Remove Emojis
cleaned := gomoji.RemoveEmojis("🧖 hello 🦋 world")
println(cleaned) // "hello world"
Replace Emojis
// Replace with a specific character
replaced := gomoji.ReplaceEmojisWith("🧖 hello 🦋 world", '_')
println(replaced) // "_ hello _ world"
// Replace with custom function
customReplaced := gomoji.ReplaceEmojisWithFunc("🧖 hello 🦋 world", func(em Emoji) string {
return em.Slug
})
println(customReplaced) // "person-in-steamy-room hello butterfly world"
Get Emoji Information
info, err := gomoji.GetInfo("🦋")
if err == nil {
println(info.Slug) // "butterfly"
println(info.UnicodeName) // "E3.0 butterfly"
println(info.Group) // "Animals & Nature"
}
API Documentation
Emoji Structure
type Emoji struct {
Slug string `json:"slug"` // Unique identifier
Character string `json:"character"` // The emoji character
UnicodeName string `json:"unicode_name"` // Official Unicode name
CodePoint string `json:"code_point"` // Unicode code point
Group string `json:"group"` // Emoji group category
SubGroup string `json:"sub_group"` // Emoji subgroup category
}
Core Functions
ContainsEmoji(s string) bool- Checks if a string contains any emojiFindAll(s string) []Emoji- Finds all unique emojis in a stringRemoveEmojis(s string) string- Removes all emojis from a stringReplaceEmojisWith(s string, c rune) string- Replaces emojis with a specified characterGetInfo(emoji string) (Emoji, error)- Gets detailed information about an emojiAllEmojis() []Emoji- Returns all available emojis
Performance
GoMoji is designed for high performance, with parallel processing capabilities for optimal speed. Here are the key benchmarks:
| Operation | Sequential Performance | Parallel Performance | Allocations |
|---|---|---|---|
| Contains Emoji | 57.49 ns/op | 7.167 ns/op | 0 B/op, 0 allocs/op |
| Remove Emojis | 1454 ns/op | 201.4 ns/op | 68 B/op, 2 allocs/op |
| Find All | 1494 ns/op | 313.8 ns/op | 288 B/op, 2 allocs/op |
| Get Info | 8.591 ns/op | 1.139 ns/op | 0 B/op, 0 allocs/op |
| Replace With Slug | 3822 ns/op | 602.4 ns/op | 160 B/op, 3 allocs/op |
Full benchmark details:
go test -bench=. -benchmem -v -run Benchmark ./...
goos: darwin
goarch: arm64
pkg: github.com/forPelevin/gomoji
cpu: Apple M1 Pro
BenchmarkContainsEmojiParallel-10 164229604 7.167 ns/op 0 B/op 0 allocs/op
BenchmarkContainsEmoji-10 20967183 57.49 ns/op 0 B/op 0 allocs/op
BenchmarkReplaceEmojisWithSlugParallel-10 2160638 602.4 ns/op 160 B/op 3 allocs/op
BenchmarkReplaceEmojisWithSlug-10 309879 3822 ns/op 160 B/op 3 allocs/op
BenchmarkRemoveEmojisParallel-10 5794255 201.4 ns/op 68 B/op 2 allocs/op
BenchmarkRemoveEmojis-10 830334 1454 ns/op 68 B/op 2 allocs/op
BenchmarkGetInfoParallel-10 989043939 1.139 ns/op 0 B/op 0 allocs/op
BenchmarkGetInfo-10 139558108 8.591 ns/op 0 B/op 0 allocs/op
BenchmarkFindAllParallel-10 4029028 313.8 ns/op 288 B/op 2 allocs/op
BenchmarkFindAll-10 751990 1494 ns/op 288 B/op 2 allocs/op
Note: Benchmarks were performed on Apple M1 Pro processor. Your results may vary depending on hardware.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Contact
Vlad Gukasov @vgukasov
License
GoMoji is available under the MIT License. GoMoji source code is available under the MIT License.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrStrNotEmoji = errors.New("the string is not emoji")
)
errors
Functions ¶
func ContainsEmoji ¶
ContainsEmoji checks whether given string contains emoji or not. It uses local emoji list as provider.
func RemoveEmojis ¶ added in v1.1.1
RemoveEmojis removes all emojis from the s string and returns a new string.
func ReplaceEmojisWith ¶ added in v1.1.7
ReplaceEmojisWith replaces all emojis from the s string with the specified rune and returns a new string.
func ReplaceEmojisWithFunc ¶ added in v1.1.8
ReplaceEmojisWithFunc replaces all emojis from the s string with the result of the replacerFn function and returns a new string.
func ReplaceEmojisWithSlug ¶ added in v1.1.8
ReplaceEmojisWithSlug replaces all emojis from the s string with the emoji's slug and returns a new string.
Types ¶
type Emoji ¶
type Emoji struct {
Slug string `json:"slug"`
Character string `json:"character"`
UnicodeName string `json:"unicode_name"`
CodePoint string `json:"code_point"`
Group string `json:"group"`
SubGroup string `json:"sub_group"`
}
Emoji is an entity that represents comprehensive emoji info.
func CollectAll ¶ added in v1.1.4
CollectAll finds all emojis in given string. Unlike FindAll, this does not distinct repeating occurrences of emoji. If there are no emojis it returns a nil-slice.
Source Files