Skip to content

Commit

Permalink
docs: improve and fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
dbayarchyk authored and Dzmitry Bayarchyk committed Aug 10, 2024
1 parent f728d29 commit b2a073d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ npm install remote-date

## Documentation

You can view the documentation [https://dbayarchyk.github.io/remote-date](https://dbayarchyk.github.io/remote-date/).
You can view the documentation here:

[https://dbayarchyk.github.io/remote-date](https://dbayarchyk.github.io/remote-date/).

## Example

Expand Down
6 changes: 3 additions & 3 deletions src/remote-date.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export class RemoteDate {
/**
* @typedef {Object} RemoteDateOptions
* @property {Date | number} referencingDate
* @property {number} [referencingMonotonicTime]
* @property {number} [referencingMonotonicTime] A result of the monotonic clock performance.now() when the referencingDate was initialized.
* */

/**
Expand All @@ -33,7 +33,7 @@ export class RemoteDate {
/**
* @typedef {Object} SetRemoteTimeOptions
* @property {Date | number} referencingDate
* @property {number} [referencingMonotonicTime] - A result of the monotonic clock performance.now() when the removeDate was initialized.
* @property {number} [referencingMonotonicTime] A result of the monotonic clock performance.now() when the referencingDate was initialized.
*/

/**
Expand Down Expand Up @@ -69,7 +69,7 @@ export class RemoteDate {
}

/**
* Returns the newly-created Date object represents the current date and time as of the time of instantiation.
* Returns the newly-created Date object which represents the current date and time as of the time of instantiation.
* The returned date's timestamp is the same as the number returned by remoteDate.now().
*
* The Remote instance needs to be initialized once first via a constructor or remoteDate.setRemoteTime() before being able to use remoteDate.dateNow().
Expand Down

0 comments on commit b2a073d

Please sign in to comment.