Referencia de Allure Tinybench

runWithAllure

• runWithAllure(bench: Bench): Promise<Task[]>

Ejecuta el benchmark una vez con bench.run() y devuelve las mismas tareas que bench.run(). Después de la ejecución, registra los resultados de todas las tareas como métricas de rendimiento, en un solo lote.

import { runWithAllure } from "allure-tinybench";
import { Bench } from "tinybench";

const bench = new Bench({ time: 100 });

bench.add("json.parse.simple", () => JSON.parse('{"status":"passed"}'));

const tasks = await runWithAllure(bench);

runWithAllure() debe llamarse durante una ejecución de prueba con una integración de Allure para JavaScript. Sin ella, Allure imprime una advertencia y no registra nada.

Métricas registradas

Para cada tarea, se registra una medición:

Campo	Valor
key	El nombre de la tarea.
value	La duración media de la tarea, en milisegundos.
start	El momento en que comenzó la ejecución del benchmark. Es el mismo para todas las tareas.
stop	El momento en que finalizó la ejecución del benchmark. Es el mismo para todas las tareas.

Solo se registran las tareas completadas, así como las tareas abortadas para las que Tinybench todavía proporciona estadísticas. Las tareas con un nombre vacío se omiten.

Limitaciones

• Los nombres de las tareas se usan como claves de métrica, así que manténgalos únicos y estables entre ejecuciones. Cuando se renombra una tarea, Allure la trata como una métrica nueva.
• No ejecute la misma instancia de Bench con runWithAllure() varias veces a la vez. Diferentes instancias de Bench pueden ejecutarse al mismo tiempo.