Skip to content

doc,fs: document WHATWG URL support #12341

Closed
@addaleax

Description

@addaleax
  • Version: >= 7.6.0
  • Platform: n/a
  • Subsystem: fs, url

#10739 (fs: allow WHATWG URL and file: URLs as paths) was landed without documentation, because url.URL itself was undocumented at that time. Now url.URL is documented here, so the fs docs should include its support, too.

I think this is about what needs to be done:

  • URL needs to be added to the lists of supported types for the filename parameters
  • It needs to be mentioned that only file:/// URL objects are supported
  • An entry needs to be added to the changes: lists for the relevant methods that states the version this was added in (7.6.0) and that the support is currently still experimental.

As always, let us know here, in #node-dev on Freenode, or basically anywhere where you can reach us if you need any help or have any questions!

(oh, also: please comment here if you would like to try and take this on, so people don’t get in each other’s way. 😸 )

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.good first issueIssues that are suitable for first-time contributors.whatwg-urlIssues and PRs related to the WHATWG URL implementation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions