IO.js File System

2018-11-28 22:34 更新

穩(wěn)定度: 2 - 穩(wěn)定

文件I/O是由標準POSIX函數的簡單包裝提供的。通過require('fs')來使用這個模塊。所有的方法都有異步和同步兩種形式。

異步形式的方法通常在最后一個參數上接受一個回調函數。回調函數的參數則取決于不同的方法,但是第一個參數總是為異常所保留。如果操作正常結束,那么第一個參數會是nullundefined。

當同步形式的方法產生異常時,會立刻拋出。你可以使用try/catch捕獲,或讓它們冒泡。

下面是一個異步方法的例子:

var fs = require('fs');

fs.unlink('/tmp/hello', function (err) {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});

下面是一個同步方法的例子:

var fs = require('fs');

fs.unlinkSync('/tmp/hello');
console.log('successfully deleted /tmp/hello');

因為異步方法不能夠保證執(zhí)行順序,所以下面的例子很容易出錯:

fs.rename('/tmp/hello', '/tmp/world', function (err) {
  if (err) throw err;
  console.log('renamed complete');
});
fs.stat('/tmp/world', function (err, stats) {
  if (err) throw err;
  console.log('stats: ' + JSON.stringify(stats));
});

它需要在fs.rename后執(zhí)行fs.stat。正確的執(zhí)行方法應如下:

fs.rename('/tmp/hello', '/tmp/world', function (err) {
  if (err) throw err;
  fs.stat('/tmp/world', function (err, stats) {
    if (err) throw err;
    console.log('stats: ' + JSON.stringify(stats));
  });
});

在繁忙的進程中,十分推薦使用異步版本的方法。同步版本的方法會阻塞進程,直到它們完成,也就是說它們會暫停所有連接。

文件的相對路徑也可以被使用,記住路徑是相對于process.cwd()的。

大多數的fs函數允許你省略回調函數。如果你省略了,將會由一個默認的回調函數來重拋出(rethrows)錯誤。要獲得原始調用地點的堆棧追蹤信息,請設置NODE_DEBUG環(huán)境變量:

$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs iojs script.js
fs.js:66
        throw err;
              ^
Error: EISDIR, read
    at rethrow (fs.js:61:21)
    at maybeCallback (fs.js:79:42)
    at Object.fs.readFile (fs.js:153:18)
    at bad (/path/to/script.js:2:17)
    at Object.<anonymous> (/path/to/script.js:5:1)
    <etc.>

fs.rename(oldPath, newPath, callback)

