package definition

Import Path
	github.com/yuin/goldmark-emoji/definition (on go.dev)

Dependency Relation
	imports one package, and imported by 2 packages

Involved Source Files

	      definition.go
	      github.go
Package-Level Type Names (total 4, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Emoji (struct)
		Emoji is a data structure that holds a single emoji.

		Fields (total 3, all are exported)
			Name string
				Name is a name of this emoji.

			ShortNames []string
				ShortNames is a shorter representation of this emoji.

			Unicode []rune
				Unicode is an unicode representation of this emoji.

		Methods (only one, which is exported)
			(*T) IsUnicode() bool
				IsUnicode returns true if this emoji is defined in unicode, otherwise false.

		As Outputs Of (at least 2, both are exported)
			func NewEmoji(name string, unicode []rune, shortNames ...string) Emoji
			func Emojis.Get(shortName string) (*Emoji, bool)
		As Inputs Of (at least 3, all are exported)
			func NewEmojis(es ...Emoji) Emojis
			func WithEmojis(emojis ...Emoji) EmojisOption
			func github.com/yuin/goldmark-emoji/ast.NewEmoji(shortName []byte, value *Emoji) *ast.Emoji

	 type Emojis (interface)
		Emojis is a collection of emojis.

		Methods (total 3, all are exported)
			( T) Add(Emojis)
				Add adds new emojis to this collection.

			( T) Clone() Emojis
				Clone clones this collection.

			( T) Get(shortName string) (*Emoji, bool)
				Get returns (*Emoji, true) if found mapping associated with given short name, otherwise (nil, false).

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*emojis
		As Outputs Of (at least 3, all are exported)
			func Github(opts ...EmojisOption) Emojis
			func NewEmojis(es ...Emoji) Emojis
			func Emojis.Clone() Emojis
		As Inputs Of (at least 2, both are exported)
			func Emojis.Add(Emojis)
			func github.com/yuin/goldmark-emoji.WithEmojis(value Emojis) emoji.Option
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var github

	 type EmojisOption (func)
		EmojisOption sets options for Emojis.

		As Outputs Of (at least one exported)
			func WithEmojis(emojis ...Emoji) EmojisOption
		As Inputs Of (at least one exported)
			func Github(opts ...EmojisOption) Emojis

	/* one unexported ... *//* one unexported: */
	 type emojis (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			children []Emojis
			list []Emoji
			m map[string]*Emoji
		Methods (total 3, all are exported)
			(*T) Add(emojis Emojis)
			(*T) Clone() Emojis
			(*T) Get(shortName string) (*Emoji, bool)
		Implements (at least one exported)
			*T : Emojis


Package-Level Functions (total 4, all are exported)

	 func Github(opts ...EmojisOption) Emojis
	 func NewEmoji(name string, unicode []rune, shortNames ...string) Emoji
		NewEmoji returns a new Emoji.

	 func NewEmojis(es ...Emoji) Emojis
		NewEmojis returns a new Emojis.

	 func WithEmojis(emojis ...Emoji) EmojisOption
		WithEmojis is an EmojisOption that adds emojis to the Emojis.


Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var github Emojis
	  var githubOnce sync.Once

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.