Property | baconjs (original) (raw)

Constructors

constructor

• new Property(desc: Desc, subscribe: Subscribe<V>, handler?: EventSink<V>): Property

• Parameters

  • desc: Desc

  • subscribe: Subscribe<V>

  • Optional handler: EventSink<V>

Returns Property

Methods

and

• and(other: Property<any>): Property<boolean>

• Parameters

  • other: Property<any>

Returns Property<boolean>

awaiting

• awaiting(other: Observable<any>): Property<boolean>

• Parameters

  • other: Observable<any>

Returns Property<boolean>

bufferingThrottle

• bufferingThrottle(minimumInterval: number): this

• Parameters

  • minimumInterval: number

Returns this

changes

• changes(): EventStream<V>

• Returns EventStream<V>

combine

• combine<V2, R>(right: Observable<V2>, f: Function2<V, V2, R>): Property<R>

• Type parameters

  • V2

  • R

Parameters

• right: Observable<V2>

• f: Function2<V, V2, R>

Returns Property<R>

concat

• concat(other: Observable<V>): Property<V>
• concat(other: Observable<V2>): Property<V | V2>

• Parameters

  • other: Observable<V>

Returns Property<V>

• Type parameters

  • V2

Parameters

• other: Observable<V2>

Returns Property<V | V2>

debounce

• debounce(minimumInterval: number): this

• Parameters

  • minimumInterval: number

Returns this

debounceImmediate

• debounceImmediate(minimumInterval: number): this

• Parameters

  • minimumInterval: number

Returns this

decode

• decode(cases: T): Property<DecodedValueOf<T>>

• Type parameters

  • T: Record<any, any>

Parameters

• cases: T

Returns Property<DecodedValueOf<T>>

delay

• delay(delayMs: number): this

• Parameters

  • delayMs: number

Returns this

deps

• deps(): Observable<any>[]

• Returns Observable<any>[]

diff

