Skip to content
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

Jump to bottom

docs(timer): migrate old docs repo for timer function #4021

Merged
merged 7 commits into from Aug 17, 2018
Merged

docs(timer): migrate old docs repo for timer function #4021

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
96c59ef
docs(content): remove aio content
Aug 11, 2018
62b77e8
Merge branch 'master' of github.com:ReactiveX/rxjs into refactoring/r…
Aug 11, 2018
53d3f1e
docs(timer): migrate timer documentation from old docs repo
Aug 15, 2018
2f1ec32
Merge branch 'master' of github.com:ReactiveX/rxjs into feature/doing…
Aug 15, 2018
a25a7bb
docs(timer): improve paramater description
Aug 16, 2018
0097ee0
docs(timer): redo indention
Aug 16, 2018
b6981bf
docs(timer): revert indention and brackets
Aug 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/internal/observable/timer.ts
View file
Open in desktop
Expand Up @@ -6,7 +6,7 @@ import { isScheduler } from '../util/isScheduler';
import { Subscriber } from '../Subscriber';

/**
* Creates an Observable that starts emitting after an `initialDelay` and
* Creates an Observable that starts emitting after an `dueTime` and
* emits ever increasing numbers after each `period` of time thereafter.
*
* <span class="informal">Its like {@link index/interval}, but you can specify when
Expand All @@ -17,7 +17,7 @@ import { Subscriber } from '../Subscriber';
* `timer` returns an Observable that emits an infinite sequence of ascending
* integers, with a constant interval of time, `period` of your choosing
* between those emissions. The first emission happens after the specified
* `initialDelay`. The initial delay may be a `Date`. By default, this
* `dueTime`. The initial delay may be a `Date`. By default, this
* operator uses the {@link asyncScheduler} {@link SchedulerLike} to provide a notion of time, but you
* may pass any {@link SchedulerLike} to it. If `period` is not specified, the output
* Observable emits only one value, `0`. Otherwise, it emits an infinite
Expand All @@ -38,14 +38,14 @@ import { Subscriber } from '../Subscriber';
* @see {@link index/interval}
* @see {@link delay}
*
* @param {number|Date} [dueTime] The initial delay time to wait before
* emitting the first value of `0`.
* @param {number|Date} [dueTime] The initial delay time specified as a Date object or as an integer denoting
* milliseconds to wait before emitting the first value of 0`.
* @param {number|SchedulerLike} [periodOrScheduler] The period of time between emissions of the
* subsequent numbers.
* @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for scheduling
* the emission of values, and providing a notion of "time".
* @return {Observable} An Observable that emits a `0` after the
* `initialDelay` and ever increasing numbers after each `period` of time
* `dueTime` and ever increasing numbers after each `period` of time
* thereafter.
* @static true
* @name timer
Expand Down