consistentify types in docs (#797)

jprichardson · May 13, 2020 · 1680dff · 1680dff
1 parent b0eb751
commit 1680dff
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/docs/ensureDir-sync.md b/docs/ensureDir-sync.md
@@ -5,7 +5,7 @@ Ensures that the directory exists. If the directory structure does not exist, it
 **Aliases:** `mkdirsSync()`, `mkdirpSync()`
 
 - `dir` `<String>`
-- `options` `<Integer>|<Object>`
+- `options` `<Integer> | <Object>`
   - If it is `Integer`, it will be `mode`.
   - If it is `Object`, it will be `{ mode: <Integer> }`.
 

diff --git a/docs/ensureDir.md b/docs/ensureDir.md
@@ -5,7 +5,7 @@ Ensures that the directory exists. If the directory structure does not exist, it
 **Aliases:** `mkdirs()`, `mkdirp()`
 
 - `dir` `<String>`
-- `options` `<Integer>|<Object>`
+- `options` `<Integer> | <Object>`
   - If it is `Integer`, it will be `mode`.
   - If it is `Object`, it will be `{ mode: <Integer> }`.
 - `callback` `<Function>`

diff --git a/docs/outputJson-sync.md b/docs/outputJson-sync.md
@@ -7,7 +7,7 @@ Almost the same as [`writeJsonSync`](writeJson-sync.md), except that if the dire
 - `file` `<String>`
 - `object` `<Object>`
 - `options` `<Object>`
-  - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
+  - `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
   - `EOL` `<String>` Set EOL character. Default is `\n`.
   - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
   - Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)

diff --git a/docs/outputJson.md b/docs/outputJson.md
@@ -7,7 +7,7 @@ Almost the same as [`writeJson`](writeJson.md), except that if the directory doe
 - `file` `<String>`
 - `object` `<Object>`
 - `options` `<Object>`
-  - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
+  - `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
   - `EOL` `<String>` Set EOL character. Default is `\n`.
   - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
   - Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)

diff --git a/docs/writeJson-sync.md b/docs/writeJson-sync.md
@@ -7,7 +7,7 @@ Writes an object to a JSON file.
 - `file` `<String>`
 - `object` `<Object>`
 - `options` `<Object>`
-  - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
+  - `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
   - `EOL` `<String>` Set EOL character. Default is `\n`.
   - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
   - Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)

diff --git a/docs/writeJson.md b/docs/writeJson.md
@@ -7,7 +7,7 @@ Writes an object to a JSON file.
 - `file` `<String>`
 - `object` `<Object>`
 - `options` `<Object>`
-  - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
+  - `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
   - `EOL` `<String>` Set EOL character. Default is `\n`.
   - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
   - Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)