startWith

Emits the specified values at the start of a sequence

function startWith(values : *, 
    scheduler : IScheduler = null) : IObservable.<T>

Where values is a value that can be converted to an IObservable using toObservable.

Remarks

The returned sequence completes when the source sequence completes.

The returned sequence raises an error if the source sequence raises an error.

Marble Diagrams

values ─o──o──/
        │  │  │
source  │  │  └─o──o──o───/
        │  │    │  │  │   │
zs     ─o──o────o──o──o───/

Scheduler

Unless specified, this operator uses Scheduler.defaultScheduler to schedule each element in values.

Return Value

IObservable.<T>

Examples

Observable.range(1, 3).startWith([500, 501])
    .subscribe(
        function(value : int) : void { trace(value); },
        function():void { trace("Completed"); }
    );

    // Trace output is:
    // 500
    // 501
    // 1
    // 2
    // 3
    // Completed