Beicon Api Documentation

Version: 4.1.0

beicon.core

behavior-subject

(behavior-subject v)

Bus that emits the most recent item it has observed and all subsequent observed items to each subscribed Observer.

buffer

(buffer n ob)(buffer n skip ob)

Projects each element of an observable sequence into zero or more buffers which are produced based on element count information.

buffer-time

(buffer-time ms ob)

Buffers the source Observable values for a specific time period.

cancel!

(cancel! v)

Dispose resources acquired by the subscription.

catch

(catch handler ob)(catch pred handler ob)

Continues an observable sequence that is terminated by an exception with the next observable sequence.

combine-latest

(combine-latest other ob)(combine-latest f other ob)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

concat

(concat & more)

Concatenates all of the specified observable sequences, as long as the previous observable sequence terminated successfully.

connect!

(connect! ob)

Connect the connectable observable.

create

(create sf)

Creates an observable sequence from a specified subscribe method implementation.

debounce

(debounce ms ob)

Emits an item from the source Observable after a particular timespan has passed without the Observable omitting any other items.

dedupe

(dedupe ob)(dedupe f ob)

Returns an observable sequence that contains only distinct contiguous elements.

dedupe'

(dedupe' ob)(dedupe' f ob)

Returns an observable sequence that contains only d istinct elements. Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large.

delay

(delay ms ob)

Time shifts the observable sequence by dueTime. The relative time intervals between the values are preserved.

delay-when

(delay-when sf ob)(delay-when sd sf ob)

Time shifts the observable sequence based on a subscription delay and a delay selector function for each element.

disposable-atom

(disposable-atom ref disposable)

disposable?

(disposable? v)

Check if the provided object is disposable (jvm) or subscription (js).

do

An idiomatic alias for tap.

empty

(empty)

Returns an observable sequence that is already in end state.

end

Mark a value as a final value of the stream.

end!

(end! b)

Ends the given bus stream.

error!

(error! b e)

Pushes the given error to the bus stream.

filter

(filter f ob)

Filters the elements of an observable sequence based on a predicate.

fjoin

(fjoin & items)

Runs all observable sequences in parallel and collect their last elements.

flat-map

(flat-map ob)(flat-map f ob)

Projects each element of an observable sequence to an observable sequence and merges the resulting observable sequences or Promises or array/iterable into one observable sequence.

fork-join

Alias to fjoin.

from-atom

(from-atom atm)

from-coll

(from-coll coll)

Generates an observable sequence from collection.

from-event

(from-event et ev)

Creates an Observable by attaching an event listener to an event target

from-promise

(from-promise p)

Creates an observable from a promise.

ICancellable

protocol

members

-cancel

(-cancel _)

dispose resources.

ignore

(ignore ob)

Ignores all elements in an observable sequence leaving only the termination messages.

interval

(interval ms)

Returns an observable sequence that produces a value after each period.

IObservableValue

protocol

members

-next?

(-next? _)

Returns true if is end value.

-error?

(-error? _)

Returns true if is end value.

-end?

(-end? _)

Returns true if is end value.

ISubscriber

protocol

Backpressure aware subscriber abstraction.

members

-on-end

(-on-end _)

Subscription termination notification hook.

-on-error

(-on-error _ error)

Subscription error notification hook.

-on-init

(-on-init _ s)

Subscription initialization hook.

-on-next

(-on-next _ s value)

Subscription data notification hook.

ISubscription

protocol

members

-request

(-request _ n)

request 1 or n items to the subscription.

just

(just v)

Returns an observable sequence that contains a single element.

log

(log ob)(log prefix ob)

Print all values passed through the given observable sequence.

map

(map f ob)

Apply a function to each element of an observable sequence.

mapcat

(mapcat f ob)

Projects each element of an observable sequence to an observable sequence and concatenates the resulting observable sequences or Promises or array/iterable into one observable sequence.

merge

(merge & more)

Merges all the observable sequences and Promises into a single observable sequence.

merge-all

(merge-all ob)

Merges an observable sequence of observable sequences into an observable sequence.

merge-map

An idiomatic alias for flat-map.

never

Alias to ‘empty’.

observable?

(observable? ob)

