diff --git a/filtered_router.go b/filtered_router.go index a0458c4..edbeff4 100644 --- a/filtered_router.go +++ b/filtered_router.go @@ -1,6 +1,12 @@ package flog +// NewFilteredRouter returns an initialized FilteredRouter. +// +// 'subrouter' is the sub-router that a FilteredRouter will +// re-Route a 'message' (and 'context') to, but only on the +// condition that 'filterFn' returns 'true' for the 'message' +// and 'context' passed to it. func NewFilteredRouter(subrouter Router, filterFn func(string, map[string]interface{})bool) *FilteredRouter { router := FilteredRouter{ subrouter:subrouter, @@ -11,6 +17,7 @@ func NewFilteredRouter(subrouter Router, filterFn func(string, map[string]interf } +// FilteredRouter is a Router that conditionally routes or discards a message (and its context). type FilteredRouter struct { subrouter Router filterFn func(string, map[string]interface{})bool