first
signature: first(predicate: function, select: function)
first(predicate: function, select: function)
Emit the first value or first to pass provided expression.
๐ก The counterpart to first is last!
๐ก First
will deliver an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent. If you don't want this behavior, use take(1)
instead.
Examples
( example tests )
Example 1: First value from sequence
( StackBlitz | jsBin | jsFiddle )
// RxJS v6+
import { from } from 'rxjs';
import { first } from 'rxjs/operators';
const source = from([1, 2, 3, 4, 5]);
//no arguments, emit first value
const example = source.pipe(first());
//output: "First value: 1"
const subscribe = example.subscribe(val => console.log(`First value: ${val}`));
Example 2: First value to pass predicate
( StackBlitz | jsBin | jsFiddle )
// RxJS v6+
import { from } from 'rxjs';
import { first } from 'rxjs/operators';
const source = from([1, 2, 3, 4, 5]);
//emit first item to pass test
const example = source.pipe(first(num => num === 5));
//output: "First to pass test: 5"
const subscribe = example.subscribe(val =>
console.log(`First to pass test: ${val}`)
);
Example 3: Utilizing default value
( StackBlitz | jsBin | jsFiddle )
// RxJS v6+
import { from } from 'rxjs';
import { first } from 'rxjs/operators';
const source = from([1, 2, 3, 4, 5]);
//no value will pass, emit default
const example = source.pipe(first(val => val > 5, 'Nothing'));
//output: 'Nothing'
const subscribe = example.subscribe(val => console.log(val));
Additional Resources
first ๐ฐ - Official docs
Filtering operator: take, first, skip ๐ฅ ๐ต - Andrรฉ Staltz
๐ Source Code: https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/first.ts
Last updated