core

Documentation

Index

• type API
  • func NewApi(l *Logger) *API
  • func (r *API) GetCore() *fiber.App
  • func (r *API) GetRouter() fiber.Router
• type Database
  • func NewDatabase(l *Logger) *Database
  • func (db *Database) GetCore() *gorm.DB
• type Logger
  • func NewLogger() *Logger
  • func (l *Logger) GetCore() *slog.Logger
• type PubSub
  • func NewPubSub(l *Logger) *PubSub
  • func (ps *PubSub) GetCore() *gochannel.GoChannel
  • func (ps *PubSub) GetRouter() *message.Router

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API responsible to deliver communication of application and client via http transport.

func NewApi

func NewApi(l *Logger) *API

func (*API) GetCore

func (r *API) GetCore() *fiber.App

func (*API) GetRouter

func (r *API) GetRouter() fiber.Router

type Database

type Database struct {
	// contains filtered or unexported fields
}

func NewDatabase

func NewDatabase(l *Logger) *Database

func (*Database) GetCore

func (db *Database) GetCore() *gorm.DB

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger act application logging using slog, standard Go library for structured log. This dependency could also be used by the package by injecting it at initialization.

func NewLogger

func NewLogger() *Logger

func (*Logger) GetCore

func (l *Logger) GetCore() *slog.Logger

type PubSub

type PubSub struct {
	// contains filtered or unexported fields
}

PubSub responsible for communication intermediary between packages. The core is using watermill GoChannel pub/sub implementation and could be replaced by any other type as long as it's still using watermill package, otherwise the router wouldn't work as expected.

func NewPubSub

func NewPubSub(l *Logger) *PubSub

func (*PubSub) GetCore

func (ps *PubSub) GetCore() *gochannel.GoChannel

func (*PubSub) GetRouter

func (ps *PubSub) GetRouter() *message.Router