summaryrefslogtreecommitdiff
path: root/doc/api/path.md
diff options
context:
space:
mode:
authorRoman Reiss <me@silverwind.io>2017-02-04 16:15:33 +0100
committerRoman Reiss <me@silverwind.io>2017-03-02 17:55:45 +0100
commitff1361957df58ef92c8a9dfce40c6091ea3a21d4 (patch)
tree10721c2b86095033930bffc4e52cf38d40033f16 /doc/api/path.md
parentebe8c3debeea708ca69b8724dda9ad9c5c32e72c (diff)
downloadandroid-node-v8-ff1361957df58ef92c8a9dfce40c6091ea3a21d4.tar.gz
android-node-v8-ff1361957df58ef92c8a9dfce40c6091ea3a21d4.tar.bz2
android-node-v8-ff1361957df58ef92c8a9dfce40c6091ea3a21d4.zip
doc: consistent case for primitive types
PR-URL: https://github.com/nodejs/node/pull/11167 Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Diffstat (limited to 'doc/api/path.md')
-rw-r--r--doc/api/path.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/api/path.md b/doc/api/path.md
index f284c50059..0a1c7dc589 100644
--- a/doc/api/path.md
+++ b/doc/api/path.md
@@ -63,8 +63,8 @@ changes:
description: Passing a non-string as the `path` argument will throw now.
-->
-* `path` {String}
-* `ext` {String} An optional file extension
+* `path` {string}
+* `ext` {string} An optional file extension
* Returns: {String}
The `path.basename()` methods returns the last portion of a `path`, similar to
@@ -124,7 +124,7 @@ changes:
description: Passing a non-string as the `path` argument will throw now.
-->
-* `path` {String}
+* `path` {string}
* Returns: {String}
The `path.dirname()` method returns the directory name of a `path`, similar to
@@ -148,7 +148,7 @@ changes:
description: Passing a non-string as the `path` argument will throw now.
-->
-* `path` {String}
+* `path` {string}
* Returns: {String}
The `path.extname()` method returns the extension of the `path`, from the last
@@ -184,11 +184,11 @@ added: v0.11.15
-->
* `pathObject` {Object}
- * `dir` {String}
- * `root` {String}
- * `base` {String}
- * `name` {String}
- * `ext` {String}
+ * `dir` {string}
+ * `root` {string}
+ * `base` {string}
+ * `name` {string}
+ * `ext` {string}
* Returns: {String}
The `path.format()` method returns a path string from an object. This is the
@@ -247,7 +247,7 @@ path.format({
added: v0.11.2
-->
-* `path` {String}
+* `path` {string}
* Returns: {Boolean}
The `path.isAbsolute()` method determines if `path` is an absolute path.
@@ -282,7 +282,7 @@ A [`TypeError`][] is thrown if `path` is not a string.
added: v0.1.16
-->
-* `...paths` {String} A sequence of path segments
+* `...paths` {string} A sequence of path segments
* Returns: {String}
The `path.join()` method joins all given `path` segments together using the
@@ -309,7 +309,7 @@ A [`TypeError`][] is thrown if any of the path segments is not a string.
added: v0.1.23
-->
-* `path` {String}
+* `path` {string}
* Returns: {String}
The `path.normalize()` method normalizes the given `path`, resolving `'..'` and
@@ -343,7 +343,7 @@ A [`TypeError`][] is thrown if `path` is not a string.
added: v0.11.15
-->
-* `path` {String}
+* `path` {string}
* Returns: {Object}
The `path.parse()` method returns an object whose properties represent
@@ -351,11 +351,11 @@ significant elements of the `path`.
The returned object will have the following properties:
-* `root` {String}
-* `dir` {String}
-* `base` {String}
-* `ext` {String}
-* `name` {String}
+* `root` {string}
+* `dir` {string}
+* `base` {string}
+* `ext` {string}
+* `name` {string}
For example on POSIX:
@@ -427,8 +427,8 @@ changes:
in the return value.
-->
-* `from` {String}
-* `to` {String}
+* `from` {string}
+* `to` {string}
* Returns: {String}
The `path.relative()` method returns the relative path from `from` to `to`.
@@ -459,7 +459,7 @@ A [`TypeError`][] is thrown if neither `from` nor `to` is a string.
added: v0.3.4
-->
-* `...paths` {String} A sequence of paths or path segments
+* `...paths` {string} A sequence of paths or path segments
* Returns: {String}
The `path.resolve()` method resolves a sequence of paths or path segments into