This is documentation for the next version of K6. For the latest stable release, go to the latest version.
File
The File
class represents a file with methods for reading, seeking, and obtaining file stats. It’s returned by the open function.
Products
LGTM+ Stack
Key Capabilities
Observability Solutions
Deploy The Stack
Open Source
Community resources
Dashboard templates
Try out and share prebuilt visualizations
Prometheus exporters
Get your metrics into Prometheus quickly
end-to-end solutions
Opinionated solutions that help you get there easier and faster
monitor infrastructure
Out-of-the-box KPIs, dashboards, and alerts for observability
visualize any data
Instantly connect all your data sources to Grafana
Learn
Stay up to date
Technical learning
Docs
Get started
Get started with Grafana
Build your first dashboard
Get started with Grafana Cloud
What's new / Release notes
Help build the future of open source observability software Open positions
Check out the open source projects we support Downloads
Deploy The Stack
end-to-end solutions
Opinionated solutions that help you get there easier and faster
visualize any data
Instantly connect all your data sources to Grafana
This is documentation for the next version of K6. For the latest stable release, go to the latest version.
The File
class represents a file with methods for reading, seeking, and obtaining file stats. It’s returned by the open function.
Property | Type | Description |
---|---|---|
path | string | The absolute path to the file. |
Method | Description |
---|---|
read | Reads up to buffer.byteLength bytes from the file into the passed buffer . Returns a promise resolving to the number of bytes read. |
seek | Sets the file position indicator for the file to the passed offset bytes. Returns a promise resolving to the new offset. |
stat | Returns a promise resolving to a FileInfo object with information about the file. |
import { open, SeekMode } from 'k6/experimental/fs';
const file = await open('bonjour.txt');
export default async function () {
// Seek to the beginning of the file
await file.seek(0, SeekMode.Start);
// About information about the file
const fileinfo = await file.stat();
if (fileinfo.name != 'bonjour.txt') {
throw new Error('Unexpected file name');
}
const buffer = new Uint8Array(4);
let totalBytesRead = 0;
while (true) {
// Read into the buffer
const bytesRead = await file.read(buffer);
if (bytesRead == null) {
// EOF
break;
}
// Do something useful with the content of the buffer
totalBytesRead += bytesRead;
// If bytesRead is less than the buffer size, we've read the whole file
if (bytesRead < buffer.byteLength) {
break;
}
}
// Check that we read the expected number of bytes
if (totalBytesRead != fileinfo.size) {
throw new Error('Unexpected number of bytes read');
}
}