Return true if ob is a instance of Rx.Observable.

observe-on

(observe-on schd ob)

observer?

(observer? o)

Check if the provided value is Observer instance.

of

(of a)(of a b)(of a b c)(of a b c d)(of a b c d e)(of a b c d e f)(of a b c d e f & more)

Converts arguments to an observable sequence.

on-complete

A semantic alias for on-end.

on-end

(on-end ob f)

Subscribes a function to invoke upon graceful termination of the observable sequence.

on-error

(on-error ob f)

Subscribes a function to invoke upon exceptional termination of the observable sequence.

on-next

A semantic alias for on-value.

on-value

(on-value ob f)

Subscribes a function to invoke for each element in the observable sequence.

once

(once v)

An alias to just.

pr-log

(pr-log ob)(pr-log prefix ob)

Print all values passed through the given observable sequence using pr-str.

publish

(publish ob)

Create a connectable (hot) observable from other observable.

push!

(push! b v)

Pushes the given value to the bus stream.

race

(race a b)(race a b & more)

Create an observable that surfaces any of the given sequences, whichever reacted first.

range

(range b)(range a b)

Generates an observable sequence that repeats the given element.

reduce

(reduce f ob)(reduce f seed ob)

Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence.

request!

(request! s n)

retry

(retry ob)(retry n ob)

Given an optional number of retries and an observable, repeats the source observable the specified number of times or until it terminates. If no number of retries is given, it will be retried indefinitely.

sample

(sample ms ob)

Samples the observable sequence at each interval.

sample-when

(sample-when other ob)

Samples the observable sequence at each interval.

scan

(scan f ob)(scan f seed ob)

Applies an accumulator function over an observable sequence and returns each intermediate result. Same as reduce but with intermediate results

scheduler

(scheduler type)

Get the scheduler instance by type. The posible types are: :asap, :async, :queue. Old :trampoline type is renamed as :queue and is deprecated.

scheduler?

(scheduler? v)

Check if the provided value is Scheduler instance.

share

(share ob)

Returns an observable sequence that shares a single subscription to the underlying sequence.

skip

(skip n ob)

Bypasses a specified number of elements in an observable sequence and then returns the remaining elements.

skip-until

(skip-until pob ob)

Returns the values from the source observable sequence only after the other observable sequence produces a value.

skip-while

(skip-while f ob)

Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements.

subject

(subject)

Subject that, once an Observer has subscribed, emits all subsequently observed items to the subscriber.

subject?

(subject? b)

Check if the provided value is Subject instance.

subscribe

(subscribe ob nf)(subscribe ob nf ef)(subscribe ob nf ef cf)

Subscribes an observer to the observable sequence.

subscribe-on

(subscribe-on schd ob)

subscribe-with

(subscribe-with ob observer)

Subscribes an observer or subscriber to the observable sequence.

take

(take n ob)

Bypasses a specified number of elements in an observable sequence and then returns the remaining elements.

take-until

(take-until other ob)

Returns the values from the source observable sequence until the other observable sequence or Promise produces a value.

take-while

(take-while f ob)

Returns elements from an observable sequence as long as a specified predicate returns true.

tap

(tap f ob)(tap f g ob)(tap f g e ob)

Invokes an action for each element in the observable sequence.

throttle

(throttle ms ob)

Returns an observable sequence that emits only the first item emitted by the source Observable during sequential time windows of a specified duration.

timeout

(timeout ms ob)(timeout ms other ob)

Returns the source observable sequence or the other observable sequence if dueTime elapses.

timer

(timer delay)(timer delay period)

Returns an observable sequence that produces a value after ms has elapsed and then after each period.

to-atom

(to-atom ob)(to-atom ob a)(to-atom ob a f)

Materialize the observable sequence into an atom.

transform

(transform xform stream)

Transform the observable sequence using transducers.

unwrap-composite-exception

(unwrap-composite-exception exc)

with-latest

(with-latest f other source)

Merges the specified observable sequences into one observable sequence by using the selector function only when the source observable sequence (the instance) produces an element.

wrap-disposable

(wrap-disposable disposable)

zip

(zip & items)

Merges the specified observable sequences or Promises into one observable sequence.