Phillip Alexander
977c54adb5
doc: fs: clarify fs.symlink Windows specific args
11 years ago
Ben Noordhuis
d97ea06d88
doc: add warning to fs.exists() documentation
Warn against the open-if-exists anti-pattern, it's susceptible to
race conditions.
11 years ago
Sam Roberts
6a7be99703
doc: fs.open, fix flag/mode confusion, etc.
Flags and modes aren't the same, symlinks are followed in all of the
path but the last component, docs should say something about what the
mode argument is for and when its used, fs.openSync should point to the
function that contains the docs for its args, as fs.writeSync does.
11 years ago
Ben Noordhuis
4881a6a9a3
doc: clarify fs.read() offset argument
11 years ago
Ben Noordhuis
3fac4157fe
doc: fs: synchronize watchFile/unwatchFile warning
One said "if available", the other "if possible". Now they both say
"if possible."
12 years ago
Kiyoshi Nomo
36e90da6df
doc: remove `bufferSize` option
`bufferSize` option has been removed in b0f6789
.
12 years ago
Ryuichi Okumura
4cd643ee2d
doc: fix missing Class in header
12 years ago
Ryuichi Okumura
b06c82fd88
doc: fix the link to Stream document
12 years ago
Ben Noordhuis
e8c01739cd
doc: document linux pwrite() bug
On Linux, positional writes don't work when the file is opened in
append mode. The kernel ignores the position argument and always
appends the data to the end of the file.
To quote the man page:
POSIX requires that opening a file with the O_APPEND flag should have
no affect on the location at which pwrite() writes data. However, on
Linux, if a file is opened with O_APPEND, pwrite() appends data to the
end of the file, regardless of the value of offset.
12 years ago
koichik
1f53cfdeae
doc: don't mark fs callbacks as optional
Refs #5005 , #5008
12 years ago
Ben Noordhuis
fa05e8a270
doc: implicit fs callbacks don't throw in v0.10
But they will in v0.12.
Re #5005 .
12 years ago
isaacs
0928a526dd
fs: Support mode/flag options to read/append/writeFile
Fix #4841
12 years ago
Farid Neshat
dcaebec208
fs: add autoClose=true option to fs.createReadStream
12 years ago
Ben Noordhuis
a80434736b
fs: fix 'object is not a function' callback errors
Use a default callback if the user omitted one. Avoids errors like the one
below:
fs.js:777
if (err) return callback(err);
^
TypeError: object is not a function
at fs.appendFile (fs.js:777:21)
at Object.oncomplete (fs.js:297:15)
This commit fixes the behavior of fs.lchmod(), fs.lchown() and fs.readFile()
when the callback is omitted. Before, they silently swallowed errors.
Fixes #4352 .
12 years ago
Jan Lehnardt
a7b5938715
docs: fix copy and paste error
12 years ago
Ben Noordhuis
58a5bc1ec7
doc: fs: clarfify fs.watch() documentation
fs.watch() is implemented on all supported platforms but, depending on the
object being watched, doesn't always work reliably (or at all).
Fixes #4005 .
12 years ago
isaacs
168a555780
fs: fix naming of truncate/ftruncate functions
For backwards compatibility, fs.truncate(<number>) will proxy to
fs.ftruncate.
Fix #3805
12 years ago
Ivan Torres
8146f2e607
doc: clarify fs.symlink and fs.symlinkSync parameters
12 years ago
Ben Noordhuis
5b5362aa8d
fs: make unwatchFile() remove a specific listener
Before this commit, `fs.unwatchFile(path)` removed *all* listeners for `path`.
The function is overloaded now: `fs.unwatchFile(path)` still removes all
listeners, but `fs.unwatchFile(path, cb)` lets you remove a specific listener.
Fixes #3660 .
12 years ago
Ben Noordhuis
b9abb64fbb
doc: fs.lchmod() is only available on OS X
13 years ago
Ben Noordhuis
be3afd0bec
doc: remove references to deprecated fs api
The string-based versions of fs.read() and fs.write() have been deprecated
since before v0.2.0.
13 years ago
Ben Noordhuis
8708bb0280
doc: update fs.watchFile() docs
13 years ago
Igor Zinkovsky
39e25528eb
windows: enable creating directory junctions with fs.symlink
13 years ago
Andreas Madsen
a039bad299
fs.watch should not require a listener arguments
Since fs.watch returns an event emitter where the change event is exactly
the same as the listener callback, the argument should be required
13 years ago
Ben Noordhuis
18b94ea838
doc: improve fs.open() docs
13 years ago
Kevin Bowman
ccc4e547ea
doc: document fs 'rs+' open mode
13 years ago
Kevin Bowman
dfcdd5b8aa
fs: add sync open flags 'rs' and 'rs+'
13 years ago
Kyle Robinson Young
6ba3e68bd2
doc: correct return value of string-based fs.readSync
Closes #2330
13 years ago
Kyle Robinson Young
7cd1690f3d
doc: add cache argument to fs.realpath()
13 years ago
Kyle Robinson Young
0a83b78ba8
docs: more explicit argument names in fs
13 years ago
Zachary Scott
0dd8e0167d
doc: document fs.createReadStream() encodings
Fixes #2700 .
13 years ago
Rod Vagg
90b785c09a
doc: fix # links from (and within) api/fs
13 years ago
Rod Vagg
6628a3b6ea
doc: fix # links from (and within) api/fs
13 years ago
isaacs
8258bd467a
doc: 'filename' arg not guaranteed ever.
13 years ago
isaacs
a42b4ad44e
doc: Typo'd some stability indicators.
13 years ago
isaacs
1d59a73fef
doc: Change 'file_system' module to 'fs' as it should be
13 years ago
isaacs
2e487379ad
doc: Stability and Caveats for fs.watch/watchFile
13 years ago
isaacs
f70be203e4
doc: indentation and structure in fs.markdown
13 years ago
isaacs
2d44dcc8be
doc: Add stability indicators to documentation
13 years ago
isaacs
7bfa5cf284
s/streams/stream/
13 years ago
isaacs
2a6ff3f56b
doc refactor: fs
13 years ago
isaacs
f9df88c6da
s/streams/stream/
13 years ago
isaacs
40190b7c92
doc refactor: fs
13 years ago
Ben Noordhuis
279e7e7341
fs: add O_EXCL support, exclusive open file
13 years ago
Maciej Małecki
e10ed097cb
path fs: move `path.exists*` to `fs.exists*`
`path.exists*` functions show a deprecation warning and call functions
from `fs`. They should be removed later.
test: fix references to `path.exists*` in tests
test fs: add test for `fs.exists` and `fs.existsSync`
doc: reflect moving `path.exists*` to `fs`
13 years ago
Emerson Macedo
aa67b1f375
fs: add appendFile() and appendFileSync() functions
13 years ago
koichik
e1c043f43a
docs: fix docs to not suggest variable leaks
Fixes #2106 .
13 years ago
Igor Zinkovsky
d6bae2cb95
document mode argument for fs.symlink
13 years ago
Trevor Burnham
06d71ad457
docs: document the `persistent` option for `fs.watch` and `fs.watchFile`
13 years ago
Jacob H.C. Kragh
c1472ac105
docs: fix some minor typos in the fs documentation
* fchmodSync: replace 'path' with 'fd'
* lchmod: replace 'fd' with 'path'
* utimes, futimes, fsync: mark 'callback' as optional
13 years ago