Skip to content

doc: are os.uptime() returned type and remark correct? #12291

Closed
Closed
doc: are os.uptime() returned type and remark correct?#12291
Labels
docIssues and PRs related to Node.js documentation.osIssues and PRs related to the os subsystem.

Description

@vsemozhetbyt
vsemozhetbyt
opened on Apr 9, 2017
  • Version: 8.0.0-rc.0
  • Platform: Windows 7 x64
  • Subsystem: doc, os

Currently, both os.uptime() and process.uptime() return number with fractional seconds on Windows:

> os.uptime()
34298.2171316
> process.uptime()
20.648

However, their docs are different here:

https://github.com/nodejs/node/blame/7a5d07c7fbd43f3645d7f707fd6a98f2a251bdbd/doc/api/os.md#L372-L384

https://github.com/nodejs/node/blame/47f8f7462fb198aa27ede602c43786bdbfda37a2/doc/api/process.md#L1662-L1671

Are os.uptime() returned type integer and *Note* outdated or just OS-dependent?

Activity

  1. vsemozhetbyt
    added
    docIssues and PRs related to Node.js documentation.
    osIssues and PRs related to the os subsystem.
    on Apr 9, 2017
  2. vsemozhetbyt
    changed the title [-]doc: are `os.uptime()` retutned type and remark correct?[/-] [+]doc: are `os.uptime()` returned type and remark correct?[/+] on Apr 9, 2017

  3. gibfahn commented on Apr 9, 2017

    @gibfahn
    gibfahn
    on Apr 9, 2017
    Member

    Output on macOS (Sierra):

    > os.uptime()
245758
> process.uptime()
281.972

    Output on Ubuntu 16.04:

    > os.uptime()
174
> process.uptime()
9.451

  4. vsemozhetbyt commented on Apr 9, 2017

    @vsemozhetbyt
    vsemozhetbyt
    on Apr 9, 2017
    ContributorAuthor

    So it seems this is wrong only for Windows. What should be fixed — doc or Windows implementation?

  5. vsemozhetbyt
    added
    windowsIssues and PRs related to the Windows platform.
    on Apr 9, 2017

  6. vsemozhetbyt commented on Apr 9, 2017

    @vsemozhetbyt
    vsemozhetbyt
    on Apr 9, 2017
    ContributorAuthor

    If Windows implementation should be fixed, is it worth to land it in 8.0 as this is semver-major (despite of the doc though)?

    cc @nodejs/platform-windows

  7. bnoordhuis commented on Apr 9, 2017

    @bnoordhuis
    bnoordhuis
    on Apr 9, 2017
    Member

    The documentation is wrong-ish. uv_uptime() returns (in an out param) a double but the UNIX implementations of that function don't currently bother to mix in the sub-second fraction. That could change in the future though, if someone requests it.

  8. vsemozhetbyt commented on Apr 9, 2017

    @vsemozhetbyt
    vsemozhetbyt
    on Apr 9, 2017
    ContributorAuthor

    So the doc should describe OS-dependent behavior here? If so, can anybody edit it, as I am not good at writing long English text properly? Or I can open a PR with a proposed wording.

  9. vsemozhetbyt
    removed
    windowsIssues and PRs related to the Windows platform.
    on Apr 9, 2017

  10. bnoordhuis commented on Apr 9, 2017

    @bnoordhuis
    bnoordhuis
    on Apr 9, 2017
    Member

    How about this?

    Note: the return value includes fractions of a second on some platforms. Use Math.floor() to get whole seconds.

    Feel free to steal and PR.

  11. gibfahn commented on Apr 9, 2017

    @gibfahn
    gibfahn
    on Apr 9, 2017
    Member

    Maybe worth changing on some platforms to on Windows if it's Windows specific.

  12. vsemozhetbyt commented on Apr 9, 2017

    @vsemozhetbyt
    vsemozhetbyt
    on Apr 9, 2017
    ContributorAuthor

    I've combined two propositions in #12294

  13. jasnell
    closed this as completedin 9b6376aon Apr 11, 2017
  14. evanlucas
    added 4 commits that reference this issue on Apr 25, 2017

    doc: update os.uptime() and process.uptime() info

    3718c9b

    doc: update os.uptime() and process.uptime() info

    90706fa

    doc: update os.uptime() and process.uptime() info

    71b39ae
  15. gibfahn
    added 3 commits that reference this issue on Jun 18, 2017

    doc: update os.uptime() and process.uptime() info

    6d7795f

    doc: update os.uptime() and process.uptime() info

    026b74e
  16. MylesBorins
    added a commit that references this issue on Jul 11, 2017

    doc: update os.uptime() and process.uptime() info

    2435af9
  17. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: update os.uptime() and process.uptime() info

    9b6376a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.osIssues and PRs related to the os subsystem.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions