start.md

Rx.Observable.start(func, [context], [scheduler])

Ⓢ

Invokes the specified function asynchronously on the specified scheduler, surfacing the result through an observable sequence.

Arguments

1. func (Function): Function to run asynchronously.
2. [context] (Any): The context for the func parameter to be executed. If not specified, defaults to undefined.
3. [scheduler=Rx.Scheduler.timeout] (Scheduler): Scheduler to run the function on. If not specified, defaults to Scheduler.timeout.

Returns

(Observable): An observable sequence exposing the function's result value, or an exception.

Example

var context = { value: 42 };

var source = Rx.Observable.start(
    function () {
        return this.value;
    },
    context,
    Rx.Scheduler.timeout
);

var subscription = source.subscribe(
    function (x) {
        console.log('Next: ' + x);
    },
    function (err) {
        console.log('Error: ' + err);
    },
    function () {
        console.log('Completed');
    });

// => Next: 42
// => Completed

Location

File:

• /src/core/linq/observable/start.js

Dist:

• rx.async.js
• rx.async.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

• If using rx.async.js | rx.async.compat.js
  • rx.js | rx.compat.js
  • rx.binding.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Async
• RxJS-Lite

Unit Tests:

• /tests/observable/start.js