headFile

Requires a Node.js runtime ('qsu/node')

Returns the first line of the specified text file path. The length argument is the total number of lines to print. Default is 1.

Parameters

Name	Type	Required	Default
filePath	string	●	–
File or directory path
lengthnamed	number	–	1
Number of lines of text to return

named parameters are passed as named parameters in Dart and keyword arguments in Python.

Returns

Promise::string|null

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'