emoji

README

Emoji

Emoji is a simple golang package.

Get it:

go get github.com/kyokomi/emoji/v2

Import it:

import (
	"github.com/kyokomi/emoji/v2"
)

Usage

package main

import (
	"fmt"

	"github.com/kyokomi/emoji/v2"
)

func main() {
	fmt.Println("Hello World Emoji!")

	emoji.Println(":beer: Beer!!!")

	pizzaMessage := emoji.Sprint("I like a :pizza: and :sushi:!!")
	fmt.Println(pizzaMessage)
}

Demo

Reference

• unicode Emoji Charts

License

MIT

Documentation

Overview

Package emoji terminal output.

Index

• Variables
• func AliasList(shortCode string) []string
• func CodeMap() map[string]string
• func Errorf(format string, a ...interface{}) error
• func Fprint(w io.Writer, a ...interface{}) (int, error)
• func Fprintf(w io.Writer, format string, a ...interface{}) (int, error)
• func Fprintln(w io.Writer, a ...interface{}) (int, error)
• func HasAlias(shortCode string) bool
• func NormalizeShortCode(shortCode string) string
• func Print(a ...interface{}) (int, error)
• func Printf(format string, a ...interface{}) (int, error)
• func Println(a ...interface{}) (int, error)
• func RevCodeMap() map[string][]string
• func Sprint(a ...interface{}) string
• func Sprintf(format string, a ...interface{}) string

Variables

var (
	ReplacePadding = " "
)

Replace Padding character for emoji.

Functions

func AliasList

func AliasList(shortCode string) []string

func CodeMap

func CodeMap() map[string]string

CodeMap gets the underlying map of emoji.

func Errorf

func Errorf(format string, a ...interface{}) error

Errorf is fmt.Errorf which supports emoji

func Fprint

func Fprint(w io.Writer, a ...interface{}) (int, error)

Fprint is fmt.Fprint which supports emoji

func Fprintf

func Fprintf(w io.Writer, format string, a ...interface{}) (int, error)

Fprintf is fmt.Fprintf which supports emoji

func Fprintln

func Fprintln(w io.Writer, a ...interface{}) (int, error)

Fprintln is fmt.Fprintln which supports emoji

func HasAlias

func HasAlias(shortCode string) bool

HasAlias flags if the given `shortCode` has multiple aliases with other codes.

func NormalizeShortCode

func NormalizeShortCode(shortCode string) string

NormalizeShortCode normalizes a given `shortCode` to a deterministic alias.

func Print

func Print(a ...interface{}) (int, error)

Print is fmt.Print which supports emoji

func Printf

func Printf(format string, a ...interface{}) (int, error)

Printf is fmt.Printf which supports emoji

func Println

func Println(a ...interface{}) (int, error)

Println is fmt.Println which supports emoji

func RevCodeMap

func RevCodeMap() map[string][]string

RevCodeMap gets the underlying map of emoji.

func Sprint

func Sprint(a ...interface{}) string

Sprint is fmt.Sprint which supports emoji

func Sprintf

func Sprintf(format string, a ...interface{}) string

Sprintf is fmt.Sprintf which supports emoji