localize

package

v0.8.3 Latest Latest Go to latest Published: Sep 9, 2021 License: Apache-2.0 Imports: 8 Imported by: 55

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Files    embed.FS
	Language *language.Tag
	Path     string
	Format   string
}

Config is a type which helps to get the information to initialize the localizer

type GoI18n struct {
	Localizer *i18n.Localizer
	// contains filtered or unexported fields
}

GoI18n is a type which stores the details to create bundle

func (i *GoI18n) LocalizeByID(messageId string, template ...*TemplateEntry) string

LocalizeByID helps in localizing by passing id present in local file pass dynamic value using template entries

func (i *GoI18n) MustLocalizeFile(files fs.FS, path string) (err error)

read the message file from the file system

type Localizer interface {
	// LocalizeById takes ID
	LocalizeByID(messageId string, template ...*TemplateEntry) string
}

Localizer is an Interface for localizing messages from locals

func New(cfg *Config) (Localizer, error)

type TemplateEntry struct {
	Key   string
	Value interface{}
}

TemplateEntry is a type which defines variable interpolation key:value pairs which are used to pass dynamic values to the template

func NewEntry(key string, val interface{}) *TemplateEntry

NewEntry returns a new template entry which is a type for interpolating a string