본문으로 건너뛰기

headFile

Node.js 런타임 필요 ('qsu/node')

지정된 텍스트 파일 경로의 첫 줄을 반환합니다. length 인수는 인쇄할 총 줄 수입니다. 기본값은 1입니다.

요청한 줄 수에 필요한 만큼만 읽으므로, 비용이 파일 크기를 따라가지 않습니다.

줄은 \n, \r\n, 단독 \r에서 나뉩니다. 올바른 UTF-8이 아닌 바이트는 예외를 발생시키지 않고 대체 문자 U+FFFD가 되며, 맨 앞의 바이트 순서 표식(BOM)은 그대로 유지됩니다.

Parameters

이름타입필수기본값
filePathstringStringstr
File or directory path
lengthnamedkeywordnumberint1
Number of lines of text to return

named이 파라미터는 named 파라미터로 전달합니다.

keyword이 파라미터는 키워드 인자로 전달하거나, 대신 dict 하나로 전달합니다.

Returns

Promise<string | null>

Future<String?>

str | None

Examples

javascript
await headFile('/home/targets/hello.md', 2); // '# Hello, World!\nSecond line'
dart
await headFile('/home/targets/hello.md', length: 2); // '# Hello, World!\nSecond line'
python
headFile('/home/targets/hello.md', 2) # '# Hello, World!\nSecond line'

Released under the MIT License