enumx

Documentation

Overview

Package enumx is the catalog of the enums of a project: every allowed value of a status, a provider or a type with its description, for clients and for validation. The catalog is generated from the go-enum markers of the domain package, as in taply.

Index

• type Catalog
  • func (c Catalog) Find(entity, name string) (Enum, bool)
  • func (c Catalog) Valid(entity, name, value string) bool
• type Entity
• type Enum
• type Value

Types

type Catalog

type Catalog []Entity

Catalog is every enum of the project, ordered as the markers ask.

func (Catalog) Find

func (c Catalog) Find(entity, name string) (Enum, bool)

Find returns an enum by entity and name.

func (Catalog) Valid

func (c Catalog) Valid(entity, name, value string) bool

Valid reports whether a value is allowed for an enum, for validating input.

type Entity

type Entity struct {
	Entity      string `json:"entity"`
	Description string `json:"description"`
	Enums       []Enum `json:"enums"`
}

Entity groups the enums of one domain entity.

type Enum

type Enum struct {
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Values      []Value `json:"values"`
}

Enum is one enum of an entity, such as the status of an order.

type Value

type Value struct {
	Value       string `json:"value"`
	Description string `json:"description"`
}

Value is one allowed value.