Skip to content

doc: documentation for WriteStream.cursorTo and other TTY methods #9853

Description

@dcposch

Even if they're deprecated and we're supposed to use the readline module now, the docs should say that, right?

Currently, the docs don't list process.stdout.cursorTo and related functions at all.

Popular modules, as well as Node itself, still use them:

node-progress module
node debugger

Here's the full list of functions I'm referring to:

tty.js:92

I think it would reduce confusion if we at least mentioned these in the process or stream docs.

Activity

  1. dcposch commented on Nov 30, 2016

    @dcposch
    ContributorAuthor
  2. added
    docIssues and PRs related to Node.js documentation.
    ttyIssues and PRs related to the tty subsystem.
    on Nov 30, 2016
  3. Fishrock123 commented on Nov 30, 2016

    @Fishrock123
    Contributor

    I think we should be able to issue runtime deprecations for these. There shouldn't be a reason to document them.

  4. dcposch commented on Nov 30, 2016

    @dcposch
    ContributorAuthor

    We should at least remove our own use of WriteStream.cursorTo first:

    node ebugger _debugger.js:865

  5. Trott commented on Jul 15, 2017

    @Trott
    Member

    @dcposch @Fishrock123 Should this remain open?

  6. Trott commented on Aug 16, 2018

    @Trott
    Member

    @nodejs/documentation @nodejs/process Anyone want to document cursorTo(), maybe while adding a doc-only deprecation?

  7. added
    good first issueIssues that are suitable for first-time contributors.
    on Aug 16, 2018
  8. added a commit that references this issue on Sep 17, 2018
    2621840
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.good first issueIssues that are suitable for first-time contributors.ttyIssues and PRs related to the tty subsystem.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions