[exp]-fs · Magic_sword2

[TOC] # 簡介說明 ``` 版本：fs 作用：文件操作模塊 ``` # fs # *open() ***** 異步地打開文件 ### 返回類型 ``` None ``` ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] flag: * 類型：字符串 * 默認值：無 * 描述：訪問模式 * 可選值：[ ] mode : * 類型：字符串 * 默認值：無 * 描述：訪問權限 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` fs.open('./package.json', 'r',function (err, fd) { console.log(fd); }); ``` # *openSync() ***** 同步地打開文件 # *opendir() ***** 異步地打開目錄 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] options: * 類型：字符串 * 默認值：無 * 描述：可選參數 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] # *opendirSync() ***** 同步地打開目錄 # *createReadStream() ***** 創建一個讀取文件流stream對象 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：讀取的文件路徑 * 可選值：[ ] options : * 類型：對象 * 默認值：無 * 描述：可選參數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` const fs = require("fs"); let readStream = fs.createReadStream("./README.md", {encoding: 'utf8'}); readStream.on("open", (data) => { console.log('打開了', data) }); readStream.on("data", (data) => { console.log("數據來了！"); console.log(data); console.log("已經讀取的字節數", readStream.bytesRead); }); readStream.on("close", (data) => { console.log('guanle') }); console.log(readStream.path + "哈哈哈"); ``` 2. 判斷流 ``` const readable = getReadableStreamSomehow(); readable.on('readable', () => { let chunk; while (null !== (chunk = readable.read())) { console.log(`接收到 ${chunk.length} 字節的數據`); } }); ``` # *createWriteStream() ***** 創建一個寫入文件流，詳見stream ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：寫入的文件路徑 * 可選值：[ ] options : * 類型：對象 * 默認值：無 * 描述：可選參數 * 可選值：[ ] # *appendFile() ***** 異步地將數據追加到文件，如果文件尚不存在則創建該文件 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑，可以是fd，為已經打開的文件追加 * 可選值：[ ] data: * 類型：字符串 * 默認值：無 * 描述：文件數據 * 可選值：[ ] options : * 類型：對象 * 默認值：無 * 描述：參數{ encoding | mode | flag } * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` fs.appendFile('message.txt', '追加的數據', (err) => { if (err) throw err; console.log('數據已追加到文件'); }); ``` # *appendFileSync() ***** 同步地將數據追加到文件，如果文件尚不存在則創建該文件 # *write() ***** 異步將 buffer 寫入到 fd 指定的文件 # *writeSync() ***** 同步將 buffer 寫入到 fd 指定的文件 # *writeFile() ***** 當 file 是一個文件名時，異步地將數據寫入到一個文件，如果文件已存在則覆蓋該文件 ### 參數說明 file : * 類型：字符串 * 默認值：無 * 描述：文件句柄或文件名 * 可選值：[ ] data : * 類型：buffer * 默認值：無 * 描述：寫入的數據 * 可選值：[ ] options: * 類型：對象 * 默認值：無 * 描述：參數選項 * 可選值：[ ] callback: * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] # *writeFileSync() ***** 當 file 是一個文件名時，異步地將數據寫入到一個文件，如果文件已存在則覆蓋該文件 # *writev() ***** 使用 writev() 將一個 ArrayBufferView 數組異步寫入 fd 指定的文件 # *writevSync() ***** 使用 writev() 將一個 ArrayBufferView 數組同步寫入 fd 指定的文件 # *read() ***** 異步地讀取文件內容 ### 參數說明 fd: * 類型：整型 * 默認值：無 * 描述：文件操作句柄 * 可選值：[ ] buffer : * 類型：buffer * 默認值：無 * 描述：二進制對象 * 可選值：[ ] offset : * 類型：整型 * 默認值：無 * 描述：buffer 中開始寫入的偏移量 * 可選值：[ ] length : * 類型：整型 * 默認值：無 * 描述：指定要讀取的字節數 * 可選值：[ ] position : * 類型：整型 * 默認值：無 * 描述：指定從文件中開始讀取的位置 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] # *readSync() ***** 同步地讀取文件內容 # *readdir() ***** 異步讀取目錄內容 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：讀取目錄 * 可選值：[ ] options : * 類型：對象 * 默認值：無 * 描述：可選參數 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] # *readdirSync() ***** 同步讀取目錄內容 # *readFile() ***** 異步地讀取文件的全部內容。 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] options : * 類型：{ encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding * 默認值：無 * 描述：可選參數 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] # *readFileSync() ***** 同步地讀取文件的全部內容。 ### 示例內容 1. 舉例說明 ``` const fs = require("fs"); var data = fs.readFileSync('./page/index.js'); console.log("同步讀取: " + data.toString()); ``` # *readlink() ***** readlink # *readlinkSync() ***** readlinkSync # *access() ***** 測試用戶對 path 指定的文件或目錄的權限 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] mode : * 類型：字符串 * 默認值：無 * 描述：訪問模式 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` 不推薦open之前使用access檢測，無法保證原子性 const file = 'package.json'; // 檢查當前目錄中是否存在該文件。 fs.access(file, fs.constants.F_OK, (err) => { console.log(`${file} ${err ? '不存在' : '存在'}`); }); // 檢查文件是否可讀。 fs.access(file, fs.constants.R_OK, (err) => { console.log(`${file} ${err ? '不可讀' : '可讀'}`); }); // 檢查文件是否可寫。 fs.access(file, fs.constants.W_OK, (err) => { console.log(`${file} ${err ? '不可寫' : '可寫'}`); }); // 檢查當前目錄中是否存在該文件，以及該文件是否可寫。 fs.access(file, fs.constants.F_OK | fs.constants.W_OK, (err) => { if (err) { console.error( `${file} ${err.code === 'ENOENT' ? '不存在' : '只可讀'}`); } else { console.log(`${file} 存在，且它是可寫的`); } }); ``` # *accessSync() ***** 同步地測試用戶對 path 指定的文件或目錄的權限 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] mode : * 類型：字符串 * 默認值：無 * 描述：訪問模式 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` try { fs.accessSync('etc/passwd', fs.constants.R_OK | fs.constants.W_OK); console.log('可以讀寫'); } catch (err) { console.error('無權訪問'); } ``` # *existsSync() ***** 如果傳入路徑存在，則返回true # *watch() ***** 異步監視 filename 的更改，其中 filename 是文件或目錄 # *watchFile() ***** 異步監視 filename 的更改。每當訪問文件時都會調用 listener 回調。 # *unwatchFile() ***** 停止監視 filename 的變化 # *utimes() ***** 異步更改 path 指向的對象的文件系統時間戳 # *utimesSync() ***** 同步更改 path 指向的對象的文件系統時間戳 # *realpath() ***** 異步返回絕對路徑 # *realpath.native() ***** 異步返回絕對路徑 # *realpathSync() ***** 同步返回絕對路徑 # *realpathSync.native() ***** 同步返回絕對路徑 # *rename() ***** 異步地將 oldPath 上的文件重命名為 newPath 提供的路徑名 # *renameSync() ***** 同步地將 oldPath 上的文件重命名為 newPath 提供的路徑名 # *rmdir() ***** 異步刪除目錄 # *rmdirSync() ***** 同步刪除目錄 # *mkdir() ***** 異步地創建目錄 ### 參數說明 path : * 類型：字符串 * 默認值：無 * 描述：文件路徑 * 可選值：[ ] options : * 類型：字符串 * 默認值：無 * 描述：可選參數 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` fs.mkdir("./mad/mad", {recursive: true}, function (err) { console.log(err); }); ``` # *mkdirSync() ***** 同步地創建目錄 # *mkdtemp() ***** 創建一個唯一的臨時目錄 ### 參數說明 prefix : * 類型：字符串 * 默認值：無 * 描述：指定前綴 * 可選值：[ ] options : * 類型：對象 * 默認值：無 * 描述：可選參數 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` const fs = require('fs'); fs.mkdtemp("./temp", (err, folder) => { if (err) throw err; console.log(folder); // 打印: /tmp/目錄-itXde2 或 C:\Users\...\AppData\Local\Temp\目錄-itXde2 }); ``` # *mkdtempSync() ***** 同步創建臨時目錄，返回創建的目錄路徑。 # *stat() ***** 異步獲取文件信息 # *statSync() ***** 同步獲取文件信息 # *truncate() ***** 異步的 truncate(2)。除了可能的異常，完成回調沒有其他參數。文件描述符也可以作為第一個參數傳入 # *truncateSync() ***** 同步的 truncate(2)。除了可能的異常，完成回調沒有其他參數。文件描述符也可以作為第一個參數傳入 # *symlink() ***** 異步的 symlink(2)，它會創建名為 path 的鏈接，該鏈接指向 target # *symlinkSync() ***** 同步的 symlink(2)，它會創建名為 path 的鏈接，該鏈接指向 target # *unlink() ***** 異步地刪除文件或符號鏈接。除了可能的異常，完成回調沒有其他參數。 # *unlinkSync() ***** 同步地刪除文件或符號鏈接。除了可能的異常，完成回調沒有其他參數。 # *chmod() ***** 異步的更改文件權限 ### *權限附錄 1. 舉例說明 ![權限附錄](images/權限附錄.png) # *chmodSync() ***** 同步的更改文件權限 # *chown() ***** 異步地更改文件的所有者和群組 # *chownSync() ***** 同步地更改文件的所有者和群組 # *close() ***** 異步的 close()。除了可能的異常，完成回調沒有其他參數。 # *closeSync() ***** 同步的 close()。除了可能的異常，完成回調沒有其他參數。 # *copyFile() ***** 異步地將 src 拷貝到 dest。 ### 參數說明 src : * 類型：字符串 * 默認值：無 * 描述：要拷貝的源文件名 * 可選值：[ ] dest : * 類型：字符串 * 默認值：無 * 描述：拷貝操作的目標文件名 * 可選值：[ ] flags : * 類型：對象 * 默認值：無 * 描述：用于拷貝操作的修飾符 * 可選值：[ ] callback : * 類型：fn * 默認值：無 * 描述：回調函數 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` const fs = require('fs'); // 默認情況下將創建或覆蓋目標文件。 fs.copyFile('源文件.txt', '目標文件.txt', (err) => { if (err) throw err; console.log('源文件已拷貝到目標文件'); }); ``` # *copyFileSync() ***** 同步地將 src 拷貝到 dest # *fchmod() ***** fchmod # *fchmodSync() ***** fchmodSync # *fchown() ***** fchown # *fchownSync() ***** fchownSync # *fdatasync() ***** fdatasync # *fdatasyncSync() ***** fdatasyncSync # *fstat() ***** fstat # *fstatSync() ***** fstatSync # *fsync() ***** fsync # *fsyncSync() ***** fsyncSync # *ftruncate() ***** ftruncate # *ftruncateSync() ***** ftruncateSync # *futimes() ***** fsyncSync # *futimesSync() ***** futimesSync # *lchmod() ***** lchmod # *lchmodSync() ***** lchmodSync # *lchown() ***** lchmod # *lchownSync() ***** lchmodSync # *lstat() ***** lstat # *lstatSync() ***** lstatSync # *link() ***** link # *linkSync() ***** linkSync