addons

Documentation

Index

• func Initialize()
• func Register[T any](a *Addon[T])
• type Addon
  • func (a *Addon) CheckInitialized()
  • func (a *Addon) CheckNotInitialized()
  • func (a *Addon[T]) RegisterIfNeeded()
• type Definition
• type Description
  • func Enabled() []Description

Functions

func Initialize

func Initialize()

func Register

func Register[T any](a *Addon[T])

Types

type Addon

type Addon[T any] struct {
	Config     T
	Definition Definition
	// contains filtered or unexported fields
}

func (*Addon) CheckInitialized

func (a *Addon) CheckInitialized()

CheckInitialized checks that the addon has been initialized and therefore it is safe to assume that its configuration is final and that it has registered anything it needs with the rest of the system.

If not, it panics.

Includes a call to instance.CheckLockedDown.

func (*Addon) CheckNotInitialized

func (a *Addon) CheckNotInitialized()

CheckNotInitialized checks that the addon has not been initialized yet and therefore it is safe to apply customizations / configuration changes to it.

If not, it panics.

Includes a call to instance.CheckCanCustomize.

func (*Addon[T]) RegisterIfNeeded

func (a *Addon[T]) RegisterIfNeeded()

type Definition

type Definition struct {
	Name        string
	Description func() string
	Initialize  func() error
}

type Description

type Description struct {
	Name        string
	Description string
}

func Enabled

func Enabled() []Description