{"_id":"@ampersarnie/amperf","_rev":"5-f7c6dd3be1f2ae039e10e4bfdc515b57","name":"@ampersarnie/amperf","description":"Amperf","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@ampersarnie/amperf","version":"0.1.0","description":"Amperf","main":"./lib/AmperfNode.js","options":{},"bin":{"amperf":"./bin/amperf"},"scripts":{"compile":"node_modules/babel-cli/bin/babel.js src --out-dir lib","devbuild":"npm run compile","prepublish":"npm run compile","lint":"eslint src/*"},"babel":{"presets":["es2015"]},"keywords":["es6","javascript","performance","perf"],"author":{"name":"Paul Taylor","email":"hello@ampersandwich.co.uk","url":"http://ampersandwich.co.uk"},"license":"MIT","devDependencies":{"babel-cli":"^6.6.5","babel-core":"^6.7.0","babel-preset-es2015":"^6.6.0","chai":"^3.5.0","mocha":"^2.4.5","rollup-plugin-babel":"^2.6.1","rollup-plugin-json":"^2.0.2"},"dependencies":{"@ampersarnie/outputs":"^0.1.0","@ampersarnie/implements":"^0.2.0"},"gitHead":"7e96d446d7e8e7768962ff1f44dfb0067e48764a","_id":"@ampersarnie/amperf@0.1.0","_shasum":"6ffa217aec74c9a3c2e9963021687a7a5a2ee062","_from":".","_npmVersion":"3.10.5","_nodeVersion":"6.2.1","_npmUser":{"name":"ampersarnie","email":"hello@ampersandwich.co.uk"},"dist":{"shasum":"6ffa217aec74c9a3c2e9963021687a7a5a2ee062","tarball":"https://registry.npmjs.org/@ampersarnie/amperf/-/amperf-0.1.0.tgz","integrity":"sha512-647mMmfDupfWqe4fWF9RHE3RtdpeXLuiRqGxroqvm70YIdWlHKivyIEJfJbxOmoUYw86fdRupUS5BcM6qJwcCg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQClK+VoRvNYCSj+MQdvJUNqh2j5788YcHXquk/XAit8LAIgFJHB8Ycmat44apCWn0EYAx3ydsPvV0E9pyFmtSP5G4Q="}]},"maintainers":[{"name":"ampersarnie","email":"hello@ampersandwich.co.uk"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/amperf-0.1.0.tgz_1473794121737_0.4417322133667767"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.0":{"name":"@ampersarnie/amperf","version":"0.2.0","description":"Amperf","main":"./lib/AmperfNode.js","options":{},"bin":{"amperf":"./bin/amperf"},"scripts":{"compile":"node_modules/babel-cli/bin/babel.js src --out-dir lib","devbuild":"npm run compile","prepublish":"npm run compile","lint":"eslint src/*"},"babel":{"presets":["es2015"]},"keywords":["es6","javascript","performance","perf"],"author":{"name":"Paul Taylor","email":"hello@ampersandwich.co.uk","url":"http://ampersandwich.co.uk"},"license":"MIT","devDependencies":{"babel-cli":"^6.6.5","babel-core":"^6.7.0","babel-preset-es2015":"^6.6.0"},"dependencies":{"@ampersarnie/outputs":"^0.1.0","@ampersarnie/implements":"^0.2.0"},"gitHead":"e7a3120043ed07a56815326fe717873fb385fcc9","_id":"@ampersarnie/amperf@0.2.0","_shasum":"fc72c067f08a0b900f53ba80b27a911f8c4a3677","_from":".","_npmVersion":"3.10.5","_nodeVersion":"6.2.1","_npmUser":{"name":"ampersarnie","email":"hello@ampersandwich.co.uk"},"dist":{"shasum":"fc72c067f08a0b900f53ba80b27a911f8c4a3677","tarball":"https://registry.npmjs.org/@ampersarnie/amperf/-/amperf-0.2.0.tgz","integrity":"sha512-was2O+mGptaZl69ExbpIHbeArrxqesyIcKv1w1oeTobVCueYwyI1O/iEuImzZVeGciupLIB2Ma2WhkpU3GZTtg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE4DLzMhLkoca/Hdpcd47tX9XMu390KU9l7qNqJLc3rwAiAVX3ZyHseJaEsdl1iKEKuTbUdfWGZz7P/b942HYBUBMg=="}]},"maintainers":[{"name":"ampersarnie","email":"hello@ampersandwich.co.uk"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/amperf-0.2.0.tgz_1473949486888_0.9540492615196854"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"readme":"# Amperf\n\n![Amperf](http://d.pr/i/16eAB+)\n\nAmperf provides the following information;\n\n* Total length of time for tests.\n* Average test time.\n* Average test memory usage.\n* Fastest and slowest iteration times.\n\n## Install\nIt's recommended that you install Amperf globally through NPM.\n```\nnpm i -g @ampersarnie/amperf\n```\nYou may need to [add an alias to `./bin/amperf` in your bash profile](https://www.digitalocean.com/community/tutorials/an-introduction-to-useful-bash-aliases-and-functions#how-to-declare-a-bash-alias). NPM will install global modules to `/usr/local/lib/node` or `/usr/local/lib/node_modules`. The full path will be similar to; `/usr/local/lib/node_modules/@ampersarnie/amperf/bin/amperf`.\n\n## Tests\n```js\nAmperf.describe('Suite of tests being run', function(AmperfTest) {\n    AmperfTest('Test spec', function() {\n        // Test code here.\n    });\n});\n```\n\n## Benchmarking\nAmperf provides some benchmarking capabilities allowing you to stipulate maximum speeds and memory usage to have.\n\n```js\nAmperf.describe('Suite of tests being run', function(AmperfTest) {\n    AmperfTest('Test spec', function() {\n        // Test code here.\n    }).bench({\n        time_total: 1, // seconds\n        time_average: 5.0 // milliseconds\n    });\n});\n```\n\n## CLI Options\nAmperf has a number of options for your test output from the command line.\n\n### --file / --f\n_Default: `./perf/test.js`_\n```\namperf --file perf/my-test.js\n```\nAlso allows for loading all files in a given directory.\n```\namperf --file perf/\n```\n\n### --template / --t\n_Default: `./DefaultTemplate.js`_\n```\namperf --file perf/my-test.js --template MyTemplate.js\n```\n\n### --iterations / --i\n_Default: `100`_\n```\namperf --file perf/my-test.js --iterations 256\n```\n\n### --show\n_Default: `cycle_time,time_average,memory_average,time_fastest,time_slowest`_\n\n__Shows only the cycle and average times__\n```\namperf --file perf/my-test.js --show cycle_time,time_average\n```\n\n## Templates\nAmperf allows for custom output templates. A list of the required methods and their arguments can be found in the `./src/TemplateInterface.js` file. You can see examples of the usage in both `./src/DefaultTemplate.js` and `./examples/templates/src/ExampleTemplate.js`.\n\n_The TemplateInterface does not need to be invoked within your template as these checks are handled by the AmperfTemplate class._\n","maintainers":[{"name":"ampersarnie","email":"hello@ampersandwich.co.uk"}],"time":{"modified":"2023-08-17T16:41:27.201Z","created":"2016-09-13T19:15:23.942Z","0.1.0":"2016-09-13T19:15:23.942Z","0.2.0":"2016-09-15T14:24:48.303Z"},"keywords":["es6","javascript","performance","perf"],"author":{"name":"Paul Taylor","email":"hello@ampersandwich.co.uk","url":"http://ampersandwich.co.uk"},"license":"MIT","readmeFilename":"README.md"}