Readdirp
lastmod 2026-11-16created 2026-01-053 edits
readdirp는 Node.js 의 fs.readdir 를 재귀적으로 확장한 라이브러리로, 하위 디렉터리까지 내려가며 찾은 파일과 디렉터리 항목을 스트림으로 내보낸다. 결과를 한꺼번에 배열로 모으지 않고 하나씩 흘려보내므로 큰 디렉터리 트리에서도 메모리와 CPU 사용이 적다. README 는 내장 fs.readdir 의 recursive: true 보다 빠르고 RAM 도 덜 쓴다고 밝힌다.
About
- 스트림 API 는
for await로 돌거나data·warn·error·end이벤트로 받음. 접근 권한 없는 파일처럼 처리하지 못한 항목은warn으로 알리고 계속 진행함 -
readdirpPromise는 전체 목록을 배열로 돌려주지만 스트림보다 메모리와 CPU 를 더 씀 -
fileFilter·directoryFilter함수로 포함할 항목을 고름. 필터를 통과하지 못한 디렉터리는 내려가지 않고,depth로 깊이를 제한함 -
type으로 파일, 디렉터리, 둘 다, 또는 소켓·파이프까지 포함한 전체 가운데 무엇을 내보낼지 정함 - 기본은
fs.Dirent를 돌려주고,alwaysStat: true면fs.Stats를 붙임. 실행 시간이 두 배까지 늘 수 있어 크기·수정 시각이 필요할 때만 켬 -
lstat: true면 심볼릭 링크 자체를 항목으로 내보냄. 3.5 부터 디렉터리를 가리키는 재귀 심볼릭 링크는 따라가지 않아 무한 루프를 막음 - 4.0(2024년 8월)에서 TypeScript 로 다시 작성하고 glob 지원과 의존성을 모두 없앰. CommonJS·ESM 겸용이며 Node 14 이상
- npm 과 JSR 로 배포. MIT 라이선스
See also
- Filesystem
- nodejs
- Chokidar - 효율적인 크로스플랫폼 파일 Watch 라이브러리