README
snapline
Unleash your screenshots stored in Chrome Devtool timeline files
Features
- Convert timeline to gif
- Extract screenshots save in a timeline into a folder
Install
Before using snapline, please install imageMagick
and ensure that your version of node is greater than 4.0
.
npm install -g snapline
CLI usage
> snapline -h
Usage: snapline <timeline> [options]
Options:
--help Show help [boolean]
-o, --output Output file name [string] [default: "timeline.gif"]
-f, --fps Number of frames per seconds [number] [default: "10"]
Node usage
const snapline = require('../src')
const timeline = require('./my-awesome-timeline.json')
snapline.toGif(timeline)
.then(gifPath => console.log(`The gif(t) is ready: ${gifPath}!`))
API
snapline.toGif(timeline[, options])
timeline
<timelineEntry[]> - The parsed JSON content of the timeline fileoptions.output
- path of the gif. default: ./timeline.gif
options.fps
- Number of frames per seconds. default: 10
Returns a Promise
that resolves with the path of the created gif
snaplie.toImages(timeline[, options])
timeline
<timelineEntry[]> - The parsed JSON content of the timeline fileoptions.output
- folder path that will contains the screenshots. default: ./screenshots
options.fps
- Number of frames per seconds. default: 10
Returns a Promise
that resolves with the path of the path of the created directory
License
MIT. See /LICENSE
Owner
Pierre-Marie Dartus - @pmdartus