DefinitelyTyped/types/k6/global.d.ts

/*
 * 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.
 */

import { bytes } from '.';

export {};

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

    /**
     * Opens a file, reading all its contents into memory.
     * https://docs.k6.io/docs/open-filepath-mode
     * @param filePath - Path to file.
     * @returns File contents decoded as UTF-8.
     * @public
     */
    function open(filePath: string): string;

    /**
     * Opens a file, reading all its contents into memory.
     * https://docs.k6.io/docs/open-filepath-mode
     * @param filePath - Path to file.
     * @returns Binary file contents.
     * @public
     */
    function open(filePath: string, mode: 'b'): bytes;

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

    /**
     * Environment variables.
     * https://docs.k6.io/docs/environment-variables
     * @public
     */
    const __ENV: { [name: string]: string };

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

    /**
     * Interface to system console.
     * @public
     */
    let console: Console;

    /**
     * Current VU number.
     * https://docs.k6.io/docs/execution-context-variables
     * @public
     */
    const __VU: number;

    /**
     * Current iteration number.
     * https://docs.k6.io/docs/execution-context-variables
     * @public
     */
    const __ITER: number;
}

/** @public */
interface Console {
    /** Log debug message. */
    debug: Logger;

    /** Log error message. */
    error: Logger;

    /** Log informational message. */
    info: Logger;

    /** Log message. */
    log: Logger;

    /** Log warning message. */
    warn: Logger;
}

/**
 * Log message procedure.
 * @public
 */
interface Logger {
    /**
     * @param msg - Message to log.
     * @param fields - Arbitrary data to attach to message.
     */
    (msg: any, ...fields: any[]): void;
}