Skip to content
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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 19 additions & 1 deletion doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ added: v0.1.25

* `path` {String}
* `ext` {String} An optional file extension
* Return: {String}
Copy link
Contributor

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.

Copy link
Contributor

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.


The `path.basename()` methods returns the last portion of a `path`, similar to
the Unix `basename` command.
Expand All @@ -83,6 +84,8 @@ and is not a string.
added: v0.9.3
-->

* {String}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe prefix these with Type:?

Copy link
Contributor

Choose a reason for hiding this comment

The 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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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()`][].
Expand Down Expand Up @@ -244,6 +250,7 @@ added: v0.11.2
-->

* `path` {String}
* Return: {Boolean}

The `path.isAbsolute()` method determines if `path` is an absolute path.

Expand Down Expand Up @@ -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.
Expand All @@ -304,6 +312,7 @@ added: v0.1.23
-->

* `path` {String}
* Return: {String}

The `path.normalize()` method normalizes the given `path`, resolving `'..'` and
`'.'` segments.
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -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.

Expand All @@ -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()`
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down