filter

Excludes values that do not match a predicate

function filters(predicate : Function = null) : IObservable.<T>

predicate is function(value : T) : Boolean

Remarks

Each value emitted by the source will be sent to predicate. If predicate returns true, the value will be emitted; otherwise, it will be skipped.

The returned sequence completes when the source sequence completes.

The returned sequence errors when the source sequences errors or when predicate throws an error.

Marble Diagrams

xs = source
ys = output
p(x) = predicate

xs  ──o─────o─────o─────o────/
      │     │     │     │    │
     p(x)  p(x)  p(x)  p(x)  │
     true  false false true  │
      │                 │    │
ys  ──o─────────────────o────/

Return Value

IObservable.<T>

Examples

var source : IObservable = Observable.range(0, 10)
    .filter(function(v:int) : Boolean { return v > 5; });

source.subscribe(function(value : int) : void
    {
        trace(value);
    });

// Trace output is:
// 5
// 6
// 7
// 8
// 9