Commit graph

28 commits

Author SHA1 Message Date
Peter Taoussanis
b7b3a25a82 [doc] Updates for Trove, simplify examples 2025-06-20 10:53:06 +02:00
Peter Taoussanis
248e91f982 [nop] Misc improvements 2025-04-30 14:50:40 +02:00
Peter Taoussanis
f37f54e1da [mod] Rename "rate-limit" -> "limit"
Users caught by this change should receive a clear compile-time error.

Apologies for the nuissance!! This change is part of a final review
of names before the release of v1 final.
2025-03-10 13:02:57 +01:00
Peter Taoussanis
1f4b49a21a [mod] Rename "sample-rate" -> "sample"
Users caught by this change should receive a clear compile-time error.

Apologies for the nuissance!! This change is part of a final review
of names before the release of v1 final.
2025-03-10 13:02:57 +01:00
Peter Taoussanis
7cccf672f5 [mod] Rename "middleware" -> "transform" (xfn)
Users caught by this change should receive a clear compile-time error.

Apologies for the nuissance!! This change is part of a final review
of names before the release of v1 final.

Motivations:

  - "xfn" is a lot shorter than "middleware", making it more
    convenient to use at signal calls, compare:

    (log! {:middleware my-fn} "msg")
    (log! {:xfn my-fn} "msg"}

  - "middleware" was originally chosen to match Timbre's terminology,
    but actually carries some misleading connotations that in hindsight
    are probably better avoided while we still have the chance to change
    this.
2025-03-10 13:02:57 +01:00
Peter Taoussanis
7d4aed60d8 [doc] Misc improvements 2025-01-22 14:52:38 +01:00
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
Peter Taoussanis
cca8bb33ff [doc] Misc improvements 2024-12-22 13:58:03 +01:00
Peter Taoussanis
e1dcdc8257 [doc] Misc improvements 2024-10-29 10:02:13 +01:00
Peter Taoussanis
280ad0823f [doc] Collapsible examples in README 2024-10-29 10:02:13 +01:00
Peter Taoussanis
0ca48fa6a1 [doc] Misc improvements 2024-10-29 10:02:13 +01:00
Peter Taoussanis
d9c3583631 [new] Add :rate-limit-by option to all signal creators
When present, will cause limits to be per [expansion, by-value]
2024-09-20 22:55:12 +02:00
Peter Taoussanis
e4a0a41a1b [doc] Misc improvements 2024-09-20 22:55:12 +02:00
Peter Taoussanis
824ebc7802 [doc] Update docs and examples 2024-08-28 09:17:33 +02:00
Peter Taoussanis
8066776a80 [doc] Update docs and examples 2024-08-26 09:57:29 +02:00
Peter Taoussanis
ddc9480d20 [doc] Update docs and examples 2024-08-23 14:06:02 +02:00
Peter Taoussanis
a39b720935 [doc] Doc and example improvements 2024-08-08 10:55:30 +02:00
Peter Taoussanis
946240dda4 [doc] Doc and example improvements 2024-08-07 11:37:00 +02:00
Peter Taoussanis
ca9b27f895 [new] Updates for latest Encore signal toolkit changes 2024-05-23 09:43:55 +02:00
Peter Taoussanis
1f624b6d50 [mod] pr-signal: switch to single (opts) arity only
For consistency with other utils and handlers
2024-05-08 09:35:02 +02:00
Peter Taoussanis
0ff8dafaf3 [nop] Housekeeping 2024-05-06 14:13:54 +02:00
Peter Taoussanis
21cb44e709 [mod] Rename, refactor signal formatting utils
- Simplified some util name (only relevant to folks customizing handler behaviour)
- Merged `format-signal->edn-fn`, `format-signal->json-fn` to single `pr-signal-fn`
2024-05-05 13:58:34 +02:00
Peter Taoussanis
f3659146bf [doc] Doc improvements 2024-05-05 13:58:16 +02:00
Peter Taoussanis
12f4b35d71 [doc] Documentation improvements 2024-04-29 12:15:19 +02:00
Peter Taoussanis
5484f13481 [doc] Documentation work 2024-04-19 12:41:11 +02:00
Peter Taoussanis
ee8505933c [doc] Documentation work 2024-04-17 15:51:24 +02:00
Peter Taoussanis
614e2a2b03 [new] Additional examples 2024-04-12 17:50:06 +02:00
Peter Taoussanis
0222bf4ee0 [nop] Misc housekeeping 2024-03-14 10:23:23 +01:00