README
¶
goven
Introduction
This project uses the following dependencies:
Getting started
It is assumed that you have already worked with the Go environment. If this is not the case, see this page first.
Installation
Installation with go get
go get -u github.com/lukasl-dev/goven
Import
Standalone Import
import "github.com/lukasl-dev/goven"
Multiple Imports
import (
"github.com/lukasl-dev/goven"
)
Usage
Create an Oven
Non ipsum eu minim irure magna veniam dolore veniam adipisicing incididunt esse.
oven := goven.New(goven.Options{})
Options
Tempor labore cupidatat est sit tempor commodo officia tempor ipsum mollit sint.
goven.Options{
...
}
Capture an event
Quis qui officia in aliqua.
valueChannel, errorChannel := oven.Once("event", goven.Capture{}, func(ctx goven.Context) (interface{}, error) {
println("event captured")
return nil, nil
},
Capturing
Ullamco voluptate tempor aute veniam do occaecat.
goven.Capturing{
...
}
Emit an event
Anim Lorem sunt labore ad enim qui excepteur ut irure amet mollit veniam duis.
valueChannel, errorChannel := oven.Emit(goven.Context{
Events: []goven.Event{"event"},
}, goven.Emission{},
)
Emission
Nisi proident officia elit aliquip magna elit ullamco aliquip duis amet esse.
goven.Emission{
...
}
Emitter
Ex mollit veniam nostrud in.
Depository
Dolore anim labore sit incididunt aliquip eiusmod exercitation adipisicing ea culpa.
Capturer
Cupidatat aute ad magna in dolore veniam ad esse ipsum qui fugiat eiusmod eiusmod reprehenderit.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrorListenerNoAction = errors.New("no action set in listener")
)
Functions ¶
Types ¶
type CaptureFilterFunc ¶
type CaptureFunc ¶
type CaptureFunc = ListenerFunc
type CaptureItem ¶
type CaptureItem struct {
Trigger Event `json:"trigger,omitempty"`
Transmission Capturing `json:"transmission,omitempty"`
Action CaptureFunc `json:"-"`
}
type CaptureResult ¶
type Capturer ¶
type Capturer interface {
Once(trigger Event, capture Capturing, action CaptureFunc) (chan interface{}, chan error)
Many(items ...CaptureItem) []CaptureResult
}
type Capturing ¶
type Capturing struct {
Filter CaptureFilterFunc `json:"-"`
// contains filtered or unexported fields
}
type Depository ¶
type Emission ¶
type Emission struct {
ErrorHandler ErrorHandlerFunc `json:"-"`
IgnoreStars bool `json:"ignoreStars,omitempty"`
// contains filtered or unexported fields
}
type ErrorHandlerFunc ¶
type Listener ¶
type Listener struct {
Event `json:"event,omitempty"`
Action ListenerFunc `json:"-"`
// contains filtered or unexported fields
}
Source Files