1. 개요

• 기본적으로 OS의 파일 메타데이터 가져오기
• 기본적은 fs.stat 은 비동기 + await 로 가져오기 가능
• 동기는 fs.statSync(path)

const fs = require('node:fs');
fs.stat('/Users/joe/test.txt', (err, stats) => {
  if (err) {
    console.error(err);
  }
  // we have access to the file stats in `stats`
});

2. 파일 페스 | Node.js File Paths

3. 파일읽기

• fs.readFile()  기본 (비동기), fs.readFileSync() (동기), await fs.readFile() 가능
• 전체 다 읽고 실행됨

3-1. Stream 예시

import fs from 'fs';
import { pipeline } from 'node:stream/promises';
import path from 'path';

const fileUrl = '<https://www.gutenberg.org/files/2701/2701-0.txt>';
const outputFilePath = path.join(process.cwd(), 'moby.md');

async function downloadFile(url, outputPath) {
  const response = await fetch(url);

  if (!response.ok || !response.body) {
    // consuming the response body is mandatory: <https://undici.nodejs.org/#/?id=garbage-collection>
    await response.body?.cancel();
    throw new Error(`Failed to fetch ${url}. Status: ${response.status}`);
  }

  const fileStream = fs.createWriteStream(outputPath);
  console.log(`Downloading file from ${url} to ${outputPath}`);

  await pipeline(response.body, fileStream);
  console.log('File downloaded successfully');
}

async function readFile(filePath) {
  const readStream = fs.createReadStream(filePath, { encoding: 'utf8' });

  try {
    for await (const chunk of readStream) {
      console.log('--- File chunk start ---');
      console.log(chunk);
      console.log('--- File chunk end ---');
    }
    console.log('Finished reading the file.');
  } catch (error) {
    console.error(`Error reading file: ${error.message}`);
  }
}

try {
  await downloadFile(fileUrl, outputFilePath);
  await readFile(outputFilePath);
} catch (error) {
  console.error(`Error: ${error.message}`);
}

• response body 가 readable 파일 스트림이니까 await pipeline(response.body, fileStream); 로 연결할 수 있다.
• pipeline 은 입출력을 맞추면 몇개고 stream 을 연결할 수 있다.

  • 예시

    pipeline(
      readable,
      gzip,
      encrypt,
      writable
    )
    Readable
    → Duplex/Transform
    → Duplex/Transform
    → Writable
    
    Readable: 읽기만 가능
    Writable: 쓰기만 가능
    Duplex: 읽기/쓰기 둘 다 가능
    Transform: 입력 받아 변환 후 출력
    Transform ⊂ Duplex
    

4. 파일 쓰기

4.1 가장 간단한 파일 쓰기

• writeFile fs.writeFileSync() fsPromises.writeFile()

const fs = require('node:fs');

const content = 'Some content!';

fs.writeFile('/Users/joe/test.txt', content, err => {
  if (err) {
    console.error(err);
  } else {
    // file written successfully
  }
});

try {
  fs.writeFileSync('/Users/joe/test.txt', content);
  // file written successfully
} catch (err) {
  console.error(err);
}
const fs = require('node:fs/promises');
async function example() {
  try {
    const content = 'Some content!';
    await fs.writeFile('/Users/joe/test.txt', content);
  } catch (err) {
    console.log(err);
  }
}
example();

Flag

fs.writeFile('/Users/joe/test.txt', content, { flag: 'a+' }, err => {});