Documentation Index
Fetch the curated documentation index at: https://grafana_com_website/llms.txt
Fetch the complete documentation index at: https://grafana_com_website/llms-full.txt
Use this file to discover all available pages before exploring further.
STOP! If you are an AI agent or LLM, read this before continuing. This is the HTML version of a Grafana documentation page. Always request the Markdown version instead - HTML wastes context. Get this page as Markdown: /docs/k6/latest/javascript-api/k6-experimental/fs/open.md (append .md) or send Accept: text/markdown to /docs/k6/latest/javascript-api/k6-experimental/fs/open/. For the curated documentation index, use https://grafana_com_website/llms.txt. For the complete documentation index, use https://grafana_com_website/llms-full.txt.
open
The open function opens a file and returns a promise that resolves to a
File instance. Unlike the traditional
open function, which loads a file multiple times into memory, the filesystem module reduces memory usage by loading the file as little possible, and sharing the same memory space between all VUs. This approach reduces the risk of encountering out-of-memory errors, especially in load tests involving large files.
Parameters
| Parameter | Type | Description |
|---|---|---|
| path | string | The path to the file to open. Relative paths are resolved relative to the k6 script. |
Returns
A promise resolving to a File instance.
Example
import { open } from 'k6/experimental/fs';
// k6 doesn't support async in the init context. We use a top-level async function for `await`.
//
// Each Virtual User gets its own `file` copy.
// So, operations like `seek` or `read` won't impact other VUs.
const file = await open('bonjour.txt');
export default async function () {
// About information about the file
const fileinfo = await file.stat();
if (fileinfo.name != 'bonjour.txt') {
throw new Error('Unexpected file name');
}
console.log(JSON.stringify(fileinfo));
}Was this page helpful?
Related resources from Grafana Labs

