Skip to content

Commit 1680dff

Browse files
authored
consistentify types in docs (#797)
1 parent b0eb751 commit 1680dff

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

docs/ensureDir-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Ensures that the directory exists. If the directory structure does not exist, it
55
**Aliases:** `mkdirsSync()`, `mkdirpSync()`
66

77
- `dir` `<String>`
8-
- `options` `<Integer>|<Object>`
8+
- `options` `<Integer> | <Object>`
99
- If it is `Integer`, it will be `mode`.
1010
- If it is `Object`, it will be `{ mode: <Integer> }`.
1111

docs/ensureDir.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Ensures that the directory exists. If the directory structure does not exist, it
55
**Aliases:** `mkdirs()`, `mkdirp()`
66

77
- `dir` `<String>`
8-
- `options` `<Integer>|<Object>`
8+
- `options` `<Integer> | <Object>`
99
- If it is `Integer`, it will be `mode`.
1010
- If it is `Object`, it will be `{ mode: <Integer> }`.
1111
- `callback` `<Function>`

docs/outputJson-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Almost the same as [`writeJsonSync`](writeJson-sync.md), except that if the dire
77
- `file` `<String>`
88
- `object` `<Object>`
99
- `options` `<Object>`
10-
- `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.
10+
- `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.
1111
- `EOL` `<String>` Set EOL character. Default is `\n`.
1212
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
1313
- Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)

docs/outputJson.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Almost the same as [`writeJson`](writeJson.md), except that if the directory doe
77
- `file` `<String>`
88
- `object` `<Object>`
99
- `options` `<Object>`
10-
- `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.
10+
- `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.
1111
- `EOL` `<String>` Set EOL character. Default is `\n`.
1212
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
1313
- Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)

docs/writeJson-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Writes an object to a JSON file.
77
- `file` `<String>`
88
- `object` `<Object>`
99
- `options` `<Object>`
10-
- `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.
10+
- `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.
1111
- `EOL` `<String>` Set EOL character. Default is `\n`.
1212
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
1313
- Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)

docs/writeJson.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Writes an object to a JSON file.
77
- `file` `<String>`
88
- `object` `<Object>`
99
- `options` `<Object>`
10-
- `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.
10+
- `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.
1111
- `EOL` `<String>` Set EOL character. Default is `\n`.
1212
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
1313
- Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)

0 commit comments

Comments
 (0)