@types/k6/global.d.ts

TypeScript definitions for k6

/*
 * Custom entities exposed in the global environment.
 *
 * The global environment changes with execution context. Some items are
 * available only in the init context, others only during VU logic execution,
 * others in both contexts. Comments note availability.
 */

export {};

// Available without importing
declare global {
    // === Init context only ===
    // -------------------------

    /**
     * Opens a file, reading all its contents into memory.
     * https://grafana.com/docs/k6/latest/javascript-api/init-context/open/
     * @param filePath - Path to file.
     * @returns File contents decoded as UTF-8.
     * @example
     * let binFile = open('/path/to/file.bin', 'b');
     * export default function () {
     * var data = {
     *    field: 'this is a standard form field',
     *    file: http.file(binFile, 'test.bin'),
     *  };
     *  const res = http.post('https://example.com/upload', data);
     *  sleep(3);
     * }
     */
    function open(filePath: string): string;

    /**
     * Opens a file, reading all its contents into memory.
     * https://grafana.com/docs/k6/latest/javascript-api/init-context/open/
     * @param filePath - Path to file.
     * @returns Binary file contents.
     * @example
     * let binFile = open('/path/to/file.bin', 'b');
     * export default function () {
     * var data = {
     *    field: 'this is a standard form field',
     *    file: http.file(binFile, 'test.bin'),
     *  };
     *  const res = http.post('https://example.com/upload', data);
     *  sleep(3);
     * }
     */
    function open(filePath: string, mode: "b"): ArrayBuffer;

    // === Init context and VU logic ===
    // ---------------------------------

    /**
     * Environment variables.
     * https://grafana.com/docs/k6/latest/using-k6/environment-variables/
     */
    var __ENV: { [name: string]: string };

    // === VU logic only ===
    // ---------------------

    /**
     * Current VU number.
     * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
     */
    var __VU: number;

    /**
     * Current iteration number.
     * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
     */
    var __ITER: number;

    interface ImportMeta {
        /**
         * Resolve a path to a URL string in the same way an import statement does.
         * https://grafana.com/docs/k6/latest/javascript-api/import.meta/resolve/
         */
        resolve(specifier: string): string;
    }
}