• diff(start: V, f: Differ<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• start: V

• f: Differ<V, V2>

Returns Property<V2>

doAction

• doAction(f: Function1<V, any>): this

• Parameters

  • f: Function1<V, any>

Returns this

doEnd

• doEnd(f: Function0<any>): this

• Parameters

  • f: Function0<any>

Returns this

doError

• doError(f: Function1<any, any>): this

• Parameters

  • f: Function1<any, any>

Returns this

doLog

• doLog(...args: any[]): this

• Parameters

  • Rest ...args: any[]

Returns this

endAsValue

• endAsValue(): Observable<{}>

• Returns Observable<{}>

endOnError

• endOnError(predicate?: Predicate<any>): this

• Parameters

  • Default value predicate: Predicate<any> = x => true

Returns this

errors

• errors(): this

• Returns this

filter

• filter(f: TypePredicate<V, S>): ObservableWithParam<this, S>
• filter(f: Predicate<V> | boolean | Property<boolean>): this

• Type parameters

  • S: V

Parameters

• f: TypePredicate<V, S>

Returns ObservableWithParam<this, S>

• Parameters

  • f: Predicate<V> | boolean | Property<boolean>

Returns this

first

• first(): this

• Returns this

firstToPromise

• firstToPromise(PromiseCtr?: Function): Promise<V>

• Parameters

  • Optional PromiseCtr: Function

Returns Promise<V>

flatMap

• flatMap(f: SpawnerOrObservable<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• f: SpawnerOrObservable<V, V2>

Returns Property<V2>

flatMapConcat

• flatMapConcat(f: SpawnerOrObservable<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• f: SpawnerOrObservable<V, V2>

Returns Property<V2>

flatMapError

• flatMapError(f: Function1<any, Observable<V2> | EventOrValue<V2>>): Property<V | V2>

• Type parameters

  • V2

Parameters

• f: Function1<any, Observable<V2> | EventOrValue<V2>>

Returns Property<V | V2>

flatMapEvent

• flatMapEvent(f: EventSpawner<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• f: EventSpawner<V, V2>

Returns Property<V2>

flatMapFirst

• flatMapFirst(f: SpawnerOrObservable<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• f: SpawnerOrObservable<V, V2>

Returns Property<V2>

flatMapLatest

• flatMapLatest(f: SpawnerOrObservable<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• f: SpawnerOrObservable<V, V2>

Returns Property<V2>

flatMapWithConcurrencyLimit

• flatMapWithConcurrencyLimit(limit: number, f: SpawnerOrObservable<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• limit: number

• f: SpawnerOrObservable<V, V2>

Returns Property<V2>

fold

• fold(seed: V2, f: Accumulator<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• seed: V2

• f: Accumulator<V, V2>

Returns Property<V2>

forEach

• forEach(f?: Sink<V>): Unsub

• Parameters

  • Default value f: Sink<V> = nullSink

Returns Unsub

groupBy

• groupBy(keyF: Function1<V, string>, limitF?: GroupTransformer<V, V2>): Property<EventStream<V2>>

• Type parameters

  • V2

Parameters

• keyF: Function1<V, string>

• Optional limitF: GroupTransformer<V, V2>

Returns Property<EventStream<V2>>

holdWhen

• holdWhen(valve: Property<boolean>): EventStream<V>

• Parameters

  • valve: Property<boolean>

Returns EventStream<V>

inspect

• inspect(): string

• Returns string

internalDeps

• internalDeps(): any[]

• Returns any[]

last

• last(): this

• Returns this

log

• log(...args: any[]): this

• Parameters

  • Rest ...args: any[]

Returns this

map

• map(f: Function1<V, V2>): Property<V2>
• map(f: Property<V2> | V2): Property<V2>

• Type parameters

  • V2

Parameters

• f: Function1<V, V2>

Returns Property<V2>

• Type parameters

  • V2

Parameters

• f: Property<V2> | V2

Returns Property<V2>

mapEnd

• mapEnd(f: Function0<V> | V): this

• Parameters

  • f: Function0<V> | V

Returns this

mapError

• mapError(f: Function1<any, V> | V): this

• Parameters

  • f: Function1<any, V> | V

Returns this

name

• name(name: string): this

• Parameters

  • name: string

Returns this

not

• not(): Property<boolean>

• Returns Property<boolean>

onEnd

• onEnd(f?: VoidSink): Unsub

• Parameters

  • Default value f: VoidSink = nullVoidSink

Returns Unsub

onError

• onError(f?: Sink<any>): Unsub

• Parameters

  • Default value f: Sink<any> = nullSink

Returns Unsub

onValue

• onValue(f?: Sink<V>): Unsub

• Parameters

  • Default value f: Sink<V> = nullSink

Returns Unsub

onValues

• onValues(f: Function): Unsub

• Parameters

  • f: Function

Returns Unsub

or

• or(other: Property<any>): Property<boolean>

• Parameters

  • other: Property<any>

Returns Property<boolean>

reduce

• reduce(seed: V2, f: Accumulator<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• seed: V2

• f: Accumulator<V, V2>

Returns Property<V2>

sample

• sample(interval: number): EventStream<V>

• Parameters

  • interval: number

Returns EventStream<V>

sampledBy

• sampledBy(sampler: EventStream<any>): EventStream<V>
• sampledBy(sampler: Property<any>): Property<V>
• sampledBy(sampler: Observable<any>): Observable<V>

• Parameters

  • sampler: EventStream<any>

Returns EventStream<V>

• Parameters

  • sampler: Property<any>

Returns Property<V>

• Parameters

  • sampler: Observable<any>

Returns Observable<V>

scan

• scan(seed: V2, f: Accumulator<V, V2>): Property<V2>

• Type parameters

  • V2

Parameters

• seed: V2

• f: Accumulator<V, V2>

Returns Property<V2>

skip

• skip(count: number): this

• Parameters

  • count: number

Returns this

skipDuplicates

• skipDuplicates(isEqual?: Equals<V>): this

• Parameters

  • Optional isEqual: Equals<V>

Returns this

skipErrors

• skipErrors(): this

• Returns this

skipUntil

• skipUntil(starter: Observable<any>): this

• Parameters

  • starter: Observable<any>

Returns this

skipWhile

• skipWhile(f: PredicateOrProperty<V>): this

• Parameters

  • f: PredicateOrProperty<V>

Returns this

slidingWindow

• slidingWindow(maxValues: number, minValues?: number): Property<V[]>

• Parameters

  • maxValues: number

  • Default value minValues: number = 0

Returns Property<V[]>

startWith

• startWith(seed: V): Property<V>

• Parameters

  • seed: V

Returns Property<V>

subscribe

• subscribe(sink?: EventSink<V>): Unsub

• Parameters

  • Default value sink: EventSink<V> = nullSink

Returns Unsub

take

• take(count: number): this

• Parameters

  • count: number

Returns this

takeUntil

• takeUntil(stopper: Observable<any>): this

• Parameters

  • stopper: Observable<any>

Returns this

takeWhile

• takeWhile(f: PredicateOrProperty<V>): this

• Parameters

  • f: PredicateOrProperty<V>

Returns this

throttle

• throttle(minimumInterval: number): this

• Parameters

  • minimumInterval: number

Returns this

toEventStream

• toEventStream(options?: EventStreamOptions): EventStream<V>

• Parameters

  • Optional options: EventStreamOptions

Returns EventStream<V>

toPromise

• toPromise(PromiseCtr?: Function): Promise<V>

• Parameters

  • Optional PromiseCtr: Function

Returns Promise<V>

toProperty

• toProperty(): Property<V>

• Returns Property<V>

toString

• toString(): string

• Returns string

transform

• transform(transformer: Transformer<V, V2>, desc?: Desc): Property<V2>

• Type parameters

  • V2

Parameters

• transformer: Transformer<V, V2>

• Optional desc: Desc

Returns Property<V2>

withDesc

• withDesc(desc?: Desc): this

• Parameters

  • Optional desc: Desc

Returns this

withDescription

• withDescription(context: any, method: string, ...args: any[]): this

• Parameters

  • context: any

  • method: string

  • Rest ...args: any[]

Returns this

withLatestFrom

• withLatestFrom<V2, R>(samplee: Observable<V2>, f: Function2<V, V2, R>): Property<R>

• Type parameters

  • V2

  • R

Parameters

• samplee: Observable<V2>

• f: Function2<V, V2, R>

Returns Property<R>

withStateMachine

• withStateMachine<State, Out>(initState: State, f: StateF<V, State, Out>): Property<Out>

• Type parameters

  • State

  • Out

Parameters

• initState: State

• f: StateF<V, State, Out>

Returns Property<Out>

zip

• zip<V2, R>(other: Observable<V2>, f: Function2<V, V2, R>): EventStream<R>

• Type parameters

  • V2

  • R

Parameters

• other: Observable<V2>

• f: Function2<V, V2, R>

Returns EventStream<R>