pluck

signature: pluck(properties: ...args): Observable

Select property to emit.

New to transformation operators? Check out the article Get started transforming streams with map, pluck, and mapTo!

Examples

Example 1: Pluck object property

( StackBlitz | jsBin | jsFiddle )

// RxJS v6+
import { from } from 'rxjs';
import { pluck } from 'rxjs/operators';

const source = from([
  { name: 'Joe', age: 30 },
  { name: 'Sarah', age: 35 }
]);
//grab names
const example = source.pipe(pluck('name'));
//output: "Joe", "Sarah"
const subscribe = example.subscribe(val => console.log(val));

Example 2: Pluck nested properties

( StackBlitz | jsBin | jsFiddle )

// RxJS v6+
import { from } from 'rxjs';
import { pluck } from 'rxjs/operators';

const source = from([
  { name: 'Joe', age: 30, job: { title: 'Developer', language: 'JavaScript' } },
  //will return undefined when no job is found
  { name: 'Sarah', age: 35 }
]);
//grab title property under job
const example = source.pipe(pluck('job', 'title'));
//output: "Developer" , undefined
const subscribe = example.subscribe(val => console.log(val));

Additional Resources

  • pluck 📰 - Official docs


📁 Source Code: https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/pluck.ts

Last updated