strongforce

README

Strongforce

Create highly consistent microservice architectures
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Create highly consistent microservice architectures using the outbox pattern combined with the NATS eventing platform.

Getting Started

TODO

Prerequisites

TODO

Usage

TODO

Contribution guide

Guidelines

• Use conventional commit messages
• Always create a PR against the dev branch
• Use the pre-commit tool to verify your code before committing

Setup pre-commit hooks

brew install pre-commit
pre-commit install

License

MIT

Documentation

Index

• Variables
• type Client
  • func New(opts ...Option) (*Client, error)
  • func (sf *Client) Bus() bus.Bus
  • func (sf *Client) DB() db.DB
  • func (sf *Client) EventBuilder() *events.Builder
  • func (sf *Client) Init() error
  • func (sf *Client) TestHelper() *testhelper.TestHelper
• type Option
  • func WithDebeziumForwarder(options *forwarder.DebeziumOptions) Option
  • func WithForwarder(options *forwarder.Options) Option
  • func WithLogger(logger *zap.Logger) Option
  • func WithMySQL(options *mysql.Options) Option
  • func WithNATS(options *nats.Options) Option
  • func WithPostgres(options *postgres.Options) Option
• type Options

Variables

var (
	ErrNoDB  = errors.New("no database configured")
	ErrNoBus = errors.New("no bus configured")
)

Types

type Client

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

func New

func New(opts ...Option) (*Client, error)

func (*Client) Bus

func (sf *Client) Bus() bus.Bus

func (*Client) DB

func (sf *Client) DB() db.DB

func (*Client) EventBuilder

func (sf *Client) EventBuilder() *events.Builder

func (*Client) Init

func (sf *Client) Init() error

func (*Client) TestHelper

func (sf *Client) TestHelper() *testhelper.TestHelper

type Option

type Option func(o *clientOptions)

func WithDebeziumForwarder

func WithDebeziumForwarder(options *forwarder.DebeziumOptions) Option

func WithForwarder

func WithForwarder(options *forwarder.Options) Option

func WithLogger

func WithLogger(logger *zap.Logger) Option

func WithMySQL

func WithMySQL(options *mysql.Options) Option

func WithNATS

func WithNATS(options *nats.Options) Option

func WithPostgres

func WithPostgres(options *postgres.Options) Option

type Options

type Options struct {
	DB     db.DB
	Bus    bus.Bus
	Logger *zap.Logger
}