kirax

README

Kirax

A very opianated/experimental state management for Go

Documentation

Index

• func Clone(target interface{}) (reflect.Value, error)
• type Action
• type Listener
• type SnapShot
• type Store
  • func NewStore(initState interface{}) *Store
  • func (s *Store) AddListener(path string) <-chan SnapShot
  • func (s *Store) AddModifier(action string, modifier interface{}) error
  • func (s *Store) Dispatch(action Action) error
  • func (s *Store) GetState() (interface{}, error)
  • func (s *Store) GetStateByPath(path string) (interface{}, error)
  • func (s *Store) Patch(path string, payload interface{}) error
  • func (s *Store) RemoveListener(path string) error

Functions

func Clone

func Clone(target interface{}) (reflect.Value, error)

Clone a value

Types

type Action

type Action struct {
	Name    string
	Payload interface{}
}

Action to be dispatched

type Listener

type Listener chan SnapShot

Listener channel to SnapShot changes

type SnapShot

type SnapShot struct {
	When  time.Time
	Data  interface{}
	Error error
}

SnapShot snapshots of values

type Store

type Store struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Store main struct

func NewStore

func NewStore(initState interface{}) *Store

NewStore creates a new store based on a state

func (*Store) AddListener

func (s *Store) AddListener(path string) <-chan SnapShot

AddListener returns a channel to changes according to a path

func (*Store) AddModifier

func (s *Store) AddModifier(action string, modifier interface{}) error

AddModifier adds a func that modifies the state, according to a Action name

func (*Store) Dispatch

func (s *Store) Dispatch(action Action) error

Dispatch actions to modify the state

func (*Store) GetState

func (s *Store) GetState() (interface{}, error)

GetState get copy of the current state

func (*Store) GetStateByPath

func (s *Store) GetStateByPath(path string) (interface{}, error)

GetStateByPath get copies of the current state according to a path

func (*Store) Patch

func (s *Store) Patch(path string, payload interface{}) error

Patch state according to a path

func (*Store) RemoveListener

func (s *Store) RemoveListener(path string) error

RemoveListener removes and close the listener channel