pluck.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.pluck(property)

Ⓢ

Returns an Observable containing the value of a specified nested property from all elements in the Observable sequence. If a property can't be resolved, it will return undefined for that value.

Arguments

1. property (String): The property or properties to pluck. pluck accepts an unlimited number of nested property parameters.

Returns

(Observable): Returns a new Observable sequence of property values.

Example

var source = Rx.Observable
    .from([
        { value: 0 },
        { value: 1 },
        { value: 2 }
    ])
    .pluck('value');

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

// => Next: 0
// => Next: 1
// => Next: 2
// => Completed

// Using nested properties:

var source = Rx.Observable
    .from([
        { valueA: { valueB: { valueC: 0 }}},
        { valueA: { valueB: { valueC: 1 }}},
        { valueA: { valueB: 2 }},
    ])
    .pluck('valueA', 'valueB', 'valueC');

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

// => Next: 0
// => Next: 1
// => Next: undefined
// => Completed

Location

File:

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

Dist:

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

Prerequisites:

• None

NPM Packages:

• rx

NuGet Packages:

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

Unit Tests:

• /tests/observable/pluck.js