applied-science.js-interop — appliedscience/js-interop 0.1.20

cljs

A JavaScript-interop library for ClojureScript.

apply clj/s≠

(apply obj k arg-array)

cljs

Apply function k of obj, binding this to obj.

(j/apply o :someFunction #js [arg1 arg2])
(j/apply o .-someFunction #js [arg1 arg2])

apply-in clj/s≠

(apply-in obj ks arg-array)

cljs

Apply function nested at path with arg-array, binding this to its parent object.

(j/apply-in o [:x :someFunction] arg1 arg2)

assoc! clj/s≠

(assoc! obj & keyvals)

cljs

Sets key-value pairs on obj, returns obj.

(j/assoc! o :x 10)
(j/assoc! o .-x 10)

assoc-in! clj/s≠

(assoc-in! obj ks v)

cljs

Mutates the value in a nested object structure, where ks is a sequence of keys and v is the new value. If any levels do not exist, objects will be created.

(j/assoc-in! o [:x :y] 10)
(j/assoc-in! o [.-x .-y] 10)

call clj/s≠

(call obj k & args)

cljs

Call function k of obj, binding this to obj.

(j/call o :someFunction arg1 arg2)
(j/call o .-someFunction arg1 arg2)

call-in clj/s≠

(call-in obj ks & args)

cljs

Call function nested at path with args, binding this to its parent object.

(j/call-in o [:x :someFunction] arg1 arg2)

contains? clj/s≠

(contains? obj k)

cljs

Returns true if obj contains k.

(j/contains? o :k)
(j/contains? o .-k)

extend! cljs

(extend! obj)

(extend! obj x)

(extend! obj x & more)

Extends obj with the properties of one or more objects, overwriting existing properties, moving left to right. Returns obj. An empty starting object is provided if obj is nil.

(j/extend o other)
(j/extend o other #js{:x 1})

Not IE6-friendly

get clj/s≠

(get obj k)

(get obj k not-found)

cljs

Returns the value mapped to key, not-found or nil if key not present.

(j/get o :k)
(j/get o .-k)

get-in clj/s≠

(get-in obj ks)

(get-in obj ks not-found)

cljs

Returns the value in a nested object structure, where ks is a sequence of keys. Returns nil if the key is not present, or the not-found value if supplied.

(j/get-in o [:x :y] :fallback-value)
(j/get-in o [.-x .-y] :fallback-value)

lit clj/s macro

(lit form)

Returns literal JS forms for Clojure maps (->objects) and vectors (->arrays).

lookup cljs

(lookup obj)

Wraps obj with an ILookup implementation, to support reading/destructuring. Does not support renamable keys.

(let [{:keys [a b c]} (j/lookup o)]
 ...)

obj clj/s≠

(obj & keyvals)

cljs

Create JavaScript object from an even number arguments representing interleaved keys and values.

(obj :a 1 :b 2 .-c 3 .-d 4)

push! clj/s≠

clj

(push! array v)

cljs

(push! array x)

Appends v to array and returns the mutated array.

(j/push! arr 10)

select-keys clj/s≠

(select-keys obj ks)

cljs

Returns an object containing only those entries in o whose key is in ks.

(j/select-keys o [:a :b :c])
(j/select-keys o [.-a .-b .-c])

some-or clj/s macro

(some-or x y)

Like or but switches on some? instead of truthiness.

unchecked-get clj/s

(unchecked-get obj k)

unchecked-set clj/s

(unchecked-set obj & keyvals)

unshift! clj/s≠

clj

(unshift! array v)

cljs

(unshift! array x)

Prepends v to a and returns the mutated array.

(j/unshift! arr 10)

update! clj/s≠

(update! obj k f & args)

cljs

'Updates' a value in a JavaScript object, where k is a key and f is a function that will take the old value and any supplied args and return the new value, which replaces the old value. If the key does not exist, nil is passed as the old value.

(j/update! o :a + 10)
(j/update! o .-a + 10)

update-in! clj/s≠

(update-in! obj ks f & args)

cljs

'Updates' a value in a nested object structure, where ks is a sequence of keys and f is a function that will take the old value and any supplied args and return the new value, mutating the nested structure. If any levels do not exist, objects will be created.

(j/update-in! o [:x :y] + 10)
(j/update-in! o [.-x .-y] + 10)