[Node.js] Node.js 공식 문서 가이드(feat. fs.readFile)

fs.readFile

fs.readFile 메서드는 로컬에 존재하는 파일을 불러온다.

Node v16.x 기준

File system | Node.js v18.2.0 Documentation

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

fs.readFile 메서드는 3개의 전달인자를 받으며 이 중 path와 callback은 필수 전달인자이다.

path

path에는 파일 이름을 전달인자로 받는다. 문자열, 버퍼, URL, 숫자 타입을 받으며 일반적으로 문자열 타입을 받는다.

fs.readFile("/etc/readme.md", ..., ...);

options

options는 문자열 또는 객체 형태로 받는다. 문자열로 전달할 겨우 인코딩을 받는다.

fs.readFile("/etc/"readme.md", "utf-8", ...);

options를 객체로 줄때는 아래와 같이 준다.

const options = {
	encoding: "utf-8",
	flag: "r"
}

fs.readFile("/etc/readme.md", options, ...);

callback

callback 함수를 전달한다. 파일을 읽고 난 후에 비동기적으로 실행되는 함수이다.

callback은 함수로 받으며, err와 data 두가지 매개변수를 갖고 있다. 에러가 발생하지 않으면 err는 null이 되고, data에 문자열이나 Buffer 객체가 전달된다. data는 파일의 내용이다.

<aside> 💡 인코딩이 지정되어 있지 않으면 data에 Buffer가 전달된다.

</aside>

fs.readFile("readme.md", "utf-8", (err, data) => {
 if (err) {
		throw err;
	}
	console.log(data);
});