Skip to content

feat: add library-effects.md intro and summary table #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
magnus-madsen merged 1 commit into from
Mar 10, 2026
Merged

feat: add library-effects.md intro and summary table #303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/library-effects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
# Library Effects

Flix provides several built-in library effects for common I/O operations. These
effects all have default handlers, so no explicit `runWithIO` is needed in
`main`.

| Effect | Module | Description |
|---------------------------------|---------------------------|--------------------------------------------------------------------------------------------------|
| [Assert](./assert.md) | `Assert` | Runtime assertions (`assertTrue`, `assertEq`, etc.) with configurable handlers. |
| [Console](./console.md) | `Sys.Console` | Terminal I/O: reading input, printing to stdout/stderr, prompts, and menus. |
| [Http / Https](./http-https.md) | `Net.Http`, `Net.Https` | Sending HTTP requests with a fluent API, middleware (retries, rate limiting, circuit breakers). |
| [Process](./process.md) | `Sys.Process` | Spawning and managing OS processes. |