{"_id":"@avitalique/k6-html-reporter","_rev":"4-e074115b903dfe59146d20b92f806750","name":"@avitalique/k6-html-reporter","dist-tags":{"latest":"1.0.5-dev.4"},"versions":{"1.0.5-dev.0":{"name":"@avitalique/k6-html-reporter","version":"1.0.5-dev.0","keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"author":"","license":"ISC","_id":"@avitalique/k6-html-reporter@1.0.5-dev.0","maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"homepage":"https://github.com/avitalique/k6-html-reporter#readme","bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"dist":{"shasum":"6b8ecbec2fea7fb6921f49fea0fcc472db771ded","tarball":"https://registry.npmjs.org/@avitalique/k6-html-reporter/-/k6-html-reporter-1.0.5-dev.0.tgz","fileCount":6,"integrity":"sha512-qT5xvJWrei7Z+1A55rDpB9iQ+7a7TgjJNsgYm+CZnEi9jbaGs26eOfleUeV3Is69BMWu6ez8lwidi8/0ack+vg==","signatures":[{"sig":"MEUCIQDuM/pH74YzJFOEMiVjSqw5zQ1V9Fm3/UasHbM1eJmiTAIgCK+12WbjGMRSEOymUdVcvzmt7hVKTYYFl3RE8WUVThg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15914},"main":"dist/index.js","gitHead":"0fce83b665b3a71bb729055cce16c6e184f51b08","scripts":{"dev":"rm -rf dist && tsc && cd dev && node index.js","test":"jest","build":"rm -rf dist && tsc","start":"ts-node src/index.ts"},"typings":"dist/index.d.ts","_npmUser":{"name":"avitalique","email":"avitalique@gmail.com"},"repository":{"url":"git+https://github.com/avitalique/k6-html-reporter.git","type":"git"},"_npmVersion":"10.8.3","description":"A html reporter for k6","directories":{},"_nodeVersion":"22.9.0","dependencies":{"ejs":"^3.1.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.5","ts-node":"^9.1.0","typescript":"^4.2.3","@types/jest":"^26.0.20","@types/node":"^14.14.10"},"_npmOperationalInternal":{"tmp":"tmp/k6-html-reporter_1.0.5-dev.0_1734011795203_0.6991941971361639","host":"s3://npm-registry-packages-npm-production"}},"1.0.5-dev.1":{"name":"@avitalique/k6-html-reporter","version":"1.0.5-dev.1","keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"author":"","license":"ISC","_id":"@avitalique/k6-html-reporter@1.0.5-dev.1","maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"homepage":"https://github.com/avitalique/k6-html-reporter#readme","bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"dist":{"shasum":"3d31647df70367add1e5e81257eb52e2b383c59f","tarball":"https://registry.npmjs.org/@avitalique/k6-html-reporter/-/k6-html-reporter-1.0.5-dev.1.tgz","fileCount":18,"integrity":"sha512-M+H8QFO8p/lPfheGi2LTfx3D7FHYK4EKCma5QYN0oXhS9Wtz1S6Gg3+BWU39rbq4uRwtzOwzxNf/ACfjzbcmaw==","signatures":[{"sig":"MEYCIQDaTnXm4kDtlWZdA69EVgeMLNdoVGtC84JGAwPeHtHGwwIhAINv7gLJU+uubNynhGdVeiKR2qJCj7YHcullqLtoCUAy","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31477},"main":"dist/index.js","gitHead":"c948b7a0ca1ade0467bb4fe1b5272c58a4e27c9d","scripts":{"dev":"rm -rf dist && tsc && cd dev && node index.js","test":"jest","build":"rm -rf dist && tsc","start":"ts-node src/index.ts"},"typings":"dist/index.d.ts","_npmUser":{"name":"avitalique","email":"avitalique@gmail.com"},"repository":{"url":"git+https://github.com/avitalique/k6-html-reporter.git","type":"git"},"_npmVersion":"10.8.3","description":"A html reporter for k6","directories":{},"_nodeVersion":"22.9.0","dependencies":{"ejs":"^3.1.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.5","ts-node":"^9.1.0","typescript":"^4.2.3","@types/jest":"^26.0.20","@types/node":"^14.14.10"},"_npmOperationalInternal":{"tmp":"tmp/k6-html-reporter_1.0.5-dev.1_1734012340327_0.7578775105374687","host":"s3://npm-registry-packages-npm-production"}},"1.0.5-dev.2":{"name":"@avitalique/k6-html-reporter","version":"1.0.5-dev.2","keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"author":"","license":"ISC","_id":"@avitalique/k6-html-reporter@1.0.5-dev.2","maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"homepage":"https://github.com/avitalique/k6-html-reporter#readme","bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"dist":{"shasum":"d96d2375cee0a489d1df86f45d78a0518c1fa887","tarball":"https://registry.npmjs.org/@avitalique/k6-html-reporter/-/k6-html-reporter-1.0.5-dev.2.tgz","fileCount":18,"integrity":"sha512-5WFfMy8sFcJ+HuiY75jg0r+Z4pXGHmm42Vp2W9k+4sWUGXvOr5n4Oy/bbUPuPPdLr4xpVurBx6TuP+GgJBZMNw==","signatures":[{"sig":"MEUCIAIVG3aIC2uQTankgrBmFNgEp34tZfB5KPkhC77tjf1+AiEAhzB1OyFesSKPIkbqsAHio3S7F3oUO10Yp+/66m0cjuM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38293},"main":"dist/index.js","gitHead":"6d2f35509c1964ca59e0ef414c0dd99679fe7ba1","scripts":{"dev":"rm -rf dist && tsc && cd dev && node index.js","test":"jest","build":"rm -rf dist && tsc","start":"ts-node src/index.ts"},"typings":"dist/index.d.ts","_npmUser":{"name":"avitalique","email":"avitalique@gmail.com"},"repository":{"url":"git+https://github.com/avitalique/k6-html-reporter.git","type":"git"},"_npmVersion":"10.8.3","description":"A html reporter for k6","directories":{},"_nodeVersion":"22.9.0","dependencies":{"ejs":"^3.1.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.5","ts-node":"^9.1.0","typescript":"^4.2.3","@types/jest":"^26.0.20","@types/node":"^14.14.10"},"_npmOperationalInternal":{"tmp":"tmp/k6-html-reporter_1.0.5-dev.2_1734084764247_0.4882624201692649","host":"s3://npm-registry-packages-npm-production"}},"1.0.5-dev.3":{"name":"@avitalique/k6-html-reporter","version":"1.0.5-dev.3","keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"author":"","license":"ISC","_id":"@avitalique/k6-html-reporter@1.0.5-dev.3","maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"homepage":"https://github.com/avitalique/k6-html-reporter#readme","bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"dist":{"shasum":"1fee44d269469d3686edfb5a4bf24bfa34e4e875","tarball":"https://registry.npmjs.org/@avitalique/k6-html-reporter/-/k6-html-reporter-1.0.5-dev.3.tgz","fileCount":19,"integrity":"sha512-phTDlE17/3FfKm+IefSAboBSX13iIpOhG5O3DdRbGOWWKv2DN5SOaXHaEklK0beAd2rZsxQvPFU3AFzjFcJsjg==","signatures":[{"sig":"MEUCIDnQuGOreNbcdClvQCOvnISseHER7dqs4VUv6pakLJ7wAiEAorTA7xmg1q5lREdCcynOY0kYaQSXmNPV3qXFNTEaTyM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38482},"main":"dist/index.js","gitHead":"403356c5fbe434e470e7844cbe786949351c51c7","scripts":{"dev":"rm -rf dist && tsc && cd dev && node index.js","test":"jest","build":"rm -rf dist && tsc","start":"ts-node src/index.ts"},"typings":"dist/index.d.ts","_npmUser":{"name":"avitalique","email":"avitalique@gmail.com"},"repository":{"url":"git+https://github.com/avitalique/k6-html-reporter.git","type":"git"},"_npmVersion":"10.8.3","description":"A html reporter for k6","directories":{},"_nodeVersion":"22.9.0","dependencies":{"ejs":"^3.1.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.5","ts-node":"^9.1.0","typescript":"^4.2.3","@types/jest":"^26.0.20","@types/node":"^14.14.10"},"_npmOperationalInternal":{"tmp":"tmp/k6-html-reporter_1.0.5-dev.3_1734085297560_0.5822652109306328","host":"s3://npm-registry-packages-npm-production"}},"1.0.5-dev.4":{"name":"@avitalique/k6-html-reporter","version":"1.0.5-dev.4","description":"A html reporter for k6","main":"dist/index.js","typings":"dist/index.d.ts","dependencies":{"ejs":"^3.1.5"},"devDependencies":{"@types/jest":"^26.0.20","@types/node":"^14.14.10","jest":"^29.7.0","ts-jest":"^29.2.5","ts-node":"^9.1.0","typescript":"^4.2.3"},"scripts":{"build":"rm -rf dist && tsc","dev":"rm -rf dist && tsc && cd dev && node index.js","start":"ts-node src/index.ts","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/avitalique/k6-html-reporter.git"},"keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"author":"","license":"ISC","homepage":"https://github.com/avitalique/k6-html-reporter#readme","_id":"@avitalique/k6-html-reporter@1.0.5-dev.4","gitHead":"e7f9c5bd5a64c9ae307d353e676f2c0985625555","bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"_nodeVersion":"22.9.0","_npmVersion":"10.8.3","dist":{"integrity":"sha512-njgtemh+1IZ3ukFnoQLRtwibN/mNpr393BR4Y3aYLvzupfZEM+et13KL/S7TW8VDiFjv/J2ChXfclzoJZteONQ==","shasum":"fdd39219459b5138b7fc1af00fa087217e39836b","tarball":"https://registry.npmjs.org/@avitalique/k6-html-reporter/-/k6-html-reporter-1.0.5-dev.4.tgz","fileCount":19,"unpackedSize":38971,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDMF4R8cefQGYhxEeAdpMJXtBkvxaVggvldmeS9k+DMlAiBr0xLDK7+dv553ggaTK7auANrRwDXxwqa1wePEhXSDbQ=="}]},"_npmUser":{"name":"avitalique","email":"avitalique@gmail.com"},"directories":{},"maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/k6-html-reporter_1.0.5-dev.4_1734086921836_0.009226002567414238"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-12T13:56:35.095Z","modified":"2024-12-13T10:48:42.192Z","1.0.5-dev.0":"2024-12-12T13:56:35.402Z","1.0.5-dev.1":"2024-12-12T14:05:40.483Z","1.0.5-dev.2":"2024-12-13T10:12:44.429Z","1.0.5-dev.3":"2024-12-13T10:21:37.706Z","1.0.5-dev.4":"2024-12-13T10:48:42.011Z"},"bugs":{"url":"https://github.com/avitalique/k6-html-reporter/issues"},"license":"ISC","homepage":"https://github.com/avitalique/k6-html-reporter#readme","keywords":["report","k6","html","json to html","k6 html reporter","k6 summary report"],"repository":{"type":"git","url":"git+https://github.com/avitalique/k6-html-reporter.git"},"description":"A html reporter for k6","maintainers":[{"name":"avitalique","email":"avitalique@gmail.com"}],"readme":"# k6-html-reporter\n\nA light weight html reporter for k6\n\n| :exclamation: This is a customization of [`szboynono/k6-html-reporter`](https://github.com/szboynono/k6-html-reporter)  |\n|-------------------------------------------------------------------------------------------------------------------------|\n \n\n\n## Install\nNPM:\n\n``` bash\nnpm install @avitalique/k6-html-reporter --save-dev\n```\n\nYARN:\n\n```bash\nyarn add @avitalique/k6-html-reporter --dev\n```\n\n\n\n## Usage\n\n1. Install the package\n2. Create a js/ts file and specify the options:\n\n```js\n\nconst reporter = require('k6-html-reporter');\n\nconst options = {\n        jsonFile: <path-to-json-report>,\n        output: <path-to-output-directory>,\n    };\n\nreporter.generateSummaryReport(options);\n    \n```\n\nfor typescript\n\n```ts\nimport {generateSummaryReport} from 'k6-html-reporter';\n\nconst options = {\n        jsonFile: <path-to-json-report>,\n        output: <path-to-output-directory>,\n    };\n\ngenerateSummaryReport(options);\n```\n3. Output a JSON summary output with the `handleSummary` function provided by k6, [more info](https://k6.io/docs/results-visualization/end-of-test-summary).\n```js\nexport default function () { /** some tests here */}\nexport function handleSummary(data) {\n  console.log('Preparing the end-of-test summary...');\n  return {\n      <path-to-json-report>: JSON.stringify(data),\n  }\n}\n```\n\n> **Note**: The ` --summary-export=path/to/file.json` run option is no longer recomanded after k6 v0.30.0.\n\n4. Run the code in step two as a node.js script after the test execution:\n```bash\nnode xxxx.js\n```\n\n### Sample report:\n![Alt text](./screenshot/k6.png?raw=true \"Optional Title\")\n","readmeFilename":"README.md"}