range

function stable

Creates an Observable that emits a sequence of numbers within a specified range.

range(start: number, count?: number, scheduler?: SchedulerLike): Observable<number>

Parameters

start

The value of the first integer in the sequence.

count

Optional. Default is undefined.

The number of sequential integers to generate.

scheduler

Optional. Default is undefined.

A SchedulerLike to use for scheduling the emissions of the notifications.

Returns

Observable<number>: An Observable of numbers that emits a finite range of sequential integers.

Description

Emits a sequence of numbers in a range.

range marble diagram

range operator emits a range of sequential integers, in order, where you select the start of the range and its length. By default, uses no SchedulerLike and just delivers the notifications synchronously, but may use an optional SchedulerLike to regulate those deliveries.

Example

Produce a range of numbers

import { range } from 'rxjs';

const numbers = range(1, 3);

numbers.subscribe({
 next: value => { console.log(value) },
 complete: () => { console.log('Complete!') }
});

// Logs:
// 1
// 2
// 3
// "Complete!"

See Also

© 2015–2021 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.
Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
https://rxjs.dev/api/index/function/range