meineerde/rackstash
1
0
Fork 0
mirror of https://github.com/meineerde/rackstash.git synced 2026-01-31 17:27:13 +00:00
Code Issues Releases Activity

Document the error_flow parameter in Flow#initialize

Browse Source
This commit is contained in:
Holger Just 2018-01-12 20:38:47 +01:00
parent 2425fdea09
commit 0605fc433d
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/rackstash/flow.rb
View File

@ -75,6 +75,9 @@ module Rackstash
# this is not given, the adapter's default_encoder will be used.
# @param filters [Array<#call>] an array of filters. Can be a pre-defined
# {Filter}, a `Proc`, or any other object which responds to `call`.
# @param error_flow [Flow] a special flow which is used to write details
# about any occured errors during writing. By default, we use the global
# {Rackstash.error_flow} which logs JSON-formatted messages to `STDERR`.
# @yieldparam flow [self] if the given block accepts an argument, we yield
# `self` as a parameter, else, the block is directly executed in the
# context of `self`.