Skip to content

doc: explain path.format expected properties #5801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: explain path.format expected properties #5801

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/api/path.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ path.extname('.index')

Returns a path string from an object. This is the opposite of [`path.parse`][].

If `pathObject` has all expected properties, the returned string will be a
concatenation of the `dir` property, the platform-dependent path separator, and
the `base` property.
If `pathObject` has `dir` and `base` properties, the returned string will
be a concatenation of the `dir` property, the platform-dependent path separator,
and the `base` property.

If the `dir` property is not supplied, the `root` property will be used as the
`dir` property. However, it will be assumed that the `root` property already
Expand Down