Extended core library for Clojure/Script that emphasizes: * Cross-platform API * Flexibility * Performance * Backwards compatibility This lib's mostly for my own use and for advanced users that feel comfortable reading this source. Not providing much beginner-oriented documentation for this, sorry. Common naming conventions used across my libs: **foo** - Dynamic var foo! - Fn with side-effects, or that should otherwise be used cautiously foo? - Truthy val or fn that returns truthy val foo!? - Fn that has side-effects (or requires caution) and that return a truthy val. Note: !?, not ?! foo$ - Fn that's notably expensive to compute (e.g. hits db) foo_ - Derefable val (e.g. atom, volatile, delay, etc.) foo__ - Derefable in a derefable (e.g. delay in an atom), etc. _ - Unnamed val _foo - Named but unused val ?foo - Optional val (emphasize that val may be nil) foo* - A variation of `foo` (e.g. `foo*` macro vs `foo` fn) foo' - '' -foo - Public implementation detail or intermediate (e.g. uncoerced) val >foo - Val "to foo" (e.g. >sender, >host), or fn to put/coerce/transform <foo - Val "from foo" (e.g. <sender, <host), or fn to take/coerce/transform ->foo - Fn to put/coerce/transform Type affixes may be used for clarity: <prefix>-<name> - m-users, v-users, n-users, etc. (also nusers when unambiguous) <name>-<postfix> - users-map, users-vec, user-count, etc. Regarding name heirarchy: When there's a significant num of syms with a meaningful hierarchy, prefer names with descending hierarchy to emphasize structure and related groups/functionality, e.g.: `user-add`, `user-remove`, `user-mod` vs `add-user`, `remove-user`, `mod-user`, etc. Commit message tags (in priority order): [wip] - Work-in-progress (still under development) [mod] - Modify behaviour (=> breaking), [mod!], [mod!!], etc. for attention [fix] - Fix broken behaviour (=> usu. non-breaking) [new] - Add new behaviour (=> non-breaking) [doc] - Documentation changes besides those better labelled as [mod], [fix], or [new] [nop] - Other non-breaking changes (to implementation details, non-code changes, etc.) [x] [y] - Single commit with multiple tags (in priority order), try avoid Example commit messages: v1.0.0 (2022-01-27) ; Tagged release [new] [#122] Add new feature x (@contributor) Version numbers: Ver tables: X.Y.Z (without backticks) Min ver: vX.Y.Z+ Elsewhere: vX.Y.Z
(abbreviate-ns x)
(abbreviate-ns n-full x)
Give any nameable type (string, keyword, symbol), returns the same type with at most `n-full` (default 1) unabbreviated namespace parts. Example: (abbreviate-ns 0 :foo.bar/baz) => :f.b/baz (abbreviate-ns 1 'foo.bar/baz) => 'f.bar/baz (abbreviate-ns 2 "foo.bar/baz") => "foo.bar/baz"
(after-timeout msecs & body)
Alpha, subject to change. Returns a TimeoutFuture that will execute body after timeout. Body must be non-blocking or cheap.
(ajax-call url
{:keys [method params headers timeout-ms resp-type with-credentials?
xhr-pool xhr-cb-fn xhr-timeout-ms]
:as opts
:or {method :get
timeout-ms 10000
resp-type :auto
xhr-pool default-xhr-pool_
xhr-timeout-ms 2500}}
callback-fn)
Queues a lightweight Ajax call with Google Closure's `goog.net.XhrIo` and returns nil, or the resulting `goog.net.XhrIo` instance if one was immediately available from the XHR pool: (ajax-call "http://localhost:8080/my-post-route" ; Endpoint URL {:method :post ; ∈ #{:get :post :put} :resp-type :text ; ∈ #{:auto :edn :json :xml :text} :params {:username "Rich Hickey" :type "Awesome"} ; Request params :headers {"Content-Type" "text/plain"} ; Request headers :timeout-ms 7000 :with-credentials? false ; Enable if using CORS (requires xhr v2+) :xhr-pool my-xhr-pool ; Optional `goog.net.XhrIoPool` instance or delay :xhr-cb-fn (fn [xhr]) ; Optional fn to call with `XhrIo` from pool when available :xhr-timeout-ms 2500 ; Optional max msecs to wait on pool for `XhrIo` } (fn ajax-callback-fn [resp-map] (let [{:keys [success? ?status ?error ?content ?content-type]} resp-map] ;; ?status ; ∈ #{nil 200 404 ...}, non-nil iff server responded ;; ?error ; ∈ #{nil <http-error-status-code> <exception> :timeout :abort :http-error :exception :xhr-pool-depleted} (js/alert (str "Ajax response: " resp-map)))))
(as-?inst x)
Returns given ?arg as platform instant (`java.time.Instant` or `js/Date`), or nil.
(as-?udt x)
Returns given ?arg as (pos/neg) milliseconds since Unix epoch, or nil.
(assert-min-encore-version min-version)
Version check for dependency conflicts, etc.
(assoc-nx m m-kvs)
(assoc-nx m k v)
(assoc-nx m k v & kvs)
Assocs each kv to given ?map iff its key doesn't already exist.
(assoc-some m m-kvs)
(assoc-some m k v)
(assoc-some m k v & kvs)
Assocs each kv to given ?map iff its value is not nil.
(assoc-when m m-kvs)
(assoc-when m k v)
(assoc-when m k v & kvs)
Assocs each kv to given ?map iff its val is truthy.
(bench* nlaps
{:keys [nlaps-warmup nthreads as-ns?] :or {nlaps-warmup 0 nthreads 1}}
f)
Repeatedly executes fn and returns time taken to complete execution.
(binding bindings & body)
For Clj: faster version of `core/binding`. For Cljs: identical to `core/binding`.
(cache f)
(cache {:keys [size ttl-ms gc-every] :as opts} f)
Returns a cached version of given referentially transparent function `f`. Like `core/memoize` but: - Often faster, depending on options. - Prevents race conditions on writes. - Supports cache invalidation by prepending args with: - `:cache/del` ; Delete cached item for subsequent args, returns nil. - `:cache/fresh` ; Renew cached item for subsequent args, returns new val. - Supports options: - `ttl-ms` ; Expire cached items after <this> many msecs. - `size` ; Restrict cache size to <this> many items at the next garbage ; collection (GC). - `gc-every` ; Run garbage collection (GC) approximately once every ; <this> many calls to cached fn. If unspecified, GC rate ; will be determined automatically based on `size`. See also `defn-cached`, `fmemoize`, `memoize-last`.
(call-after-timeout msecs f)
(call-after-timeout impl_ msecs f)
Alpha, subject to change. Returns a TimeoutFuture that will execute `f` after given msecs. Does NOT do any automatic binding conveyance. Performance depends on the provided timer implementation (`impl_`). The default implementation offers O(logn) add, O(1) cancel, O(1) tick. See `ITimeoutImpl` for extending to arbitrary timer implementations.
(case-eval expr & clauses)
Like `case` but test expressions are evaluated for their compile-time value.
(case-insensitive-str= s1 s2)
Returns true iff given strings are equal, ignoring case.
(catching expr)
(catching error-type expr)
(catching try-expr error-sym catch-expr)
(catching try-expr error-sym catch-expr finally-expr)
(catching try-expr error-type error-sym catch-expr finally-expr)
Terse, cross-platform (try* expr (catch :all _)). Arities besides #{1 2} are deprecated, prefer `try*` in these cases.
(catching-rf rf)
(catching-rf error-fn rf)
Returns wrapper around given reducing function `rf` so that if `rf` throws, (error-fn <thrown-error> <contextual-data>) will be called. The default `error-fn` will rethrow the original error, wrapped in extra contextual information to aid debugging. See also `catching-xform`.
(catching-xform xform)
(catching-xform error-fn xform)
Like `catching-rf`, but applies to a transducer (`xform`). Makes debugging transductions much easier by greatly improving the information provided in any errors thrown by `xform` or the reducing fn: (transduce (catching-xform (comp (filter even?) (map inc))) ; Modified xform <reducing-fn> <...>)
(check-all test)
(check-all test & more)
Returns all logical false/throwing expressions (ids/forms), or nil.
(check-some test)
(check-some test & more)
Returns first logical false/throwing expression (id/form), or nil.
(comp-middleware fs)
(comp-middleware f1 f2)
(comp-middleware f1 f2 f3)
(comp-middleware f1 f2 f3 & fs)
Returns a single (composite) unary fn that applies all given unary fns sequentially (left->right!: f1, f2, ...). If any given fn returns nil, the returned composite fn immediately returns nil: ((comp-middleware inc #(* % 2) inc) 1) => 5 ; (inc (* (inc 1) 2)) ((comp-middleware inc (fn [_] nil) (fn [_] (throw (Exception. "Never thrown!")))) 1) => nil Useful for composing Ring-style middleware fns.
(compile-if test then)
(compile-if test then else)
Evaluates `test`. If it returns logical true (and doesn't throw), expands to `then`, otherwise expands to `else`.
(compiling-cljs?)
Return truthy iff currently generating Cljs code. See also `if-cljs`, `if-clj`.
(cond & clauses)
Supersets `core/cond` functionality. Like `core/cond` but supports implicit final `else` clause, and special clause keywords for advanced behaviour: (cond :let [x "x"] ; Establish let binding/s for remaining forms :binding [*x* "x"] ; Establish dynamic binding/s for remaining forms :do (println (str "x value: " x)) ; Eval expr for side-effects :if-let [y "y" z nil] "y and z were both truthy" :if-some [y "y" z nil] "y and z were both non-nil") `:let` support inspired by <https://github.com/Engelberg/better-cond>. Simple, flexible way to eliminate deeply-nested control flow code.
(conj-some)
(conj-some coll)
(conj-some coll x)
(conj-some coll x & more)
Conjoins each non-nil value.
(conj-when)
(conj-when coll)
(conj-when coll x)
(conj-when coll x & more)
Conjoins each truthy value.
(const-str= s1 s2)
Constant-time string equality checker. Useful to prevent timing attacks, etc.
(counter)
(counter init)
Returns a fast atomic `Counter` with `init` initial integer value with: - @counter => Return current val - (counter) => Add 1 and return old val - (counter n) => Add n and return old val - (counter action n) => Experimental, action ∈ {:add :set :set-get :get-set :get-add :add-get}.
(declare-remote & syms)
Declares given ns-qualified symbols, preserving metadata. Clj only. Useful for circular dependencies.
(defalias src)
(defalias alias src)
(defalias alias src alias-attrs)
(defalias alias src alias-attrs alias-body)
Defines a local alias for the var identified by given qualified source symbol: (defalias my-map clojure.core/map), etc. Source var's metadata will be preserved (docstring, arglists, etc.). Changes to Clj source var's value will also be applied to alias. See also `defaliases`.
(defaliases {:keys [alias src attrs body]} ...)
Bulk version of `defalias`. Takes source symbols or {:keys [alias src attrs body]} maps: (defaliases {:alias my-map, :src map, :attrs {:doc "My `map` alias"}} {:alias my-vec, :src vec, :attrs {:doc "My `vec` alias"}})
Simple one-timeout timeout implementation provided by platform timer. O(logn) add, O(1) cancel, O(1) tick. Fns must be non-blocking or cheap. Similar efficiency to core.async timers (binary heap vs DelayQueue).
(defn-cached sym cache-opts & body)
Defines a cached function. Like (def <sym> (cache <cache-opts> <body...>)), but preserves :arglists (arity) metadata as with `defn`: (defn-cached ^:private my-fn {:ttl-ms 500} "Does something interesting, caches resultes for 500 msecs" [n] (rand-int n))
(defonce sym & args)
Like `core/defonce` but supports docstring and attrs map.
(defstub sym)
Experimental, subject to change without notice!! Declares a stub var that can be initialized from any namespace with `unstub-<stub-name>`. Decouples a var's declaration (location) and its initialization (value). Useful for defining vars in a shared ns from elsewhere (e.g. a private or cyclic ns).
(deprecated & body)
Elides body when `taoensso.elide-deprecated` JVM property or `TAOENSSO_ELIDE_DEPRECATED` environment variable is ∈ #{"true" "TRUE"}.
(exp-backoff n-attempt)
(exp-backoff n-attempt {:keys [min max factor] :or {factor 1000}})
Returns binary exponential backoff value for n<=36.
(fast-merge maps)
(fast-merge m1 m2)
(fast-merge m1 m2 m3)
(fast-merge m1 m2 m3 m4)
Like `core/merge` but faster. Doesn't support zero arity, single arity case takes a collection of maps.
Returns true iff any files backing given named resources have changed since last call.
(filter-keys key-pred m)
Returns given ?map, retaining only keys for which (key-pred <key>) is truthy.
(filter-vals val-pred m)
Returns given ?map, retaining only keys for which (val-pred <val>) is truthy.
(finite-num? x)
Returns true iff given a number (of standard type) that is: finite (excl. NaN and infinities).
(float? x)
Returns true iff given a number (of standard type) that is: a fixed-precision floating-point (incl. NaN and infinities).
(fmemoize f)
For Clj: fastest possible memoize. Non-racey, 0-7 arity only. For Cljs: same as `core/memoize`.
(format fmt & args)
Like `core/format` but: * Returns "" when fmt is nil rather than throwing an NPE. * Formats nil as "nil" rather than "null". * Provides ClojureScript support via goog.string.format (this has fewer formatting options than Clojure's `format`!).
(format-inst inst)
Takes a platform instant (`java.time.Instant` or `js/Date`) and returns a formatted human-readable string in `ISO8601` format (`YYYY-MM-DDTHH:mm:ss.sssZ`), e.g. "2011-12-03T10:15:130Z".
(format-inst-fn)
(format-inst-fn {:keys [formatter zone]
:or {formatter java.time.format.DateTimeFormatter/ISO_INSTANT
zone java.time.ZoneOffset/UTC}})
(format-inst-fn)
(format-inst-fn {:keys [formatter]})
Experimental, subject to change without notice. Returns a (fn format [instant]) that: - Takes a platform instant (`java.time.Instant` or `js/Date`). - Returns a formatted human-readable instant string. Options: `:zone` (Clj only) `java.time.ZoneOffset` (defaults to UTC). `:formatter` `java.time.format.DateTimeFormatter` (Clj) or `goog.i18n.DateTimeFormat` (Cljs), Defaults to `ISO8601` formatter (`YYYY-MM-DDTHH:mm:ss.sssZ`), e.g.: "2011-12-03T10:15:130Z".
(format-nsecs nanosecs)
Returns given nanoseconds (long) as formatted human-readable string. Example outputs: "1.00m", "4.20s", "340ms", "822μs", etc.
(future* form)
(future* executor-service form)
Experimental, subject to change without notice! Like `future` but supports use of given custom `java.util.concurrent.ExecutorService`. Will default to using JVM 21+ virtual threads when possible, otherwise an unbounded fixed daemon thread pool. See also `future-call`, `virtual-executor`, `pool-executor`.
(future-call* f)
(future-call* executor-service f)
Experimental, subject to change without notice! Like `future-call` but supports use of given custom `java.util.concurrent.ExecutorService`. Will default to using JVM 21+ virtual threads when possible, otherwise an unbounded fixed daemon thread pool. See also `future`, `virtual-executor`, `pool-executor`.
(future-pool n-threads)
Returns a simple semaphore-limited wrapper of Clojure's standard `future`: (fn future-pool-fn ([f] [timeout-msecs timeout-val f] [] [timeout-msecs timeout-val])) Arities of returned function: [f] - Blocks to acquire a future, then executes (f) on that future. [ ] - Blocks to acquire ALL futures, then immediately releases them. Useful for blocking till all outstanding work completes. [timeout-msecs timeout-val f] - Variant of [f] with timeout [timeout-msecs timeout-val ] - Variant of [ ] with timeout See also `future*` for fully custom pools, etc.
(get* m k)
(get* m k not-found)
(get* m k1 k2 not-found)
(get* m k1 k2 k3 not-found)
Macro version of `get` that: 1. Avoids unnecessary evaluation of `not-found`. Useful when `not-found` is expensive or contains side-effects. 2. Supports multiple prioritized keys (k1, k2, etc.). Returns val for first key that exists in map. Useful for key aliases or fallbacks. Equivalent to: (cond (contains? m k1) (get m k1) (contains? m k2) (get m k2) ... :else not-found)
(get-env {:keys [as default return] :or {as :str return :value}} spec)
Flexible cross-platform util for embedding a config value during macro expansion. Used by other Taoensso libraries. Given a const kw/string id or vector of desc-priority alternative ids, parse and return the first of the following that exists: - JVM property value for id - Environment variable value for id - Classpath resource content for id Ids may include optional segment in `<>` tag (e.g. `<.edn>`). Ids may include `<.?platform.?>` tag for auto replacement, useful for supporting platform-specific config. Search order: desc by combined [alt-index platform(y/n) optional(y/n)]. So (get-env {:as :edn} [:my-app/alt1<.platform><.edn> :my-app/alt2]) will parse and return the first of the following that exists: 1. Alt1 +platform +optional (.edn suffix) 1a. `my-app.alt1.clj.edn` JVM property value 1b. `MY_APP_ALT1_CLJ_EDN` environment variable value 1c. `my-app.alt1.clj.edn` classpath resource content 2. Alt1 +platform -optional (.edn suffix) 2a. `my-app.alt1.clj` JVM property value 2b. `MY_APP_ALT1_CLJ` environment variable value 2c. `my-app.alt1.clj` classpath resource content 3. Alt1 -platform +optional (.edn suffix) 3a. `my-app.alt1.edn` JVM property value 3b. `MY_APP_ALT1_EDN` environment variable value 3c. `my-app.alt1.edn` classpath resource content 4. Alt1 -platform -optional (.edn suffix) 4a. `my-app.alt1` JVM property value 4b. `MY_APP_ALT1` environment variable value 4c. `my-app.alt1` classpath resource content 5. Alt2 5a. `my-app.alt2` JVM property value 5b. `MY_APP_ALT2` environment variable value 5c. `my-app.alt2` classpath resource content Options: `:as` - Parse found value as given type ∈ #{:str :bool :edn} (default `:str`). `:default` - Fallback to return unparsed if no value found during search (default `nil`). `:return` - Return type ∈ #{:value :map :explain} (default `:value`). Resulting config value must be something that can be safely embedded in code during macro-expansion. Symbols in edn will be evaluated during expansion. TIP!: Use the {:return :explain} option in tests or at the REPL to verify/inspect resulting config value, config source, and specific search order of prop/env/res ids.
(get-file-resource-?last-modified rname)
Returns last-modified time for file backing given named resource, or nil if file doesn't exist.
(get-host-ip)
(get-host-ip fallback)
(get-host-ip timeout-msecs timeout-val)
(get-host-ip cache-msecs timeout-msecs timeout-val)
Returns local host ip address string, or `fallback` (default nil). Can be slow, prefer 3-arity caching variant when possible.
(get-hostname)
(get-hostname fallback)
(get-hostname timeout-msecs timeout-val)
(get-hostname cache-msecs timeout-msecs timeout-val)
Returns local hostname string, or `fallback` (default nil). Can be slow, prefer 3-arity caching variant when possible.
(get-pom-version dep-sym)
Returns POM version string for given Maven dependency, or nil.
(get-source macro-form macro-env)
Returns {:keys [ns line column file]} source location given a macro's compile-time `&form` and `&env` vals. See also `keep-callsite`.
(get-substr-by-idx s start-idx)
(get-substr-by-idx s start-idx end-idx)
Returns ?substring from given string. Like `subs` but: - Provides consistent clj/s behaviour. - Never throws (snaps to valid indexes). - Indexes may be -ive (=> indexed from end of string). Returns nil when requested substring would be empty.
(get-substr-by-len s start-idx)
(get-substr-by-len s start-idx sub-len)
Returns ?substring from given string. Like `get-substr-by-idx`, but takes a substring-length 3rd argument.
(get-subvec v start)
(get-subvec v start end)
Like `subvec` but never throws (snaps to valid start and end indexes).
(get-subvector v start)
(get-subvector v start length)
Like `get-subvec` but: - Takes `length` instead of `end` (index). - -ive `start` => index from right of vector.
(get-win-loc)
Returns current window location as {:keys [href protocol hostname host pathname search hash]}.
(get1 m k)
(get1 m k not-found)
(get1 m k1 k2 not-found)
(get1 m k1 k2 k3 not-found)
Like `get` but returns val for first key that exists in map. Useful for key aliases or fallbacks. See also `get*`.
(have x)
(have pred (:in) x)
(have pred (:in) x & more-xs)
Takes a pred and one or more vals. Tests pred against each val, trapping errors. If any pred test fails, throws a detailed assertion error. Otherwise returns input val/vals for convenient inline-use/binding. Respects *assert* value so tests can be elided from production for zero runtime costs. Provides a small, simple, flexible feature subset to alternative tools like clojure.spec, core.typed, prismatic/schema, etc. ;; Will throw a detailed error message on invariant violation: (fn my-fn [x] (str/trim (have string? x))) You may attach arbitrary debug info to assertion violations like: `(have string? x :data {:my-arbitrary-debug-info "foo"})` Re: use of Truss assertions within other macro bodies: Due to CLJ-865, call site information (e.g. line number) of outer macro will unfortunately be lost. See `keep-callsite` util for a workaround. See also `have?`, `have!`.
(have! x)
(have! pred (:in) x)
(have! pred (:in) x & more-xs)
Like `have` but ignores *assert* value (so can never be elided). Useful for important conditions in production (e.g. security checks).
(have!? x)
(have!? pred (:in) x)
(have!? pred (:in) x & more-xs)
Specialized cross between `have?` and `have!`. Not used often but can be handy for semantic clarification and/or to improve multi-val performance when the return vals aren't necessary. **WARNING**: Do NOT use in :pre/:post conds since those are ALWAYS subject to *assert*, directly contradicting the intention of the bang (`!`) here.
(have? x)
(have? pred (:in) x)
(have? pred (:in) x & more-xs)
Like `have` but returns `true` on successful tests. In particular, this can be handy for use with :pre/:post conditions. Compare: (fn my-fn [x] {:post [(have nil? %)]} nil) ; {:post [nil]} FAILS (fn my-fn [x] {:post [(have? nil? %)]} nil) ; {:post [true]} passes as intended
(ident-hex-str obj)
Returns hex string of given Object's `identityHashCode` (e.g. "0x5eeb49f2").
(identical-kw? x y)
Returns true iff two keywords are identical. Portable and maximally fast. For Clj this expands to: `(identical? x y)` For Cljs this expands to: `(keyword-identical? x y)`
(if-let bindings then)
(if-let bindings then else)
Supersets `core/if-let` functionality. Like `core/if-let` but supports multiple bindings, and unconditional bindings with `:let`: (if-let [x (rand-nth [:x1 :x2 false nil ]) ; Bind truthy x, or -> `else` :let [y (rand-nth [:y1 :y2 false nil x ])] ; Bind any y z (rand-nth [:z1 :z2 false nil x y]) ; Bind truthy z, or -> `else` ] [:then-clause x y z] [:else-clause])
(if-not test-or-bindings then)
(if-not test-or-bindings then else)
Supersets `core/if-not` functionality. Same as `encore/if-let` with `then` `and `else` forms swapped.
(if-some bindings then)
(if-some bindings then else)
Supersets `core/if-some` functionality. Like `core/if-some` but supports multiple bindings, and unconditional bindings with `:let`: (if-some [x (rand-nth [:x1 :x2 false nil ]) ; Bind non-nil x, or -> `else` :let [y (rand-nth [:y1 :y2 false nil x ])] ; Bind any y z (rand-nth [:z1 :z2 false nil x y]) ; Bind non-nil z, or -> `else` ] [:then-clause x y z] [:else-clause])
(inst->udt inst)
Returns given `java.time.Instant` as milliseconds since Unix epoch.
Returns given `js/Date` as milliseconds since Unix epoch.
(inst? x)
Returns true iff given platform instant (`java.time.Instant` or `js/Date`).
(instance! class arg)
(instance! class arg {:keys [msg context param ...]})
(instance! class arg & {:keys [msg context param ...]})
If (instance? class arg) is true, returns arg. Otherwise throws runtime `ExceptionInfo` with `unexpected-arg!`. See `unexpected-arg!` for more info.
(int? x)
Returns true iff given a number (of standard type) that is: a fixed-precision integer.
(interleave-all)
(interleave-all c1)
(interleave-all c1 c2)
(interleave-all c1 c2 & colls)
Like `interleave` but includes all items (i.e. stops when the longest rather than shortest coll has been consumed).
(interns-overview)
(interns-overview ns)
Returns {:keys [api public private impl test no-doc]}, with each key mapped to an alphabetical list of the relevant vars in given namespace. "impl" vars are public vars with names that begin with "-" or "_", a naming convention commonly used to indicate vars intended to be treated as private implementation details even when public.
(into! to!)
(into! to! from)
(into! to! xform from)
Like `core/into` but assumes `to!` is a transient, and doesn't call `persist!` when done. Useful as a performance optimization in some cases.
(into-all to from)
(into-all to from & more)
Like `into` but supports multiple "from"s.
(invert-map m)
Returns given ?map with keys and vals inverted, dropping non-unique vals!
(is! x)
(is! pred x)
(is! pred x data)
Lightweight `have!` that provides less diagnostic info.
(tf-cancel! _)
Returns true iff the timeout was successfully cancelled (i.e. was previously pending).
(tf-cancelled? _)
Returns true iff the timeout is cancelled.
(tf-done? _)
Returns true iff the timeout is not pending (i.e. has a completed result or is cancelled).
(tf-pending? _)
Returns true iff the timeout is pending.
(tf-poll _)
Returns :timeout/pending, :timeout/cancelled, or the timeout's completed result.
(tf-state _)
Returns a map of timeout's public state.
(java-version)
(java-version version-string)
Returns Java's major version integer (8, 17, etc.).
(java-version>= n)
Returns true iff Java's major version integer is >= given integer: (if (java-version>= 21) <then> <else>)
(keep-callsite & body)
The long-standing CLJ-865 unfortunately means that it's currently not possible for an inner macro to access the &form metadata of an outer macro. This means that inner macros lose callsite information like the line number of the outer macro. This util offers a workaround for macro authors: (defmacro inner [] (meta &form)) (defmacro outer1 [] `(inner)) (defmacro outer2 [] (keep-callsite `(inner))) (inner) => {:line _, :column _} (outer1) => nil (outer2) => {:line _, :column _}
(matching-error err)
(matching-error kind err)
(matching-error kind pattern err)
Given a platform error and criteria, returns the error if it matches all criteria. Otherwise returns nil. `kind` may be: - A predicate function, (fn match? [x]) -> bool - A class (e.g. `ArithmeticException`, `AssertionError`, etc.) - `:all` => any platform error (Throwable or js/Error, etc.) - `:common` => common platform error (Exception or js/Error) - `:ex-info` => an `IExceptionInfo` as created by `ex-info` - A set of `kind`s as above, at least one of which must match `pattern` may be: - A string or Regex against which `ex-message` must match - A map against which `ex-data` must match using `submap?` - A set of `pattern`s as above, at least one of which must match When an error with (nested) causes doesn't match, a match will be attempted against its (nested) causes. Low-level util, see also `throws`, `throws?`.
(memoize f)
(memoize ttl-ms f)
(memoize size ttl-ms f)
Alternative way to call `cache`, provided mostly for back compatibility. See `cache` docstring for details.
(memoize-last f)
Like `core/memoize` but only caches the given fn's last input. Great for ReactJS render fn caching, etc.
(merge-with f & maps)
Like `core/merge-with` but faster, supports `:merge/dissoc` rvals.
(ms opts)
(ms & {:as opts :keys [years months weeks days hours mins secs msecs ms]})
Returns ~number of milliseconds in period defined by given args.
(msecs opts)
(msecs & {:as opts :keys [years months weeks days hours mins secs msecs ms]})
Macro version of `ms`.
(name-filter spec)
Given filter `spec`, returns a compiled (fn conform? [name]) that takes a namespace or any nameable type (string, keyword, symbol). Spec may be: - A namespace. Will conform on exact match. - A str/kw/sym, in which "*"s act as wildcards. Will conform on match. - A regex pattern. Will conform on match. - A vector or set of regex patterns or strs/kws/syms. Will conform on ANY match. If you need literal "*"s, use #"\*" regex instead. - {:allow <spec> :deny <spec>} with specs as above. Will conform iff `allow` spec matches AND `deny` spec does NOT. Resulting conform fn is useful as allowlist and/or denylist. Example inputs: namespace strings, class names, ids, etc. Spec examples: *ns*, #{}, "*", "foo.bar", "foo.bar.*", #{"foo" "bar.*"}, {:allow #{"foo" "bar.*"} :deny #{"foo.*.bar.*"}}, #"(foo1|foo2)\.bar".
(name-with-attrs sym args)
(name-with-attrs sym args attrs-merge)
Given a symbol and args, returns [<name-with-attrs-meta> <args> <attrs>] with support for `defn` style `?docstring` and `?attrs-map`.
(nanoid)
(nanoid len)
Returns a random "Nano ID" of given length, Ref. <https://github.com/ai/nanoid>. Uses strong randomness when possible. See also `uuid-str`, `rand-id-fn`.
(nnil)
(nnil x)
(nnil x y)
(nnil x y z)
(nnil x y z & more)
Returns first non-nil arg, or nil.
(norm-str s)
(norm-str form s)
Given a Unicode string, returns the normalized de/composed form. It's often a good idea to normalize strings before exchange or storage, especially if you're going to be querying against those string. `form` is ∈ #{:nfc :nfkc :nfd :nfkd <java.text.NormalizerForm>}. Defaults to :nfc as per W3C recommendation.
(norm-word-breaks s)
Converts all word breaks of any form and length (including line breaks of any form, tabs, spaces, etc.) to a single regular space.
(now-inst)
Returns current system instant as `java.time.Instant`.
Returns current system instant as `js/Date`.
(now-nano)
Returns current value of best-resolution time source as nanoseconds.
(now-udt)
Returns current system instant as milliseconds since Unix epoch.
Returns current system insant as milliseconds since Unix epoch.
(or-some)
(or-some x)
(or-some x & next)
Like `or`, but returns the first non-nil form (may be falsey).
(oset-in o ks v)
Experimental, subject to change without notice. Like `assoc-in` for JS objects.
(parse-query-params s & [keywordize? encoding])
Based on `ring-codec/form-decode`.
(pnum? x)
Returns true iff given number in unsigned unit proportion interval ∈ℝ[0,1].
(pool-executor {:keys [n-threads n-min-threads n-max-threads thread-name-prefix
daemon-threads? keep-alive-msecs queue-type queue-size]
:or {n-threads (+ 2 (get-num-threads [:ratio 1.0]))
thread-name-prefix "com.taoensso/encore-pool-"
daemon-threads? true
keep-alive-msecs 60000
queue-type :linked}})
Experimental, subject to change without notice! Returns new `java.util.concurrent.ThreadPoolExecutor` with given opts.
(pr & args)
Like `core/pr` but faster, and atomic (avoids interleaved content from different threads).
Identical to `core/pr`.
(pre-cache n-capacity f)
(pre-cache n-capacity fp-or-n-threads f)
Given a nullary fn `f` that is non-idempotent and free of side-effects, returns a wrapped version of `f` that asynchronously maintains a cache of up to `n-capacity` pre-computed return values of (f). Useful when `f` is expensive & may be called in a spikey fashion, e.g. ideal for cryptographic key generators.
(pred pred-fn)
Experimental, subject to change without notice. Wraps given predicate fn to return `Pred` for use with `submap?`, etc. Arity of predicate fn depends on context in which it'll be used. See also `pred-fn`.
(pred-fn pred)
Experimental, subject to change without notice. Returns unwrapped predicate fn when given `Pred`, otherwise returns nil. See also `pred`.
(print & args)
Like `core/print` but faster, and atomic (avoids interleaved content from different threads).
Identical to `core/print`.
(println & args)
Like `core/println` but faster, and atomic (avoids interleaved content from different threads).
Identical to `core/println`.
(prn & args)
Like `core/prn` but faster, and atomic (avoids interleaved content from different threads).
Identical to `core/prn`.
(pull-val! atom_ k)
(pull-val! atom_ k not-found)
Removes and returns value mapped to key: (let [a (atom {:k :v})] [(pull-val! a :k) @a]) => [:v {}]
(qb spec form)
(qb spec form & more)
Simple util to benchmark/compare runtime of given form/s. Runs sets of laps for each given form, recording the total runtime of each set. Returns the the total runtime in msecs of the fastest set of laps for each form. (quick-bench [<num-sets> <num-laps>] <form1> <form2> <...>) => [<total runtime msecs of fastest set of laps for form1> <total runtime msecs of fastest set of laps for form2> <...>] Total number of runs for each form is: `num-sets` * `num-laps` If omitted, the default `num-sets` is 6 (to include warmup): (quick-bench <num-laps> <form1> <form2> <...>) Example (comparing runtime of `first` and `nth` against vector): (let [v [:a]] (quick-bench 1e6 (first v) (nth v 0))) => [67.43 39.05]
(quick-bench spec form)
(quick-bench spec form & more)
Simple util to benchmark/compare runtime of given form/s. Runs sets of laps for each given form, recording the total runtime of each set. Returns the the total runtime in msecs of the fastest set of laps for each form. (quick-bench [<num-sets> <num-laps>] <form1> <form2> <...>) => [<total runtime msecs of fastest set of laps for form1> <total runtime msecs of fastest set of laps for form2> <...>] Total number of runs for each form is: `num-sets` * `num-laps` If omitted, the default `num-sets` is 6 (to include warmup): (quick-bench <num-laps> <form1> <form2> <...>) Example (comparing runtime of `first` and `nth` against vector): (let [v [:a]] (quick-bench 1e6 (first v) (nth v 0))) => [67.43 39.05]
(rand-id-fn {:keys [chars len rand-bytes-fn]
:or {chars :nanoid len 21 rand-bytes-fn secure-rand-bytes}})
Returns a (fn rand-id []) that returns random id strings. Uses strong randomness when possible. Options include: `:chars` - ∈ #{<string> :nanoid :alphanumeric :no-look-alikes ...} `:len` - Length of id strings to generate `:rand-bytes-fn` - Optional (fn [size]) to return random byte array of given size See also `uuid-str`, `nano-id`.
(rate-limiter spec)
(rate-limiter opts spec)
Takes a spec of form [ [<n-max-reqs> <msecs-window>] ...] or {<limit-id> [<n-max-reqs> <msecs-window>]}, and returns a basic stateful (fn a-rate-limiter [req-id] [command req-id]). Call the limiter fn with a request id (e.g. username) by which to count/limit. Will return: - nil when allowed (all limits pass for given req-id), or - [<worst-limit-id> <worst-backoff-msecs> {<limit-id> <backoff-msecs>}] when denied (any limits fail for given req-id). Or call the limiter fn with an additional command argument: `:rl/peek` <req-id> - Check limits w/o incrementing count. `:rl/reset` <req-id> - Reset all limits for given req-id. Example: (defonce my-rate-limiter (rate-limiter {"1 per sec" [1 1000] "10 per min" [10 60000]})) (defn send-message! [username msg-content] (if-let [fail (my-rate-limiter username)] (throw (ex-info "Sorry, rate limited!" {:fail fail})) <send message>))
(read-edn s)
(read-edn {:keys [readers default]
:as opts
:or {readers clojure.core/*data-readers*
default clojure.core/*default-data-reader-fn*}})
(read-edn s)
(read-edn {:keys [readers default]
:as opts
:or {readers (clojure.core/deref cljs.reader/*tag-table*)
default (clojure.core/deref
cljs.reader/*default-data-reader-fn*)}})
Reads given edn string to return a Clj/s value.
(read-json s)
(read-json kw-keys? s)
Reads given JSON string to return a Cljs value.
(reassoc-some m m-kvs)
(reassoc-some m k v)
(reassoc-some m k v & kvs)
Assocs each kv to given ?map if its value is nil, otherwise dissocs it.
(reduce-indexed rf init coll)
Like `reduce` but takes (rf [acc idx in]) with idx as in `map-indexed`. As `reduce-kv` against vector coll, but works on any seqable coll type.
(reduce-interleave-all rf init colls)
Reduces sequence of elements interleaved from given `colls`. (reduce-interleave-all conj [] [[:a :b] [1 2 3]]) => [:a 1 :b 2 3]
(reduce-iterator! rf init iterator)
Reduces given `java.util.Iterator`, mutating it. Note that most colls providing iterators implement `java.lang.Iterable`, so support `seq` directly.
(reduce-kvs rf init kvs)
Like `reduce-kv` but takes a flat sequence of kv pairs.
(reduce-multi rf init coll)
(reduce-multi rf1 init1 rf2 init2 coll)
(reduce-multi rf1 init1 rf2 init2 rf3 init3 coll)
Like `reduce` but supports separate simultaneous accumulators as a micro-optimization when reducing a large collection multiple times.
(reduce-n rf init end)
(reduce-n rf init start end)
(reduce-n rf init start end step)
(reduce-top n rf init coll)
(reduce-top n keyfn rf init coll)
(reduce-top n keyfn cmp rf init coll)
Reduces the top `n` items from `coll` of N items. Clj impln is O(N.logn) vs O(N.logN) for (take n (sort-by ...)).
(reduce-zip rf init xs ys)
(reduce-zip rf init xs ys not-found)
Reduces given sequential xs and ys as pairs (e.g. key-val pairs). Calls (rf acc x y) for each sequential pair. Useful, among other things, as a more flexible version of `zipmap`.
(remove-keys key-pred m)
Returns given ?map, removing keys for which (key-pred <key>) is truthy.
(remove-vals val-pred m)
Returns given ?map, removing keys for which (val-pred <val>) is truthy.
(rename-keys replacements m)
Returns a map like the one given, replacing keys using given {<old-new> <new-key>} replacements. O(min(n_replacements, n_m)).
(repeatedly-into coll n f)
Like `repeatedly` but faster and `conj`s items into given collection.
(require-telemere-if-present)
Experimental, subject to change without notice! Requires Telemere if it's present, otherwise no-ops. For Cljs: needs ClojureScript >= v1.9.293, and must be placed at top of file. Used in cooperation with `signal!`.
(reset!? atom_ val)
Atomically swaps value of `atom_` to `val` and returns true iff the atom's value changed. See also `reset-in!?`.
(reset-in! atom_ val)
(reset-in! atom_ ks val)
(reset-in! atom_ ks not-found val)
Like `reset!` but supports `update-in` semantics, returns <old-key-val>.
(reset-in!? atom_ val)
(reset-in!? atom_ ks val)
(reset-in!? atom_ ks not-found val)
Like `reset-in!` but returns true iff the atom's value changed.
(reset-val! atom_ k val)
(reset-val! atom_ k not-found val)
Like `reset-in!` but optimized for single-key case.
(reset-val!? atom_ k new-val)
Like `reset-in!?` but optimized for single-key case.
(resolve-sym sym)
(resolve-sym macro-env sym)
(resolve-sym macro-env sym may-require-ns?)
Returns resolved qualified Clj/s symbol, or nil.
(ring-redirect-resp url)
(ring-redirect-resp kind url)
(ring-redirect-resp kind url flash)
(rnum? x)
Returns true iff given number in signed unit proportion interval ∈ℝ[-1,1].
(rolling-counter msecs)
Experimental, subject to change without notice. Returns a RollingCounter that you can: - Invoke to increment count in last `msecs` window and return RollingCounter. - Deref to return count in last `msecs` window.
(rolling-list nmax)
(rolling-list nmax {:keys [init-val]})
Returns a stateful fn of 2 arities: [ ] => Returns current array in O(n). [x] => Adds `x` to right of list, maintaining length <~ `nmax`. Returns nil. Very fast (faster than `rolling-vector`). Useful for maintaining limited-length histories, etc. See also `rolling-vector`.
(rolling-vector nmax)
(rolling-vector nmax {:keys [gc-every init-val] :or {gc-every 16000.0}})
Returns a stateful fn of 2 arities: [ ] => Returns current sub/vector in O(1). [x] => Adds `x` to right of sub/vector, maintaining length <= `nmax`. Returns current sub/vector. Useful for maintaining limited-length histories, etc. See also `rolling-list` (Clj only).
(runner {:as opts
:keys [mode buffer-size n-threads thread-name daemon-threads?
shutdown-drain-msecs convey-bindings?]
:or {mode :blocking
buffer-size 1024
n-threads 1
daemon-threads? true
convey-bindings? true
shutdown-drain-msecs 6000}})
Experimental, subject to change without notice! Returns a new stateful "runner" such that: (runner f) ; Arity 1 call Requests runner to execute given nullary fn according to runner's opts. Returns: - `true` if runner accepted fn for execution without back-pressure. - `false` if runner experienced back-pressure (fn may/not execute). - `nil` if runner has stopped accepting new execution requests. (runner) ; Arity 0 call Instructs runner to permanently stop accepting new execution requests. Returns promise iff runner's status changed with this call. Deref promise to block until all current execution requests complete. Runners provide ~similar capabilities to agents, but: - Take nullary fns rather than unary fns of state. - Have no validators or watches. - Have (configurable) back-pressure. - Can have >1 thread (in which case fns may execute out-of-order!). These properties make them useful as configurable async workers, etc. Options include: `:buffer-size` - Size of request buffer (max number of queued requests). `:mode` - Back-pressure mechanism ∈ #{:blocking :dropping :sliding}. Determines what happens when the request buffer is full and a new request is made: `:blocking` => Will block caller until buffer space is available `:dropping` => Will drop the newest request (no-op) `:sliding` => Will drop the oldest request `:n-threads` - Number of threads for asynchronously executing fns (servicing request buffer). NB execution order may be non-sequential when n > 1.
(satisfies! protocol arg)
(satisfies! protocol arg {:keys [msg context param ...]})
(satisfies! protocol arg & {:keys [msg context param ...]})
If (satisfies? protocol arg) is true, returns arg. Otherwise throws runtime `ExceptionInfo` with `unexpected-arg!`. See `unexpected-arg!` for more info.
(satisfies? protocol x)
Faster `satisfies?` to work around CLJ-1814 until a proper upstream fix. May cache, so possibly inappropriate for dynamic work.
(sb-append str-builder x)
(sb-append str-builder x & more)
Appends given string/s to given string builder. See also `str-builder.`
(secs opts)
(secs & {:as opts :keys [years months weeks days hours mins secs msecs ms]})
Returns ~number of seconds in period defined by given args.
(secure-rand-bytes size)
Returns a random byte array of given size. Uses strong randomness when possible.
(secure-rng)
Returns a an auto-reseeding thread-local `java.security.SecureRandom`. Favours security over performance. May block while waiting on entropy!
(secure-rng-mock!!! long-seed)
Returns **INSECURE** `java.security.SecureRandom` mock instance backed by a seeded deterministic `java.util.Random`. Useful for testing, etc.
(select-nested-keys src-map key-spec)
Like `select-keys` but supports nested key spec: (select-nested-keys {:a :A :b :B :c {:c1 :C1 :c2 :C2} :d :D} ; `src-map` [:a {:c [:c1], :d [:d1 :d2]}]) ; `key-spec` => {:a :A, :c {:c1 :C1}, :d :D} Note that as with the `{:d [:d1 :d2]}` spec in the example above, if spec expects a nested map but the actual value is not a map, the actual value will be included in output as-is. Has the same behaviour as `select-keys` when `key-spec` is a simple vector of keys.
(session-swap rreq rresp f & args)
Util to help correctly update Ring sessions (something easy to get wrong!). Given a Ring request (rreq) and Ring response (rresp), returns a new Ring response with the response session updated to be (f <old-session>) or (apply f <old-session> args).
(set-var-root! var-sym root-val)
Sets root binding (value) of the var identified by given symbol, and returns the new value. Cross-platform. See also `update-var-root!`.
(signal! {:as opts
:keys [fallback elidable? location inst uid middleware sample-rate
kind ns id level when rate-limit ctx parent trace? do let data
msg error run & kvs]})
Experimental, subject to change without notice! Expands to `taoensso.telemere/signal!` call if Telemere is present, otherwise expands to `fallback` form. MUST be used with `require-telemere-if-present`: (ns my-ns (:require [taoensso.encore :as enc])) (encore/require-telemere-if-present) ; At top of file, just below `ns` form (encore/signal! {<signal-opts> :fallback (println "Prints iff Telemere not present")}) For more info, see: - Telemere `signal!`, Ref. <https://www.taoensso.com/telemere/signal!> - Telemere API, Ref. <https://www.taoensso.com/telemere/api> - Telemere Wiki docs, Ref. <https://www.taoensso.com/telemere/wiki>
(simple-date-format pattern & [{:keys [locale timezone] :as opts}])
Returns a thread-local `java.text.SimpleDateFormat`.
Like `slurp-resource` but caches slurps against file's last-modified udt.
(slurp-resource rname)
Returns slurped named resource on classpath, or nil when resource not found.
(sortv coll)
(sortv comparator coll)
(sortv ?keyfn comparator coll)
Like `core/sort` but: - Returns a vector. - `comparator` can be `:asc`, `:desc`, or an arbitrary comparator. - An optional `keyfn` may be provided, as in `core/sort-by`.
(str-?index s substr)
(str-?index s substr start-idx)
(str-?index s substr start-idx last?)
Returns (first/last) ?index of substring if it exists within given string.
(str-builder)
(str-builder init)
Returns a new stateful string builder: - `java.lang.StringBuilder` for Clj - `goog.string.StringBuffer` for Cljs See also `sb-append`.
(str-join xs)
(str-join separator xs)
(str-join separator xform xs)
Faster generalization of `clojure.string/join` with transducer support.
(str-join-once separator coll)
Like `string/join` but skips nils and duplicate separators.
(str-replace s match replacement)
Like `str/replace` but provides consistent clj/s behaviour. Workaround for <http://dev.clojure.org/jira/browse/CLJS-794>, <http://dev.clojure.org/jira/browse/CLJS-911>. Note that ClojureScript 1.7.145 introduced a partial fix for CLJS-911. A full fix could unfortunately not be introduced w/o breaking compatibility with the previously incorrect behaviour. CLJS-794 also remains unresolved.
(submap? m sub)
Returns true iff `sub` is a (possibly nested) submap of `m`, i.e. iff every (nested) value in `sub` has the same (nested) value in `m`. Uses stack recursion so supports only limited nesting.
(submaps? maps subs)
Experimental, subject to change without notice. Returns true iff `sub_i` is a (possibly nested) submap of `m_i`. Uses `submap?`.
(swap-in! atom_ f)
(swap-in! atom_ ks f)
(swap-in! atom_ ks not-found f)
Like `swap!` but supports `update-in` semantics and `swapped`. Returns <new-key-val> or <swapped-return-val>: (swap-in! (atom {:k1 {:k2 5}}) [:k1 :k2] inc) => 6 (swap-in! (atom {:k1 {:k2 5}}) [:k1 :k2] (fn [old] (swapped (inc old) old))) => 5
(swap-val! atom_ k f)
(swap-val! atom_ k not-found f)
Like `swap-in!` but optimized for single-key case: (swap-val! (atom {:k 5}) :k inc) => 6 (swap-val! (atom {:k 5}) :k (fn [old] (swapped (inc old) old))) => 5
(swapped new-val return-val)
For use within the swap functions of `swap-in!` and `swap-val!`. Allows the easy decoupling of new and returned values. Compare: (let [a (atom 0)] [(core/swap! a (fn [old] (inc old) )) @a]) [1 1] ; new=1, return=1 (let [a (atom 0)] [(swap-in! a (fn [old] (swapped (inc old) old))) @a]) [0 1] ; new=1, return=0 Faster and much more flexible than `core/swap-vals!`, etc. Especially useful when combined with the `update-in` semantics of `swap-in!`, etc.
(test-fixtures fixtures-map)
Given a {:before ?(fn []) :after ?(fn [])} map, returns cross-platform test fixtures for use by both `clojure.test` and `cljs.test`: (let [f (test-fixtures {:before (fn [] (test-setup))})] (clojure.test/use-fixtures :once f) (cljs.test/use-fixtures :once f))
(thread-local & body)
Given a body that returns an initial value for the current thread, returns a `ThreadLocal` proxy that can be derefed to get the current thread's current value. Commonly used to achieve thread safety during Java interop. In the common case, `body` will be a call to some Java constructor that returns a non-thread-safe instance. Example: (def thread-local-simple-date-format_ "Deref to return a thread-local `SimpleDateFormat`" (thread-local (SimpleDateFormat. "yyyy-MM-dd"))) (.format @thread-local-simple-date-format_ (Date.)) => "2023-01-24" NB: don't pass the derefed value to other threads!
(thread-local-proxy & body)
Low-level, see `thread-local` instead.
(throws form)
(throws kind form)
(throws kind pattern form)
Evals `form` and if it throws an error that matches given criteria using `matching-error`, returns the matching error. Otherwise returns nil. See also `matching-error`, `throws?`.
(throws? form)
(throws? kind form)
(throws? kind pattern form)
Evals `form` and if it throws an error that matches given criteria using `matching-error`, returns true. Otherwise returns false. Useful for unit tests, e.g.: (is (throws? {:a :b} (throw (ex-info "Test" {:a :b :c :d})))) See also `matching-error`, `throws`.
(top n coll)
(top n keyfn coll)
(top n keyfn cmp coll)
Returns a sorted vector of the top `n` items from `coll` using `reduce-top`.
(top-into to n coll)
(top-into to n keyfn coll)
(top-into to n keyfn cmp coll)
Conjoins the top `n` items from `coll` into `to` using `reduce-top`.
(try* expr* catch-clauses* ?finally-clause)
Like `try`, but `catch` clause class may be: `:ex-info` - Catches only `ExceptionInfo` `:common` - Catches `js/Error` (Cljs), `Exception` (Clj) `:all` - Catches `:default` (Cljs), `Throwable` (Clj) `:all-but-critical` - Catches `:default` (Cljs), `Exception` and `AssertionError` (Clj) Addresses CLJ-1293 and the fact that `AssertionError`s are typically NON-critical (so desirable to catch, in contrast to other `Error` classes).
(try-eval form)
If `form` can be successfully evaluated at macro-expansion time, expands to `form`. Otherwise expands to `nil`.
(udt->inst msecs-since-epoch)
Returns given milliseconds since Unix epoch as `java.time.Instant`.
Returns given milliseconds since Unix epoch as `js/Date`.
(unexpected-arg! arg)
(unexpected-arg! arg {:keys [msg context param expected ...]})
(unexpected-arg! arg & {:keys [msg context param expected ...]})
Throws runtime `ExceptionInfo` to indicate an unexpected argument. Takes optional kvs for merging into exception's data map. (let [mode :unexpected] (case mode :read (do <...>) :write (do <...>) (unexpected-arg! mode {:context `my-function :param 'mode :expected #{:read :write}}))) => Unexpected argument: :unexpected {:arg {:value :unexpected, :type clojure.lang.Keyword}, :context 'taoensso.encore/my-function :param 'mode :expected #{:read :write}} See also `bad-arg!`.
(update-in m ks f)
(update-in m ks not-found f)
Like `core/update-in` but:. - Empty ks will return (f m), not act like [nil] ks. - Adds support for `not-found`. - Adds support for special return vals: `:update/dissoc`, `:update/abort`.
(update-var-root! var-sym update-fn)
Updates root binding (value) of the var identified by given symbol, and returns the new value: (update-var-root! my-var (fn [old-root-val] <new-root-val>)) => <new-root-val> Similar to `alter-var-root` but cross-platform and takes a symbol rather than a var. See also `set-var-root!`.
(url-encode s & [encoding])
(url-encode s)
Based on <https://goo.gl/fBqy6e>.
(uuid)
For Clj: returns a random `java.util.UUID`. For Cljs: returns a random UUID string. Uses strong randomness when possible. See also `uuid-str`, `nanoid`, `rand-id-fn`.
(uuid-str)
(uuid-str max-len)
Returns a random UUID string of given length (max 36). Uses strong randomness when possible. See also `uuid`, `nanoid`, `rand-id-fn`.
(vinterleave-all colls)
(vinterleave-all c1 c2)
(vinterleave-all c1 c2 c3)
(vinterleave-all c1 c2 c3 & colls)
Like `interleave`, but: - Returns a vector rather than lazy seq (=> greedy). - Includes all items (i.e. stops when the longest rather than shortest coll has been consumed). Single-arity version takes a coll of colls.
(virtual-executor)
Experimental, subject to change without notice! Returns new virtual `java.util.concurrent.ThreadPerTaskExecutor` when possible (JVM 21+), otherwise returns nil.
(when test-or-bindings & body)
Supersets `core/when` and `core/when-let` functionality. When `test-or-bindings` is a vector, same as `encore/when-let`. Otherwise same as `core/when`.
(when-let bindings & body)
Supersets `core/when-let` functionality. Like `core/when-let` but supports multiple bindings, and unconditional bindings with `:let`: (when-let [x (rand-nth [:x1 :x2 false nil ]) ; Bind truthy x, or -> nil :let [y (rand-nth [:y1 :y2 false nil x ])] ; Bind any y z (rand-nth [:z1 :z2 false nil x y]) ; Bind truthy z, or -> nil ] [:body x y z])
(when-not test-or-bindings & body)
Supersets `core/when-not` functionality. Same as `encore/if-let` with `body` as `else` form.
(when-some test-or-bindings & body)
Supersets `core/when-some` functionality. Like `core/when-some` but supports multiple bindings, and unconditional bindings with `:let`: (when-some [x (rand-nth [:x1 :x2 false nil ]) ; Bind non-nil x, or -> `else` :let [y (rand-nth [:y1 :y2 false nil x ])] ; Bind any y z (rand-nth [:z1 :z2 false nil x y]) ; Bind non-nil z, or -> `else` ] [:body x y z])
(with-dynamic-assertion-data data & body)
Prefer `with-data`
(with-truss-data data & body)
Executes body with dynamic assertion data bound to given value. This data will be included in any violation errors thrown by body.
(xdistinct)
(xdistinct keyfn)
Returns a stateful transducer like (core/distinct) that supports an optional key function. Retains only items with distinct (keyfn <item>).
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close