telemere/projects/main/resources/signal-docstrings
Peter Taoussanis 0de5c094e5 [mod] Remove advanced options from catch->error!
`catch->error!` with default opts is quite handy for use with `trace!`/`spy!`.

But there's a lot that users might want to customize, including:

  - Exactly what error type to catch.
  - Whether or not to rethrow on catch.
  - Error binding sym to enable use within signal message, data, etc.

We could support all of this via `catch->error!` opts but there's not much
point. If anyway customizing such behaviour, it'd be better for the user to just
use an appropriate `try/catch`.

So I've now documented this recommendation, and removed all but the most basic
(:catch-val) options.

This is a BREAKING change for anyone that was previously using any of the
following options:

  :rethrow?
  :catch-sym

Note that `:rethrow?` was never particularly helpful (independently of
`:catch-val` anyway), and the removal of `:catch-sym` will throw a compile-time
error for any existing users.
2024-12-23 23:04:40 +01:00
..
catch-to-error!.txt [mod] Remove advanced options from catch->error! 2024-12-23 23:04:40 +01:00
environmental-config.txt [doc] Drop suggested edn suffixes from env config 2024-09-20 22:55:12 +02:00
error!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
event!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
log!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
signal!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
signal-content.txt [doc] Fix incorrect :msg_ key info 2024-10-29 10:02:13 +01:00
signal-creators.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
signal-options.txt [doc] Misc improvements 2024-12-22 13:58:03 +01:00
spy!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00
trace!.txt [new] Refactor impln of common signal creators 2024-12-23 12:30:00 +01:00