Funx Interactive Documentation

Explore functional programming patterns through live, executable examples. Interactive documentation that reflects the latest development version.

Note: These files are on GitHub and reflect the latest development version. For stable API reference, use the project's hex documentation.

Funx Interactive Documentation

Docker

Run them as a group for comprehensive exploration

git clone https://github.com/JKWA/funx.git

cd funx

docker compose up

Then open http://localhost:8090

Password: funxlib_12char

Launch in Livebook

Equality & Ordering

▶️ Eq Protocol - Domain-specific equality
▶️ Eq Utils - Equality utilities and combinators
▶️ Ord Protocol - Context-aware ordering
▶️ Ord Utils - Ordering utilities and combinators

Structure Operations

▶️ Foldable Protocol - Structure folding
▶️ Filterable Protocol - Conditional value retention

Monads

▶️ Monad Protocol - Monadic operations (map, bind, ap)

Maybe Monad

▶️ Maybe - Optional computation
▶️ Just - Maybe success case
▶️ Nothing - Maybe failure case

Either Monad

▶️ Either - Error handling and validation
▶️ Left - Either failure case
▶️ Right - Either success case

Effect Monad

▶️ Effect - Railway-oriented programming
▶️ Effect Context - Effect execution context
▶️ Effect Left - Effect failure case
▶️ Effect Right - Effect success case

Other Monads

▶️ Identity - Simple wrapper monad
▶️ Reader - Environment access
▶️ Writer - Computation with logging
▶️ Writer Result - Writer result wrapper

Monoids

▶️ Monoid Protocol - Identity and associative combination
▶️ Monoid Utils - Monoid utilities

Numeric Monoids

▶️ Sum - Addition monoid
▶️ Product - Multiplication monoid
▶️ Min - Minimum value monoid
▶️ Max - Maximum value monoid

Collection Monoids

▶️ List Concat - List concatenation
▶️ String Concat - String concatenation

Logic Monoids

▶️ Eq All - All-equality monoid
▶️ Eq Any - Any-equality monoid
▶️ Pred All - All-predicate monoid
▶️ Pred Any - Any-predicate monoid
▶️ Ord - Ordering monoid

Function Utilities

▶️ Utils - Currying and function transformation
▶️ Predicate - Logical composition

Data Structures

▶️ List - Set operations and deduplication
▶️ Range - Range utilities
▶️ Math - Mathematical operations

Protocols & Extensions

▶️ Appendable - Appendable protocol
▶️ Summarizable - Summarizable protocol

Error Handling

▶️ Effect Error - Effect error types
▶️ Validation Error - Validation error types

Development

▶️ Config - Configuration utilities
▶️ Macros - Macro utilities