-
Notifications
You must be signed in to change notification settings - Fork 30.4k
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.
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
doc: added return types of functions and types of static properties #9514
Closed
imatveev
wants to merge
2
commits into
nodejs:master
from
imatveev:doc-path-properties-functions-return-types
+19
−1
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,6 +61,7 @@ added: v0.1.25 | |
|
||
* `path` {String} | ||
* `ext` {String} An optional file extension | ||
* Return: {String} | ||
|
||
The `path.basename()` methods returns the last portion of a `path`, similar to | ||
the Unix `basename` command. | ||
|
@@ -83,6 +84,8 @@ and is not a string. | |
added: v0.9.3 | ||
--> | ||
|
||
* {String} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe prefix these with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On the other hand, people seem to be fine with it in #9505, so I guess it's okay your way. |
||
|
||
Provides the platform-specific path delimiter: | ||
|
||
* `;` for Windows | ||
|
@@ -114,6 +117,7 @@ added: v0.1.16 | |
--> | ||
|
||
* `path` {String} | ||
* Return: {String} | ||
|
||
The `path.dirname()` method returns the directory name of a `path`, similar to | ||
the Unix `dirname` command. | ||
|
@@ -133,6 +137,7 @@ added: v0.1.25 | |
--> | ||
|
||
* `path` {String} | ||
* Return: {String} | ||
|
||
The `path.extname()` method returns the extension of the `path`, from the last | ||
occurrence of the `.` (period) character to end of string in the last portion of | ||
|
@@ -168,10 +173,11 @@ added: v0.11.15 | |
|
||
* `pathObject` {Object} | ||
* `dir` {String} | ||
* `root` {String} | ||
* `root` {String} | ||
* `base` {String} | ||
* `name` {String} | ||
* `ext` {String} | ||
* Return: {String} | ||
|
||
The `path.format()` method returns a path string from an object. This is the | ||
opposite of [`path.parse()`][]. | ||
|
@@ -244,6 +250,7 @@ added: v0.11.2 | |
--> | ||
|
||
* `path` {String} | ||
* Return: {Boolean} | ||
|
||
The `path.isAbsolute()` method determines if `path` is an absolute path. | ||
|
||
|
@@ -278,6 +285,7 @@ added: v0.1.16 | |
--> | ||
|
||
* `...paths` {String} A sequence of path segments | ||
* Return: {String} | ||
|
||
The `path.join()` method joins all given `path` segments together using the | ||
platform specific separator as a delimiter, then normalizes the resulting path. | ||
|
@@ -304,6 +312,7 @@ added: v0.1.23 | |
--> | ||
|
||
* `path` {String} | ||
* Return: {String} | ||
|
||
The `path.normalize()` method normalizes the given `path`, resolving `'..'` and | ||
`'.'` segments. | ||
|
@@ -337,6 +346,7 @@ added: v0.11.15 | |
--> | ||
|
||
* `path` {String} | ||
* Return: {Object} | ||
|
||
The `path.parse()` method returns an object whose properties represent | ||
significant elements of the `path`. | ||
|
@@ -404,6 +414,8 @@ A [`TypeError`][] is thrown if `path` is not a string. | |
added: v0.11.15 | ||
--> | ||
|
||
* {Object} | ||
|
||
The `path.posix` property provides access to POSIX specific implementations | ||
of the `path` methods. | ||
|
||
|
@@ -414,6 +426,7 @@ added: v0.5.0 | |
|
||
* `from` {String} | ||
* `to` {String} | ||
* Return: {String} | ||
|
||
The `path.relative()` method returns the relative path from `from` to `to`. | ||
If `from` and `to` each resolve to the same path (after calling `path.resolve()` | ||
|
@@ -444,6 +457,7 @@ added: v0.3.4 | |
--> | ||
|
||
* `...paths` {String} A sequence of paths or path segments | ||
* Return: {String} | ||
|
||
The `path.resolve()` method resolves a sequence of paths or path segments into | ||
an absolute path. | ||
|
@@ -485,6 +499,8 @@ A [`TypeError`][] is thrown if any of the arguments is not a string. | |
added: v0.7.9 | ||
--> | ||
|
||
* {String} | ||
|
||
Provides the platform-specific path segment separator: | ||
|
||
* `\` on Windows | ||
|
@@ -509,6 +525,8 @@ On Windows: | |
added: v0.11.15 | ||
--> | ||
|
||
* {Object} | ||
|
||
The `path.win32` property provides access to Windows-specific implementations | ||
of the `path` methods. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be
Returns:
to be consistent with other docs.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disregard that too, I see we're inconsistent here, will fix in another commit.