luciano/telemere
1
0
Fork 0
mirror of https://github.com/taoensso/telemere.git synced 2025-12-20 11:01:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[doc] Clarify help:signal-creators arg order

Browse source
This commit is contained in:
Peter Taoussanis 2024-08-14 11:42:34 +02:00
parent 4d2b5d4642
commit 24d9827dae
2 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
resources/signal-docstrings/signal-creators.txt
View file

@ -14,13 +14,13 @@ various keys:
Creators vary only in in their default options and call APIs (expected args Creators vary only in in their default options and call APIs (expected args
and return values), making them more/less convenient for certain use cases: and return values), making them more/less convenient for certain use cases:
`log!` ---------- [message + opts/level] => true iff signal was created (allowed) `event!` -------- [id ] or [id opts/level] => true iff signal was created (allowed)
`event!` -------- [id + opts/level] => true iff signal was created (allowed) `log!` ---------- [msg ] or [opts/level msg] => true iff signal was created (allowed)
`error!` -------- [error + opts/id ] => given error (unconditional) `error!` -------- [error] or [opts/id error] => given error (unconditional)
`trace!` -------- [form + opts/id ] => form result (value/throw) (unconditional) `trace!` -------- [form ] or [opts/id form] => form result (value/throw) (unconditional)
`spy!` ---------- [form + opts/level] => form result (value/throw) (unconditional) `spy!` ---------- [form ] or [opts/level form] => form result (value/throw) (unconditional)
`catch->error!` - [error + opts/id ] => form value, or given fallback `catch->error!` - [form ] or [opts/id form] => form value, or given fallback
`signal!` ------- [ opts ] => depends on options `signal!` ------- [opts ] => depends on options
- `log!` and `event!` are both good default/general-purpose signal creators. - `log!` and `event!` are both good default/general-purpose signal creators.
- `log!` emphasizes messages, while `event!` emphasizes ids. - `log!` emphasizes messages, while `event!` emphasizes ids.

16
src/taoensso/telemere.cljc
View file

@ -82,14 +82,14 @@
(impl/defhelp help:environmental-config :environmental-config)) (impl/defhelp help:environmental-config :environmental-config))
;;;; Signal creators ;;;; Signal creators
;; - signal! [ opts] ; => allowed? / run result (value or throw) ;; - event! [id ] [id opts/level] ; id + ?level => allowed? ; Sole signal with descending main arg!
;; - event! [id ] [id level-or-opts] ; id + ?level => allowed? ; Sole signal with descending main arg! ;; - log! [msg ] [opts/level msg] ; msg + ?level => allowed?
;; - log! [msg ] [level-or-opts msg] ; msg + ?level => allowed? ;; - error! [error] [opts/id error] ; error + ?id => given error
;; - error! [error] [id-or-opts error] ; error + ?id => given error ;; - trace! [form ] [opts/id form] ; run + ?id => run result (value or throw)
;; - trace! [form ] [id-or-opts form] ; run + ?id => run result (value or throw) ;; - spy! [form ] [opts/level form] ; run + ?level => run result (value or throw)
;; - spy! [form ] [level-or-opts form] ; run + ?level => run result (value or throw) ;; - catch->error! [form ] [opts/id form] ; run + ?id => run value or ?return
;; - catch->error! [form ] [id-or-opts form] ; run + ?id => run value or ?return ;; - signal! [opts ] ; => allowed? / run result (value or throw)
;; - uncaught->error! [ ] [id-or-opts ] ; ?id => nil ;; - uncaught->error! [opts/id] ; ?id => nil
#?(:clj #?(:clj
(defmacro event! (defmacro event!