defaultifempty.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.defaultIfEmpty([defaultValue])

Ⓢ

Returns the elements of the specified sequence or the specified value in a singleton sequence if the sequence is empty.

Arguments

1. [defaultValue=null] (Any): The value to return if the sequence is empty. If not provided, this defaults to null.

Returns

(Observable): An observable sequence that contains the specified default value if the source is empty; otherwise, the elements of the source itself.

Example

/* Without a default value */
var source = Rx.Observable.empty().defaultIfEmpty();

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

// => Next: null
// => Completed

/* With a defaultValue */
var source = Rx.Observable.empty().defaultIfEmpty(false);

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

// => Next: false
// => Completed

Location

File:

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

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/observable/defaultifempty.js