Liking cljdoc? Tell your friends :D

ulmus.signal


>!clj/s

(>! signal-$ value)

Puts a new value on the signal. Because this function is imperatively mutative, it should be used sparingly outside of signal definitions.

Puts a new value on the signal.  Because this function
is imperatively mutative, it should be used sparingly
outside of signal definitions.
sourceraw docstring

changed-keysclj/s

(changed-keys s-$)

Takes a signal containing consecuative maps. Returns a signal of the selected keys [gained, lost] between each two emissions.

Takes a signal containing consecuative maps.  Returns a signal
of the selected keys `[gained, lost]` between each two emissions.
sourceraw docstring

chooseclj/s

(choose selection-$ options)

Returns a signal containing the contents of the signal keyed by the value of selection in the options map.

Returns a signal containing the contents of the signal
keyed by the value of `selection` in the `options` map.
sourceraw docstring

cloneclj/s

(clone s-$)

Creates a copy of a signal

Creates a copy of a signal
sourceraw docstring

close!clj/s

(close! s-$ & opts)

Closes the signal. Values will no longer be propogated to the signal and it can be garbage collected. If the :transitive? keyed argument is provided, this function will also close any source signals for which s-$ is the only target.

Closes the signal.  Values will no longer be propogated
to the signal and it can be garbage collected.  If the :transitive?
keyed argument is provided, this function will also close any source
signals for which `s-$` is the only target.
sourceraw docstring

closed?clj/s

(closed? s-$)

Returns true if s-$ is a signal and has been closed, false otherwise.

Returns true if s-$ is a signal and has been closed,
false otherwise.
sourceraw docstring

debouncecljs

(debounce ms s-$)

Returns a signal of the last value emitted on s-$ after ms millis have ellapsed since it receieved a value.

Returns a signal of the last value emitted on `s-$` after `ms` millis
have ellapsed since it receieved a value.
sourceraw docstring

delaycljs

(delay ms s-$)

Returns each value emitted on s-$ after a delay of ms millis.

Returns each value emitted on `s-$` after a delay of `ms` millis.
sourceraw docstring

distinctclj/s

(distinct s-$)

Returns a signal that will suppress consecutively = values on it's argument.

Returns a signal that will suppress consecutively `=` values on it's argument.
sourceraw docstring

filterclj/s

(filter pred s-$)

Returns a signal of values for which the value on s-$ applied to pred returns truthy.

Returns a signal of values for which the value on s-$ applied to `pred` returns truthy.
sourceraw docstring

flattenclj/s

(flatten s-$)

Takes a signal of seqs. Returns a signal that emits each element in the seq individually.

Takes a signal of seqs.  Returns a signal that
emits each element in the seq individually.
sourceraw docstring

make-signalclj/s

(make-signal init proc inputs)

Creates a new signal.

Creates a new signal.
sourceraw docstring

mapclj/s

(map proc & signals)

Returns a signal whose value is proc applied to the values on the signals provided.

Returns a signal whose value is `proc` applied to the values on the signals provided.
sourceraw docstring

mergeclj/s

(merge & signals)

Takes any number of signals and returns a signal containing the values emitted by any of them.

Takes any number of signals and returns a signal containing the
values emitted by any of them.
sourceraw docstring

partitionclj/s

(partition n s-$)

Returns a signal of vectors containing every n elements emitted on s-$.

Returns a signal of vectors containing every `n` elements
emitted on `s-$`.
sourceraw docstring

pickmapclj/s

(pickmap proc s-$)
(pickmap proc s-$ metadata)

s-$ is expected to emit a list of signals. Returns a signal of the values yielded by applying proc to the signal list emitted on s-$

`s-$` is expected to emit a list of signals.
Returns a signal of the values yielded by
applying `proc` to the signal list emitted
on `s-$`
sourceraw docstring

pickmergeclj/s

(pickmerge s-$)
(pickmerge proc s-$)
(pickmerge proc s-$ metadata)

Creates a signal of the values yeilded by calling merge on the list of signals returned on s-$ after applying proc.

Creates a signal of the values yeilded by calling `merge`
on the list of signals returned on `s-$` after applying `proc`.
sourceraw docstring

pickzipclj/s

(pickzip s-$)
(pickzip proc s-$)
(pickzip proc s-$ metadata)

Creates a signal of the values yeilded by calling zip on the list of signals returned on s-$ after applying proc.

Creates a signal of the values yeilded by calling `zip`
on the list of signals returned on `s-$` after applying `proc`.
sourceraw docstring

reduceclj/s

(reduce proc init s-$)

Returns a signal whose value is the result of applying proc to the previous value of s-$ and it's current value. init is the initial value of the signal.

Returns a signal whose value is the result of applying proc to the previous value
of s-$ and it's current value.  `init` is the initial value of the signal.
sourceraw docstring

sample-onclj/s

(sample-on value-$ sample-$)

Returns a signal that emits value-$'s current value when sample emits a value.

Returns a signal that emits `value-$`'s current value when `sample` emits a value.
sourceraw docstring

sample-whenclj/s

(sample-when value-$ sample-$)

Returns a signal that emits new values from value-$ when sample-$ is assigned a truthy value.

Returns a signal that emits new values from `value-$` when `sample-$` is assigned a truthy value.
sourceraw docstring

Signalcljs

source

signalclj/s

(signal)

Creates a new signal without a value, the signal can only ever be updated with >!.

Creates a new signal without a value, the signal can only 
ever be updated with `>!`.
sourceraw docstring

signal-ofclj/s

(signal-of v)

Creates a new signal containing the value v

Creates a new signal containing the value `v`
sourceraw docstring

signal?clj/s

(signal? x)

Returns true if x is a signal, false otherwise

Returns true if x is a signal, false otherwise
sourceraw docstring

sliceclj/s

(slice n s-$)

Returns a signal of vectors containing the last n elements emitted on s-$.

Returns a signal of vectors containing the last `n` elements
emitted on `s-$`.
sourceraw docstring

splice!clj/s

(splice! to-$ from-$)

Emits the values on to-$ to from-$

Emits the values on `to-$` to `from-$`
sourceraw docstring

start-with!clj/s

(start-with! v s-$)
source

subscribe!clj/s

(subscribe! s-$ update-proc)
(subscribe! s-$ update-proc closed-proc)

Attaches subscriptions to s-$. update-proc will get called with the value when s-$ emits. closed-proc will get called when s-$ is closed. Should be used sparingly as an imperitive escape hatch for signal changes.

Attaches subscriptions to `s-$`.  `update-proc` will get
called with the value when s-$ emits.  `closed-proc` will
get called when `s-$` is closed.  Should be used sparingly
as an imperitive escape hatch for signal changes.
sourceraw docstring

subscribe-closed!clj/s

(subscribe-closed! s-$ proc)

Subscribes a listener for the closing of a signal.

Subscribes a listener for the closing of a signal.
sourceraw docstring

throttleclj/s

(throttle s-$ ms)

Returns new values emitted on s-$ no more than every ms millis.

Returns new values emitted on `s-$` no more than every `ms` millis.
sourceraw docstring

unsubscribe!clj/s

(unsubscribe! s-$ subscription)

Removes a subscription from s-$.

Removes a subscription from `s-$`.
sourceraw docstring

unsubscribe-all!clj/s

(unsubscribe-all! s-$)

Removes all subscriptions from a signal.

Removes all subscriptions from a signal.
sourceraw docstring

zipclj/s

(zip & signals)

Takes any number of signals and returns a signal containing a vector of each signals latest value.

Takes any number of signals and returns a signal containing a 
vector of each signals latest value.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close