Skip to content

docs: clarify range single argument behavior #7607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MakenRosa wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −4
Open

docs: clarify range single argument behavior #7607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions packages/rxjs/src/internal/observable/range.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ export function range(start: number, count: number | undefined, scheduler: Sched
* ![](range.png)
*
* `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
* select the `start` of the range and its `length`. If only one argument is
* provided, it is treated as the `count` and the range starts at `0`. For
* example, `range(5)` is equivalent to `range(0, 5)`. By default, uses no
* {@link SchedulerLike} and just delivers the notifications synchronously, but may use
* an optional {@link SchedulerLike} to regulate those deliveries.
*
Expand Down Expand Up @@ -47,11 +49,13 @@ export function range(start: number, count: number | undefined, scheduler: Sched
* @see {@link timer}
* @see {@link interval}
*
* @param start The value of the first integer in the sequence.
* @param count The number of sequential integers to generate.
* @param start The value of the first integer in the sequence, or the number of
* sequential integers to generate if no `count` is provided.
* @param count The number of sequential integers to generate. Passing `Infinity`
* emits an unbounded sequence.
* @param scheduler A {@link SchedulerLike} to use for scheduling the emissions
* of the notifications.
* @return An Observable of numbers that emits a finite range of sequential integers.
* @return An Observable of numbers that emits a range of sequential integers.
*/
export function range(start: number, count?: number, scheduler?: SchedulerLike): Observable<number> {
if (count == null) {
Expand Down