From 1680dff87f1faeb62c4eddf45c66bc4f549a879d Mon Sep 17 00:00:00 2001 From: Mani Maghsoudlou Date: Wed, 13 May 2020 06:19:03 -0700 Subject: [PATCH] consistentify types in docs (#797) --- docs/ensureDir-sync.md | 2 +- docs/ensureDir.md | 2 +- docs/outputJson-sync.md | 2 +- docs/outputJson.md | 2 +- docs/writeJson-sync.md | 2 +- docs/writeJson.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/ensureDir-sync.md b/docs/ensureDir-sync.md index e6a9c893..076307b8 100644 --- 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` `` -- `options` `|` +- `options` ` | ` - If it is `Integer`, it will be `mode`. - If it is `Object`, it will be `{ mode: }`. diff --git a/docs/ensureDir.md b/docs/ensureDir.md index 521afee2..b9eeaa62 100644 --- 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` `` -- `options` `|` +- `options` ` | ` - If it is `Integer`, it will be `mode`. - If it is `Object`, it will be `{ mode: }`. - `callback` `` diff --git a/docs/outputJson-sync.md b/docs/outputJson-sync.md index 3e80ddef..8c4b4a55 100644 --- 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` `` - `object` `` - `options` `` - - `spaces` `` 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 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` `` 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 index cef4c6fa..dd435476 100644 --- 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` `` - `object` `` - `options` `` - - `spaces` `` 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 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` `` 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 index 913440a3..ede2b49a 100644 --- a/docs/writeJson-sync.md +++ b/docs/writeJson-sync.md @@ -7,7 +7,7 @@ Writes an object to a JSON file. - `file` `` - `object` `` - `options` `` - - `spaces` `` 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 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` `` 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 index 70dbf2bf..32fc4910 100644 --- a/docs/writeJson.md +++ b/docs/writeJson.md @@ -7,7 +7,7 @@ Writes an object to a JSON file. - `file` `` - `object` `` - `options` `` - - `spaces` `` 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 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` `` 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)