Programmable interface to Clinic.js Flame
npm install @clinic/flame[![npm version][npm-version]][npm-url] [![Stability Stable][stability-stable]][stability-docs] [![Github Actions build status][actions-status]][actions-url]
[![Downloads][npm-downloads]][npm-url] [![Code style][lint-standard]][lint-standard-url]
Programmable interface to [Clinic.js][clinic-url] Flame. Learn more about Clinic.js: https://clinicjs.org/
To open an issue, please use the main repository with the flame label.
``
npm i -S @clinic/flame
* Node.js 16 and above
`js
const ClinicFlame = require('@clinic/flame')
const flame = new ClinicFlame()
flame.collect(['node', './path-to-script.js'], function (err, filepath) {
if (err) throw err
flame.visualize(filepath, filepath + '.html', function (err) {
if (err) throw err
})
})
`
`js`
const ClinicFlame = require('@clinic/flame')
const flame = new ClinicFlame()
* settings [
#### flame.collect(args, callback)
Starts a process by using 0x
0x will produce a file in the current working directory, with the process PID in
its filename. The filepath relative to the current working directory will be the
value in the callback.
stdout, stderr, and stdin will be relayed to the calling process. As willSIGINT
the event.
#### flame.visualize(dataFilename, outputFilename, callback)
Will consume the datafile specified by dataFilename, this datafile will beflame.collect
produced by the sampler using .
flame.visualize will then output a standalone HTML file to outputFilename.callback
When completed the will be called with no extra arguments, except a
possible error.
[stability-stable]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square
[stability-docs]: https://nodejs.org/api/documentation.html#documentation_stability_index
[npm-version]: https://img.shields.io/npm/v/@clinic/flame.svg?style=flat-square
[npm-url]: https://www.npmjs.org/@clinic/flame
[npm-downloads]: http://img.shields.io/npm/dm/@clinic/flame.svg?style=flat-square
[lint-standard]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[lint-standard-url]: https://github.com/feross/standard
[clinic-url]: https://github.com/clinicjs/node-clinic
[