異步版本的rename(2)?;卣{函數只有一個可能的異常參數。

fs.renameSync(oldPath, newPath)

同步版本的rename(2)。返回undefined

fs.ftruncate(fd, len, callback)

異步版本的ftruncate(2)?;卣{函數只有一個可能的異常參數。

fs.ftruncateSync(fd, len)

同步版本的ftruncate(2)。返回undefined。

fs.truncate(path, len, callback)

異步版本的truncate(2)?;卣{函數只有一個可能的異常參數。第一個參數也可以接受一個文件描述符,這樣的話,fs.ftruncate()會被調用。

fs.truncateSync(path, len)

同步版本的truncate(2)。返回undefined。

fs.chown(path, uid, gid, callback)

異步版本的chown(2)。回調函數只有一個可能的異常參數。

fs.chownSync(path, uid, gid)

同步版本的chown(2)。返回undefined

fs.fchown(fd, uid, gid, callback)

異步版本的fchown(2)?;卣{函數只有一個可能的異常參數。

fs.fchownSync(fd, uid, gid)

同步版本的fchown(2)。返回undefined。

fs.lchown(path, uid, gid, callback)

異步版本的lchown(2)?;卣{函數只有一個可能的異常參數。

fs.lchownSync(path, uid, gid)

同步版本的lchown(2)。返回undefined。

fs.chmod(path, mode, callback)

異步版本的chmod(2)?;卣{函數只有一個可能的異常參數。

fs.chmodSync(path, mode)

同步版本的chmod(2)。返回undefined。

fs.fchmod(fd, mode, callback)

異步版本的fchmod(2)?;卣{函數只有一個可能的異常參數。

fs.fchmodSync(fd, mode)

同步版本的fchmod(2)。返回undefined。

fs.lchmod(path, mode, callback)

異步版本的lchmod(2)?;卣{函數只有一個可能的異常參數。

僅在Mac OS X中可用。

fs.lchmodSync(path, mode)

同步版本的lchmod(2)。返回undefined。

fs.stat(path, callback)

異步版本的stat(2)?;卣{函數有兩個參數(err, stats),stats是一個fs.Stats對象。更多信息請參閱fs.Stats章節(jié)。

fs.lstat(path, callback)

異步版本的lstat(2)。回調函數有兩個參數(err, stats),stats是一個fs.Stats對象。lstat()stat()是相同的,除了path是一個符號鏈接,連接自己本身就是stat-ed,而不是引用一個文件。

fs.fstat(fd, callback)

異步版本的fstat(2)?;卣{函數有兩個參數(err, stats),stats是一個fs.Stats對象。fstat()stat()是相同的,除了將要被stat-ed的文件是通過文件描述符fd來指定的。

fs.statSync(path)

同步版本的stat(2)。返回一個fs.Stats實例。

fs.lstatSync(path)

同步版本的lstat(2)。返回一個fs.Stats實例。

fs.fstatSync(fd)

同步版本的fstat(2)。返回一個fs.Stats實例。

fs.link(srcpath, dstpath, callback)

異步版本的link(2)?;卣{函數只有一個可能的異常參數。

fs.linkSync(srcpath, dstpath)

同步版本的link(2)。返回undefined。

fs.symlink(destination, path[, type], callback)

異步版本的symlink(2)?;卣{函數只有一個可能的異常參數。type參數可以被設置為'dir','file''junction'(默認為'file'),并且僅在Windows平臺下可用(其他平臺下會被忽略)。注意Windows junction點 要求目標路徑必須是絕對的。當使用'junction'時,destination參數會被自動轉換為絕對路徑。

fs.symlinkSync(destination, path[, type])

同步版本的symlink(2)。返回undefined。

fs.readlink(path, callback)

異步版本的link(2)。回調函數有兩個參數(err, linkString)。

fs.readlinkSync(path)

異步版本的readlink(2),返回一個符號鏈接字符串值。

fs.realpath(path[, cache], callback)

異步版本的realpath(2)?;卣{函數有兩個參數(err, resolvedPath)。可能會使用process.cwd來解析相對路徑。cache是一個包含了路徑映射的對象,被用來 強制進行指定的路徑解析 或 避免對真實路徑調用額外的fs.stat。

例子:

var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
  if (err) throw err;
  console.log(resolvedPath);
});

fs.realpathSync(path[, cache])

同步版本的realpath(2),返回一個解析出的路徑。

fs.unlink(path, callback)

異步版本的unlink(2)?;卣{函數只有一個可能的異常參數。

fs.unlinkSync(path)

同步版本的unlink(2)。返回undefined。

fs.rmdir(path, callback)

異步版本的rmdir(2)?;卣{函數只有一個可能的異常參數。

fs.rmdirSync(path)

同步版本的rmdir(2)。返回undefined。

fs.mkdir(path[, mode], callback)

異步版本的mkdir(2)?;卣{函數只有一個可能的異常參數。mode默認為0o777。

fs.mkdirSync(path[, mode])

同步版本的mkdir(2)。返回undefined

fs.readdir(path, callback)

異步版本的readdir(3)。讀取目錄內容?;卣{函數有兩個參數(err, files),files是一個目錄中的文件名數組(不包括'.''..')。

fs.readdirSync(path)

同步版本的readdir(3)。返回一個文件名數組(不包括'.''..')。

fs.close(fd, callback)

異步版本的close(2)?;卣{函數只有一個可能的異常參數。

fs.closeSync(fd)

同步版本的close(2)。返回undefined

fs.open(path, flags[, mode], callback)

異步版本的文件打開。參閱open(2)。flag可以是:

  • 'r' - 以只讀的方式打開文件。如果文件不存在則拋出異常。

  • 'r+' - 以讀寫的方式打開文件。如果文件不存在則拋出異常。

  • 'rs' - 同步地以只讀的方式打開文件。繞過操作系統(tǒng)的本地文件系統(tǒng)緩存。

該功能主要用于打開NFS掛載的文件,因為它允許你跳過潛在的過時的本地緩存。它對I/O性能有非常大的影響,所以除非需要它,否則不應使用這個flag。

注意這個flag不會將fs.open()變?yōu)橐粋€同步調用。因為如果你想要同步調用,你應使用fs.openSync()。

  • 'rs+' - 以讀寫的方式打開文件,告訴操作系統(tǒng)同步地打開它。注意事項請參閱'rs'

  • 'w' - 以只寫的方式打開文件。如果文件不存在,將會創(chuàng)建它。如果已存在,將會覆蓋它。

  • 'wx' - 類似于'w',但是路徑不存在時會失敗。

  • 'w+' - 以讀寫的方式打開文件。如果文件不存在,將會創(chuàng)建它。如果已存在,將會覆蓋它。

  • 'wx+' - 類似于'w+',但是路徑不存在時會失敗。

  • 'a' - 以附加的形式打開文件。如果文件不存在,將會創(chuàng)建它。

  • 'ax' - 類似于'a',但是路徑不存在時會失敗。

  • 'a+' - 以讀取和附加的形式打開文件。如果文件不存在,將會創(chuàng)建它。

  • 'ax+' - 類似于'a+',但是路徑不存在時會失敗。

參數mode用于設置文件模式(權限和sticky bits),但是前提是文件已被創(chuàng)建。它默認為0666,有可讀和可寫權限。

回調函數有兩個參數(err, fd)。

排除標識'x'open(2)中的O_EXCL標識)保證了目錄是被新創(chuàng)建的。在POSIX系統(tǒng)上,即使路徑指向了一個不存在的符號鏈接,也會被認定為文件存在。排除標識不能保證在網絡文件系統(tǒng)中有效。

在Linux下,無法對以追加形式打開的文件,在指定位置寫入數據。內核忽略了位置參數并且總是將數據追加到文件的末尾。

fs.openSync(path, flags[, mode])

同步版本的fs.open(),返回代表文件描述符的一個整數。

fs.utimes(path, atime, mtime, callback)

更改path所指向的文件的時間戳。

fs.utimesSync(path, atime, mtime)

同步版本的fs.utimes()。返回undefined

fs.futimes(fd, atime, mtime, callback)

更改文件描述符fd所指向的文件的時間戳。

fs.futimesSync(fd, atime, mtime)

同步版本的fs.futimes()。返回undefined。

fs.fsync(fd, callback)

異步版本的fsync(2)?;卣{函數只有一個可能的異常參數。

fs.fsyncSync(fd)

同步版本的fsync(2)。返回undefined。

fs.write(fd, buffer, offset, length[, position], callback)

向文件描述符fd指向的文件寫入buffer。

offsetlength決定了buffer的哪一部分被寫入文件。

position指定了文件中,數據被寫入的開始位置的偏移量。如果typeof position !== 'number',那么數據將會在當前位置被寫入。參閱pwrite(2)

回調函數有三個參數(err, written, buffer)。written指出了buffer中有多少字節(jié)被寫入。

注意,不等待回調函數而多次執(zhí)行fs.write是不安全的。這種情況下推薦使用fs.createWriteStream。

在Linux下,無法對以追加形式打開的文件,在指定位置寫入數據。內核忽略了位置參數并且總是將數據追加到文件的末尾。

fs.write(fd, data[, position[, encoding]], callback)

向文件描述符fd指向的文件寫入data。如果data不是一個Buffer實例,那么其值將被強制轉化為一個字符串。

position指定了文件中,數據被寫入的開始位置的偏移量。如果typeof position !== 'number',那么數據將會在當前位置被寫入。參閱pwrite(2)。

encoding是期望的字符串編碼。

回調函數有三個參數(err, written, buffer)。written指出了buffer中有多少字節(jié)被寫入。注意,寫入的字節(jié)與字符串字符是不同的。參閱Buffer.byteLength。

與寫入buffer不同,整個字符串都必須被寫入。不能指定子字符串。因為字節(jié)的偏移量可能與字符串的偏移量不相同。

注意,不等待回調函數而多次執(zhí)行fs.write是不安全的。這種情況下推薦使用fs.createWriteStream。

在Linux下,無法對以追加形式打開的文件,在指定位置寫入數據。內核忽略了位置參數并且總是將數據追加到文件的末尾。

fs.writeSync(fd, buffer, offset, length[, position])

fs.writeSync(fd, data[, position[, encoding]])

同步版本的fs.write()。返回被寫入的字節(jié)數。

fs.read(fd, buffer, offset, length, position, callback)

從文件描述符fd指向的文件讀取數據。

buffer是數據將要被寫入的緩沖區(qū)。

offset是開始向buffer寫入數據的緩沖區(qū)偏移量。

length是一個指定了讀取字節(jié)數的整數。

position是一個指定了從文件的何處開始讀取數據的整數。如果positionnull,數據將會從當前位置開始讀取。

回調函數有三個參數(err, bytesRead, buffer)。

fs.readSync(fd, buffer, offset, length, position)

同步版本的fs.read。返回讀取字節(jié)的個數。

fs.readFile(filename[, options], callback)

  • filename String
  • options Object | String

  • encoding String | Null 默認為null
  • flag String 默認為'r'

  • callback Function

異步得讀取文件的所有內容。例子:

fs.readFile('/etc/passwd', function (err, data) {
  if (err) throw err;
  console.log(data);
});

回調函數有兩個參數(err, data),data是文件的內容。

如果沒有指定編碼,那么將會返回源buffer

如果options是一個字符串,那么它將指定編碼,例子:

fs.readFile('/etc/passwd', 'utf8', callback);

fs.readFileSync(filename[, options])

同步版本的fs.readFile。返回文件的內容。

如果指定了編碼那么將會返回字符串。否則返回buffer。

fs.writeFile(filename, data[, options], callback)

  • filename String
  • data String | Buffer
  • options Object | String

  • encoding String | Null 默認為'utf8'
  • mode Number 默認為0o666
  • flag String 默認為'w'

  • callback Function

異步地向文件寫入數據,如果文件已經存在,那么會覆蓋它。data可以是一個字符串或一個buffer。

如果數據時一個buffer那么編碼會被忽略。編碼默認為'utf8'。

例子:

fs.writeFile('message.txt', 'Hello io.js', function (err) {
  if (err) throw err;
  console.log('It\'s saved!');
});

如果options是一個字符串,那么它將指定編碼,例子:

fs.writeFile('message.txt', 'Hello io.js', 'utf8', callback);

fs.writeFileSync(filename, data[, options])

同步版本的fs.writeFile。返回undefined。

fs.appendFile(filename, data[, options], callback)

  • filename String
  • data String | Buffer
  • options Object | String

  • encoding String | Null 默認為'utf8'
  • mode Number 默認為0o666
  • flag String 默認為'a'

  • callback Function

異步地向文件追加數據,如果文件不存在將會創(chuàng)建它。data可以是一個字符串或一個buffer。

例子:

fs.appendFile('message.txt', 'data to append', function (err) {
  if (err) throw err;
  console.log('The "data to append" was appended to file!');
});

如果options是一個字符串,那么它將指定編碼,例子:

fs.appendFile('message.txt', 'data to append', 'utf8', callback);

fs.appendFileSync(filename, data[, options])

同步版本的fs.appendFile。返回undefined。

fs.watchFile(filename[, options], listener)

監(jiān)視文件變化?;卣{函數listener會在文件每一次被訪問時調用。

第二參數是可選的。如果options被提供,那么它必須是一個含有兩個成員persistentinterval的對象。persistent表明了進程是否在文件被監(jiān)視時繼續(xù)執(zhí)行。interval表明了文件被輪詢的間隔(毫秒)。默認是{ persistent: true, interval: 5007 }。

listener有兩個參數,當前狀態(tài)對象和先前狀態(tài)對象:

fs.watchFile('message.text', function (curr, prev) {
  console.log('the current mtime is: ' + curr.mtime);
  console.log('the previous mtime was: ' + prev.mtime);
});

這兩個狀態(tài)對象都是fs.Stat實例。

如果你想要在文件被修改時被通知,而不僅僅是在被訪問時,你需要比較curr.mtimeprev.mtime

注意:fs.watchfs.watchFilefs.unwatchFile更高效。當可能時,請使用fs.watch替代它們。

fs.unwatchFile(filename[, listener])

停止監(jiān)視filename的變化。如果指定了listener,那么僅僅會移除指定的listener。否則所有的監(jiān)聽器都會被移除,并且停止繼續(xù)監(jiān)視文件。

對一個沒有被監(jiān)視的文件調用fs.unwatchFile()將不會發(fā)生任何事,而不是報錯。

注意:fs.watchfs.watchFilefs.unwatchFile更高效。當可能時,請使用fs.watch替代它們。

fs.watch(filename[, options][, listener])

監(jiān)視filename的變化,filename指向的可以是文件也可以是目錄。返回一個fs.FSWatcher對象。

第二個參數是可選的。options必須是一個對象。支持的布爾值屬性是persistentrecursivepersistent表明了進程是否在文件被監(jiān)視時繼續(xù)執(zhí)行。recursive表明了是否子目錄也需要被監(jiān)視,或僅僅監(jiān)視當前目錄。這只在支持的平臺(參閱下方警告)下傳遞一個目錄時有效。

默認是{ persistent: true, recursive: false }。

listener回調函數有兩個參數(event, filename)。event'rename''change'filename是觸發(fā)事件的文件名。

警告

fs.watch API 不是在所有平臺下都表現一致的,并且在一些情況下是不可用的。

recursive選項目前只支持OS X。只有FSEvents支持這種類型的文件監(jiān)控,所有其他平臺并不會很快都被支持。

可用性

這個特性依賴于底層操作系統(tǒng)提供的文件變化提示。

  • 在Linux系統(tǒng)下,它使用inotify。
  • 在BSD系統(tǒng)下,它使用kqueue
  • 在OS X下,對于文件它使用kqueue,對于目錄它使用FSEvents。
  • 在SunOS系統(tǒng)(包括SolarisSmartOS)下,它使用事件端口(event ports)。
  • 在Windows系統(tǒng)下,這個特性依賴于ReadDirectoryChangesW。

如果由于一些原因,底層功能不可用,那么fs.watch的功能也將不可用。例如,在網絡文件系統(tǒng)(NFS,SMB等)中監(jiān)視文件或目錄變化,往往結果不可靠或完全不可用。

你仍可以使用fs.watchFile,它使用了狀態(tài)輪詢。但是性能更差且可靠性更低。

Filename 參數

回調函數中提供的filename參數不是在所有平臺上都支持的(目前只支持Linux和Windows)。即使是在支持的平臺上,filename也不是總會被提供。因此,不要假設filename參數總會在回調函數中被提供,需要有一些檢測它是否為null的邏輯。

fs.watch('somedir', function (event, filename) {
  console.log('event is: ' + event);
  if (filename) {
    console.log('filename provided: ' + filename);
  } else {
    console.log('filename not provided');
  }
});

fs.exists(path, callback)

fs.exists()已被棄用。請使用fs.statfs.access替代。

檢查文件系統(tǒng)來測試提供的路徑是否存在。然后在回調函數的參數中提供結果truefalse

fs.exists('/etc/passwd', function (exists) {
  util.debug(exists ? "it's there" : "no passwd!");
});

fs.exists()是一個不符合潮流的函數,并且僅因一些歷史原因所以仍然錯在。在你的代碼中,不應有任何原因要繼續(xù)使用它。

特別的,在打開文件前檢查文件是否存在 是一種反模式。因為競態(tài)條件所以讓你的代碼十分脆弱:其他進程可能fs.exists()fs.open()之間刪除文件。所以僅僅就去打開一個文件,并且當它不存在時處理錯誤。

fs.existsSync(path)

同步版本的fs.exists。當文件存在,返回true,否則返回false。

fs.existsSync()已被棄用。請使用fs.statSyncfs.accessSync替代。

fs.access(path[, mode], callback)

對于指定的路徑,檢測用戶的權限。mode是一個可選的整數,指定了要被執(zhí)行的可訪問性檢查。以下是mode的一些可用的常量??梢酝ㄟ^“或”運算符(|)連接兩個或以上的值。

  • fs.F_OK - 文件對于當前進程可見。這對于檢查文件是否存在很有用,但是不提供任何rwx權限信息。這是默認值。
  • fs.R_OK - 文件對于當前進程可讀。
  • fs.W_OK - 文件對于當前進程可寫。
  • fs.X_OK - 文件對于當前進程可執(zhí)行。這在Windows上無效(將會表現得像fs.F_OK一樣)。

最后一個參數callback,是一個包含了潛在錯誤參數的回調函數。如果任何一個可訪問檢查失敗了,錯誤參數就會被提供。以下是一個在當前進程中檢查/etc/passwd可讀性和可寫性的例子。

fs.access('/etc/passwd', fs.R_OK | fs.W_OK, function(err) {
  util.debug(err ? 'no access!' : 'can read/write');
});

fs.accessSync(path[, mode])

同步版本的fs.access。如果任何一個可訪問性檢查失敗了,它會拋出異常。否則什么都不做。

Class: fs.Stats

fs.stat(),fs.lstat(),fs.lstat()和它們的同步版本函數所返回的對象。

  • stats.isFile()
  • stats.isDirectory()
  • stats.isBlockDevice()
  • stats.isCharacterDevice()
  • stats.isSymbolicLink() (僅在調用fs.lstat()時有效)
  • stats.isFIFO()
  • stats.isSocket()

對于一個普通的文件,util.inspect(stats)可能會返回:

{ dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }

請注意,atime,mtimebirthtimectime都是Date對象實例,并且你可以通過合適的方法來比較它們的值。普遍的使用方式是,調用getTime()來獲取unix時間戳并且這個整數可以被用來進行任何比較。但是還有一些可以展示模糊信息的方法。更多的詳細信息請參閱MDN JavaScript Reference頁。

Stat 時間值

stat對象中的各個時間有如下語義:

  • atime "訪問時間" - 文件數據最后一次被訪問時的時間。由mknod(2),utimes(2)read(2)系統(tǒng)調用改變。
  • mtime "修改時間" - 文件數據最后一次被修改的時間。由mknod(2),utimes(2)write(2)系統(tǒng)調用改變。
  • ctime "改變時間" - 文件狀態(tài)最后一次被改變(索引節(jié)點改變)的時間。由chmod(2),chown(2),link(2),mknod(2),rename(2),unlink(2),utimes(2),read(2)write(2)系統(tǒng)調用改變。
  • birthtime "創(chuàng)建時間" - 文件的創(chuàng)建時間。在文件被創(chuàng)建時設置。在創(chuàng)建時間不可用的的文件系統(tǒng)上,這個值可能會被ctime或是1970-01-01T00:00Z(unix時間戳0)填充。在Darwin或其他FreeBSD系統(tǒng)變體上,如果使用utimes(2)系統(tǒng)調用設置atime為一個比當前birthtime更早的時間,birthtime也會被這樣填充。

io.js v1.0 和 Node v0.12 前,Windows系統(tǒng)中ctime持有了birthtime值。但是在 v0.12 里,ctime不再是“創(chuàng)建時間”。在Unix系統(tǒng)中,它從來都不是。

fs.createReadStream(path[, options])

返回一個新的可讀流對象(參閱Readable Stream)。

options是一個有以下默認值的對象或字符串:

{ flags: 'r',
  encoding: null,
  fd: null,
  mode: 0o666,
  autoClose: true
}

options可以包含startend值來讀取指定范圍的文件數據。startend這兩個位置本身,也都是被包括的,并且start0開始。編碼可以是'utf8','ascii''base64'。

如果指定了fd,可讀流將會忽略path參數并且將會使用指定的文件描述符。這意味open事件不再會觸發(fā)。

如果autoClosefalse,那么文件描述符將不會被關閉,甚至是有錯誤發(fā)生時。關閉它將是你的責任,并且要確保沒有文件描述符泄漏。如果autoClosetrue(默認),那么在發(fā)生錯誤時,或到達文件描述末端時,它會被自動關閉。

從一個100字節(jié)的文件中讀取最后10字節(jié)數據的例子:

fs.createReadStream('sample.txt', {start: 90, end: 99});

如果options是一個字符串,那么它表示指定的編碼。

Class: fs.ReadStream

ReadStream是一個可讀流。

Event: 'open'

  • fd Integer 被可讀流使用的文件描述符

當可讀流文件被打開時觸發(fā)。

fs.createWriteStream(path[, options])

返回一個新的可寫流對象(參閱Writable Stream)。

options是一個有以下默認值的對象或字符串:

{ flags: 'w',
  encoding: null,
  fd: null,
  mode: 0o666 }

options可以包含一個start選項來允許從指定位置開始寫入數據。修改一個文件而不是替換它,需要一個r+標識,而不是默認的w。編碼可以是'utf8','ascii','binary''base64'。

與上文的ReadStream類似,如果指定了fd,可寫流會忽略path參數,并且使用指定的文件描述符。這意味open事件不再會觸發(fā)。

如果options是一個字符串,那么它表示指定的編碼。

Class: fs.WriteStream

WriteStream是一個可寫流。

Event: 'open'

  • fd Integer WriteStream使用的文件描述符

當可寫流文件被打開時觸發(fā)。

file.bytesWritten

至今為止寫入的字節(jié)數。不包括仍在寫入隊列中的數據。

Class: fs.FSWatcher

fs.watch()返回的對象。

watcher.close()

停止在指定的fs.FSWatcher上監(jiān)視文件變化。

Event: 'change'

  • event String 文件的改變類型
  • filename String The filename that changed (if relevant/available)被改變的文件(如果有意義/可用的話)

當被監(jiān)視的目錄或文件發(fā)生了改變時觸發(fā)。詳情參閱fs.watch。

Event: 'error'

  • error Error object

當錯誤發(fā)生時觸發(fā)。

以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號