Sentix v1.0.3 Sentix.Bridge.Options

This module handles option parsing for the command line flags Sentix allows using against fswatch. We separate this into a new module to aid testing and keep all logic contained.

Summary

Functions

defaults()

Simple accessor for default options

parse(options \\ [])

Parses out any option flags into command line arguments

parse!(options \\ [])

Functionally identical to parse/1, but extracts the options instead of returning as a Tuple

Functions

defaults()

defaults() :: options :: [binary]

Simple accessor for default options.

This only exists so that we may verify them from test code.

parse(options \\ [])

parse(options :: Keyword.t) :: options :: [binary]

Parses out any option flags into command line arguments.

This function may return arbitrarily nested lists which need flattened before being used to execute fswatch. Please see Sentix.start_link/3 for a list of available options which can be used.

parse!(options \\ [])

parse!(options :: Keyword.t) :: options :: [binary]

Functionally identical to parse/1, but extracts the options instead of returning as a Tuple.