Skip to content

doc: add section in fs to document mode argument #20049

Closed
Closed
doc: add section in fs to document mode argument#20049
Labels
docIssues and PRs related to Node.js documentation.fsIssues and PRs related to file-system APIs and the fs module.good first issueIssues that are suitable for first-time contributors.

Description

@trivikr
trivikr
opened on Apr 15, 2018
  • Version: master
  • Platform: N/A
  • Subsystem: fs

I noticed this while reviewing #20042
The description of mode argument is repeated in fs.access() and fs.accessSync(), and can be moved to a single location.

WDYT @nodejs/fs? This would be a good first issue for a new contributor.

Activity

  1. trivikr
    added
    docIssues and PRs related to Node.js documentation.
    fsIssues and PRs related to file-system APIs and the fs module.
    on Apr 15, 2018

  2. musgravejw commented on May 5, 2018

    @musgravejw
    musgravejw
    on May 5, 2018
    Contributor

    Aren't these constants defined here?

    Perhaps the documentation could link to the existing constants list.

  3. trivikr commented on May 5, 2018

    @trivikr
    trivikr
    on May 5, 2018
    MemberAuthor

    Yup.

    But the following values will have to be added to the table:

    • F_OK - This is useful for determining if a file exists, but says nothing about rwx permissions. Default if no mode is specified.
    • X_OK - This has no effect on Windows (will behave like F_OK)
  4. trivikr
    added
    good first issueIssues that are suitable for first-time contributors.
    on May 5, 2018

  5. shobhitchittora commented on May 6, 2018

    @shobhitchittora
    shobhitchittora
    on May 6, 2018
    Contributor

    @trivikr I'm on it.

  6. shobhitchittora
    added 4 commits that reference this issue on May 6, 2018

    doc: updates fs doc with -

    37abf87

    doc: review comments

    91bb735

    doc: removes repetition for fsPromises.access

    563b406

    doc: grammar fix ( adds 'of' ).

    d42adec
  7. vsemozhetbyt
    closed this as completedin a76dfd2on May 8, 2018
  8. targos
    added a commit that references this issue on May 12, 2018

    doc: refactor mode constants parts in fs.md

    d327893
  9. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: refactor mode constants parts in fs.md

    a76dfd2
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.fsIssues and PRs related to file-system APIs and the fs module.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions