Skip to content
Programmable interface to `clinic flame`
Branch: master
Clone or download
Latest commit 0d70eb4 Mar 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
analysis Outline code area groupings (#79) Jan 30, 2019
collect Add --dest flag. (#31) Nov 16, 2018
debug Feature/high low ppi balance (#54) Nov 1, 2018
test Outline code area groupings (#79) Jan 30, 2019
visualizer Feature/base components (#82) Feb 20, 2019
.gitignore Add tests (#7) Sep 17, 2018
.npmrc Disable package lock (#38) Nov 20, 2018
CODE_OF_CONDUCT.md Update license (#1) Jul 19, 2018
CONTRIBUTING.md
LICENSE
README.md [653], [756] - Update naming and image for Clinic.js README (#88) Mar 12, 2019
appveyor.yml
azure-pipelines-npm-template.yml Better azure pipelines support (#61) Dec 4, 2018
azure-pipelines.yml Better azure pipelines support (#61) Dec 4, 2018
index.js Remove browserify-inline-svg (#81) Mar 19, 2019
package.json 4.0.3 Mar 29, 2019
screenshot.png [653], [756] - Update naming and image for Clinic.js README (#88) Mar 12, 2019
shared.js Filter by types, categories and properties seperately (#39) Nov 29, 2018
version.js expand version to include both 0x and tool Jul 17, 2018

README.md

Clinic.js Flame

npm version Stability Stable Azure Pipelines build status Downloads Code style

Programmable interface to Clinic.js Flame. Learn more about Clinic.js: https://clinicjs.org/

Screenshot

Supported node versions

  • Node.js 8 and above

Example

const ClinicFlame = require('@nearform/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
  })
})

Documentation

const ClinicFlame = require('@nearform/flame')
const flame = new ClinicFlame()

new ClinicFlame([settings])

  • settings <Object>
    • detectPort <boolean> Default: false
    • debug <boolean> If set to true, the generated html will not be minified. Default: false
    • dest <String> The folder where the collected data is stored. Default: '.'

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 will the SIGINT event.

flame.visualize(dataFilename, outputFilename, callback)

Will consume the datafile specified by dataFilename, this datafile will be produced by the sampler using flame.collect.

flame.visualize will then output a standalone HTML file to outputFilename. When completed the callback will be called with no extra arguments, except a possible error.

License

GPL 3.0

You can’t perform that action at this time.