Leandro Facchinetti
656545c2b3
Remove sketchy citebite links in documentation ( #973 )
...
I tried to follow these links, and they led me to really sketchy websites that have nothing to do with Node.js at all.
2022-10-21 14:10:31 -04:00
Richard
7edcb16a06
Fixed typo in readJson.md ( #940 )
2022-02-02 15:27:56 -05:00
Ryan Zimmerman
ce29957eec
Clarify move*() docs ( #888 )
...
Fixes #830
2021-04-17 15:48:24 -04:00
Ryan Zimmerman
24731f171f
Clarify docs for copy*() filter ( #884 )
...
* Clarify docs for copy*() filter
Fixes #843
* Implement suggestion
https://github.com/jprichardson/node-fs-extra/pull/884#discussion_r608216178
2021-04-08 13:35:47 -04:00
Mani Maghsoudlou
1680dff87f
consistentify types in docs ( #797 )
2020-05-13 09:19:03 -04:00
Mani Maghsoudlou
b0eb751a75
Improve docs ( #795 )
...
* improve docs
* Update docs/ensureSymlink-sync.md
Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
* Update docs/ensureSymlink.md
Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
* add Error type to docs
Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
2020-05-11 16:40:39 -04:00
Ryan Zimmerman
223eb896c4
Document all create*() aliases for ensure*() methods ( #766 )
...
Fixes #758
2020-02-26 09:19:28 -05:00
Ryan Zimmerman
2e4fcaee51
Update fs promise shims to support latest Node functions ( #747 )
...
* Add promise support for fs.writev()
* Add promise support for fs.opendir()
Sort array to match Node docs
* Fix tests for fs.writev()
* Fix requested changes
2020-02-03 09:33:14 -05:00
Ryan Zimmerman
31e177a56c
Clarify docs for remove*() ( #690 )
...
Closes #659
2019-05-23 08:50:30 -04:00
Mani Maghsoudlou
0bc36ffd5e
v8 release ( #667 )
...
* Remove secure-random from dev-deps (#610 )
* fix ensureDir() doc
* moveSync: refactor to use renameSync
* copy*(): fix copying bind-mounted directories (#618 )
* copy*(): fix copying bind-mounted dirs
* copy*(): fix case-insensitive-paths tests
* copy*(): refactor to check paths more efficiently
* destructure stats object after checking err
* move*(): check paths before moving
* move*(): add case-insensitive paths test
* remove unnecessary done callback from test
* copy*(): add new option checkPathsBeforeCopying
* update copy*() docs to include checkPathsBeforeCopying
* some reformatting
* copy*(): use fs.stat with bigint option
* move*(): refactor to use the internal stat functions
* move*(): add test for prevent moving identical
* disable graceful-fs in copy and move tests
* fix parsing node version
* tiny reformat
* update copy*() docs
* refactor parsing node version
* use semver to parse node version in tests
2019-05-11 10:08:57 -04:00
Alexander Lewitt
287f234817
Fix typo in docs ( #628 )
2018-10-05 16:36:05 -04:00
robertjacobson
402c1d0572
Show support for mode ( #587 )
...
Node fs's mkdir supports mode specification. After reviewing the source
fs-extra does as well, but is not documented. Update the documentation
to include the `options` parameter and provide a few examples of using
`mode`.
2018-08-11 15:08:20 -05:00
Ryan Zimmerman
5170b4f854
copy*() preserveTimestamps: false behavior is OS-dependent
...
Update docs and remove tests to reflect this
2018-04-06 12:55:53 -04:00
Jan Peer Stöcklmair
fab376ec2b
Docs: add copy note for src ( #538 )
2018-01-11 18:02:18 -05:00
Jan Peer Stöcklmair
c77d781721
Add async/await usage examples ( closes #506 ) ( #535 )
2018-01-09 08:56:08 -05:00
RyanZim
9732252b94
Allow copy's filter to return a Promise
2017-11-14 12:55:53 -05:00
Ryan Zimmerman
603b8bb661
BREAKING: Don't allow copy()/copySync()'s filter option to be a Regex ( #512 )
...
This was deprecated previously, and is now removed.
2017-11-09 09:46:04 -05:00
Roy Revelt
d416fa71b8
typo fixed
...
fixed
2017-10-15 23:30:39 +01:00
Nicolas Marien
4f01664a74
docs: update copy to show differences with cp
2017-10-05 19:32:26 +02:00
RyanZim
7a9bb173b9
Upgrade to jsonfile 4.0.0 for EOL option support
2017-09-12 18:47:43 -04:00
RyanZim
eb16cda31f
Fix docs lint error
2017-07-14 13:25:47 -04:00
Ryan Zimmerman
bd0a20092d
Merge pull request #449 from jprichardson/read-write-obj
...
BREAKING: fs.read() & fs.write() should return objects
2017-07-14 13:21:19 -04:00
RyanZim
395f6b08a9
Document writeJson() & outputJson() options
...
Fixes #456
2017-07-11 10:40:06 -04:00
RyanZim
5a8d5681c5
Add docs for using promises with fs.read() & fs.write()
2017-06-26 15:45:42 -04:00
Mani Maghsoudlou
c2ab3c5c2b
Add standard-markdown to lint js code inside docs files
2017-05-01 20:22:28 -07:00
RyanZim
3f7988de22
Add pathExists() and pathExistsSync()
2017-04-26 10:04:07 -04:00
RyanZim
1613f205de
Update docs for promise support
2017-04-26 10:04:07 -04:00
Mani Maghsoudlou
83a6190890
docs: Refactor remove exmaple to use remove instead of removeSync
2017-03-08 22:38:40 -08:00
Mani Maghsoudlou
936011e253
docs: Refactor remove and removeSync parameter name
2017-03-08 22:34:28 -08:00
Mani Maghsoudlou
fc5fca9be1
docs: Refactor docs to include parameters type
2017-03-08 21:58:11 -08:00
Mani Maghsoudlou
a4f6481ebf
docs/readJson.md: Refactor example for readJson method, refactor move and moveSync tests descriptions
2017-03-08 14:38:25 -08:00
Mani Maghsoudlou
10756de4df
docs: Refactor readJsonSync example
2017-03-08 13:51:52 -08:00
Mani Maghsoudlou
02c2a629b8
Docs: Split out sync methods
2017-03-08 13:38:57 -08:00
Kyo Nagashima
6e0f0cc361
Document outputFile() only supports a file path
...
`fs.writeFile()` supports a buffer or a file descriptor as 1st argument (`file`), but `fs-extra.outputFile()` does not. Because it sends `file` parameter to `path.dirname()` that requires `String`.
2017-03-05 20:25:36 +09:00
Mani Maghsoudlou
fa680cc782
docs/copy.md: Refactor copy filter example
2017-02-22 21:37:35 -08:00
JP Richardson
a37d7bbe1c
Merge pull request #366 from jprichardson/add-dest-param-filter-copy
...
Add dest parameter to filter option in copy and copySync
2017-02-22 20:58:14 -06:00
JPeer264
c3e3950cb8
Refactor docs
2017-02-22 14:18:41 +01:00
Mani Maghsoudlou
89230976b9
Add dest parameter to filter option in copy and copySync
2017-02-22 04:03:28 -08:00
RyanZim
383a26985c
Move API docs to seperate docs/ folder
...
Merge mkdirs() docs with ensureDir() docs
Resolves #298
2017-01-03 16:13:27 -05:00