{"_id":"speedline-core","_rev":"4-94653d093aa4b4b4dcf68aaff5182426","name":"speedline-core","dist-tags":{"latest":"1.4.3"},"versions":{"1.4.0":{"name":"speedline-core","version":"1.4.0","description":"Get the speed index from chrome dev tool timeline files","license":"MIT","repository":{"type":"git","url":"git+https://github.com/paulirish/speedline.git"},"main":"lib","engines":{"node":">=5.0"},"scripts":{"lint":"xo","unit":"ava","test":"yarn run lint && yarn run unit"},"types":"speedline.d.ts","keywords":["chrome","devtools","timeline","speed","index","performance"],"dependencies":{"@types/node":"*","image-ssim":"^0.2.0","jpeg-js":"^0.1.2"},"devDependencies":{"ava":"^0.19.1","xo":"^0.14.0"},"bugs":{"url":"https://github.com/paulirish/speedline/issues"},"homepage":"https://github.com/paulirish/speedline#readme","_id":"speedline-core@1.4.0","_npmVersion":"6.3.0","_nodeVersion":"10.4.1","_npmUser":{"name":"paulirish","email":"paul.irish@gmail.com"},"dist":{"integrity":"sha512-GEUB8IZCV8fXF2ZIekwg0HkI/3HnALfysw3nPsVMBPoZHwD8eT53pIzCZ6qBR7gU3VFadjmKAWT9w0Cvqp2MXQ==","shasum":"884831eaef66ddc928dd7d4c9e844c5d28bad7db","tarball":"https://registry.npmjs.org/speedline-core/-/speedline-core-1.4.0.tgz","fileCount":8,"unpackedSize":7654068,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbafVjCRA9TVsSAnZWagAADcAQAJ7Y/dcPlpeq5A6p4Wyc\nOYX8H+vsv2Qif99aKLlHuw4Ugd6c15tWcnaQL/b5hvlP4hVx/8fYepcCOgZ7\nzKeBTqPDO0uzcd8zuv53D/UtbXr5zLSpH5LR7J+/GaX2gSbGpyIBEu2n1vmq\nJZCrKHs5KOzg6AEIzT74mli/O4X4vyXzz7q4H2MSF8xmrPVhFIKjpAQxfOq2\nZExlBoDvcCAXvto8q1oEirVu7iLMDMnk1fAK3l9i9tKSlaUJKRhAw0p+NF1j\naY5ea727V5G+oyz4PBKy4/4a/lcwr0H43HuqtLZKURbq7G4xswM58kL6FTpj\nCZcjJXWQdClNmGVTs9mzskj9Wc+IYfY0LvmD1Uhzyjw9XePAZZ9hPJj1EI/K\nlglvZ6CUW6wW4xbFJuk893AZYkq1GnFivYV2x4p1LxUImeCdd0LcQNe0Rn3o\nx+9m+4+jhXvfuk1IfnmaQ0dt24b7UWsaaVqKbP0zNfdCH5MDC3b+90CBd/5h\nSkAqYU6HA9TjZkgsXbKjMRz2HxZsh9eoedW7LQvvh/rvy0oOP+Qb9YRh1i1s\nY/YZOoYElscj/N1tMXgDbSEBEvuAVNBuLmfnl5BrtNqTIwLkeevnAciXFY//\nz090lyhh6Wa23hK3K5uizM9K5eoKqgXCPvSeFQdaKlY3YrDVS1SaGUmbViZl\n70Hz\r\n=TqXo\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIC23LEdZjxmfulWXoFJBZPXIjavpBHVfFGrr/O4qB5FJAiBHBfWHc7hkTqr0SV5B7IRtp2etpukR9KqduIWlp3Sx1w=="}]},"maintainers":[{"name":"paulirish","email":"paul.irish@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedline-core_1.4.0_1533670755316_0.12319963676755119"},"_hasShrinkwrap":false},"1.4.2":{"name":"speedline-core","version":"1.4.2","description":"Get the speed index from chrome dev tool timeline files","license":"MIT","repository":{"type":"git","url":"git+https://github.com/paulirish/speedline.git"},"main":"lib","engines":{"node":">=5.0"},"scripts":{"lint":"xo","unit":"ava","test":"yarn run lint && yarn run unit"},"types":"speedline.d.ts","keywords":["chrome","devtools","timeline","speed","index","performance"],"dependencies":{"@types/node":"*","image-ssim":"^0.2.0","jpeg-js":"^0.1.2"},"devDependencies":{"ava":"^0.19.1","xo":"^0.14.0"},"bugs":{"url":"https://github.com/paulirish/speedline/issues"},"homepage":"https://github.com/paulirish/speedline#readme","_id":"speedline-core@1.4.2","_npmVersion":"6.1.0","_nodeVersion":"8.11.1","_npmUser":{"name":"paulirish","email":"paul.irish@gmail.com"},"dist":{"integrity":"sha512-9/5CApkKKl6bS6jJ2D0DQllwz/1xq3cyJCR6DLgAQnkj5djCuq8NbflEdD2TI01p8qzS9qaKjzxM9cHT11ezmg==","shasum":"bb061444a218d67b4cd52f63a262386197b90c8a","tarball":"https://registry.npmjs.org/speedline-core/-/speedline-core-1.4.2.tgz","fileCount":7,"unpackedSize":142556,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbow3UCRA9TVsSAnZWagAAUJsP/AljsBV2mY0hoonWS+JB\nOYhpbERp5HaCu/u81KkoBcl0eXd6yBBswb6MrEIYRGHMnlj44rpeZ/nZSyAP\nrHiwCvfgAjguSHyi9CYnHUE9Xxw3rNQhq5ohKJCRsQHNJoMJB0CtrIKmywep\nJCYngeRwng9+xtMzprhEmjjRmMmkQByz1JL2eHSifdrgREBXRb3aXBmn0YEV\nXD+T6/q/UNqj+paO7lNUKMz4alccnK+Db8iX2s7DnJNQgxGEGy+GjvjvW7g8\nXvh1/gL0d3+cyiZJralcAh09H6424lBD8WMgG2E635Cewo73li34RKxasGy0\n8Q1qtGsdagbH8FbaGwKknElT3LRRY8+gOAV7FppVRicPO5S3IvsAQbgUPE8X\nyIIADCkYNlLeXOrhjqb1gQqWELl4je4R0gdNUe1nWdthrgZaa2mAD5LiEMit\n6NBS3D9EBdEgcLDShbnwSa0+ZxleMsnOwYVxns8vGjyZB214kJ2KIQ3LSbZ1\nmTc1x8EjdPlfN+7OweyIxplhiIp8XHPcqEeBpr4+4kuHttGXL9AKvieCxuzc\nVi+q4e1kI9ywgiuRA4lmqBNelfhXIyTPflrsmKhuuECJpXO7vzGNFZkTBFbs\n1Gbuz2JGsx+wALIrbT/vRBW3ESrGrAf2FombI1Z77Q9m4jOP7wVgHme+QREu\npiXX\r\n=nFi1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGR0Tm8Lfk1pmz2TVnn664cpVlC0Qu28sjruYlD4VY08AiEA2YF5Kans49nEWBIM/Olf+hKL5p5Zp9lYDjlbsVgsXnU="}]},"maintainers":[{"name":"paulirish","email":"paul.irish@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedline-core_1.4.2_1537412563706_0.7714217737410105"},"_hasShrinkwrap":false},"1.4.3":{"name":"speedline-core","version":"1.4.3","description":"Get the speed index from chrome dev tool timeline files","license":"MIT","repository":{"type":"git","url":"git+https://github.com/paulirish/speedline.git"},"main":"lib","engines":{"node":">=8.0"},"scripts":{"lint":"xo","unit":"ava","test":"yarn run lint && yarn run unit"},"types":"speedline.d.ts","keywords":["chrome","devtools","timeline","speed","index","performance"],"dependencies":{"@types/node":"*","image-ssim":"^0.2.0","jpeg-js":"^0.4.1"},"devDependencies":{"ava":"^0.19.1","xo":"^0.14.0"},"bugs":{"url":"https://github.com/paulirish/speedline/issues"},"homepage":"https://github.com/paulirish/speedline#readme","_id":"speedline-core@1.4.3","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"patrickhulce","email":"patrick.hulce@gmail.com"},"dist":{"integrity":"sha512-DI7/OuAUD+GMpR6dmu8lliO2Wg5zfeh+/xsdyJZCzd8o5JgFUjCeLsBDuZjIQJdwXS3J0L/uZYrELKYqx+PXog==","shasum":"4d6e7276e2063c2d36a375cb25a523ac73475319","tarball":"https://registry.npmjs.org/speedline-core/-/speedline-core-1.4.3.tgz","fileCount":7,"unpackedSize":142665,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIFRQCRA9TVsSAnZWagAAkgkP/R8I23VASYlY6P0Afa6z\nGa/c9lLijrNQ4YuQrkJifqZGcE1PAd8PnnLwAud+rLvxEq6s2rHOypVeG1ld\nSbRmHaU/rgz8GHcDAv5kEVMzJLWcUJr0EzStRnZhhGhi9YACnWZ5BhEa+6Lf\nInUxetXmDveFJ3PtUpwPiutCUhT/VXXq39WFQsoQ+7Cs+EOPvqe4ZIgG6WyC\nQYmP1JV8v5VFTeLLuyRDEWwHzzWa7RlsNpO6ghTHb/t6VdXHmEGrGufUv0to\nNuWG5YCmGy37k8XsYnd2/cPKxnWEK9ZGDBRQ8osT9x/h1/OfuukUwftDR3f4\nEa+XArbD5GWzITt8j22OS94AIdHRsKb8J1vp5LrtdwDKpyXpR+auI0C0wQvK\nLU0ShuVuVBO+m2CxhoZ7dfw3Va20J86zZpLGhezb+1N/eXWLIp6LcNkMfotK\nRKgHJiwfcl0WuPowpig334OGbYMaOWkD/D9NFGa8bF0ks01IbKk+YOpkqBpE\nexMY0TLG5J1xBLj+eSnlBdOc9UBhflAS6KS0+gL1/EDcOG0vnOGs8wp+6svW\nM/xn3uew/1pwtypRhV2HBByt7S1XtMLbbkffM73Qlf1Fewmvf8c+LZHPKej9\nVmw3YWB249rF/hE32wBSiunZkiQilRZGWRVNXUjJI6f4h9aFZm2JYHxlE+2W\nM0dA\r\n=8FHy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBlBQOI7fdIjbXLEJpgtfv3jG9IH2qpYqXyvgz3qDYIyAiAyvM+yHoLZWnn1sJX2A2CA+ngQXWC/5cApwb8+Kh3d8Q=="}]},"maintainers":[{"name":"paulirish","email":"paul.irish@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedline-core_1.4.3_1595954255764_0.3529385489030701"},"_hasShrinkwrap":false}},"time":{"created":"2018-08-07T19:39:15.316Z","1.4.0":"2018-08-07T19:39:15.985Z","modified":"2022-05-18T10:33:11.049Z","1.4.2":"2018-09-20T03:02:43.962Z","1.4.3":"2020-07-28T16:37:35.873Z"},"maintainers":[{"email":"npm@paul.irish","name":"paulirish"},{"email":"patrick.hulce@gmail.com","name":"patrickhulce"}],"description":"Get the speed index from chrome dev tool timeline files","homepage":"https://github.com/paulirish/speedline#readme","keywords":["chrome","devtools","timeline","speed","index","performance"],"repository":{"type":"git","url":"git+https://github.com/paulirish/speedline.git"},"bugs":{"url":"https://github.com/paulirish/speedline/issues"},"license":"MIT","readme":"# speedline-core\n\nThis is the core module for speedline, without any CLI dependencies. See [speedline](https://github.com/paulirish/speedline) for the CLI.\n\n### Install\n\n```bash\n$ npm install speedline\n```\n\n### Usage\n\n```js\nconst speedline = require('speedline-core');\n\nspeedline('./timeline').then(results => {\n  console.log('Speed Index value:', results.speedIndex);\n});\n```\n\n### API\n\n#### `speedline(timeline [, opts])`\n\n* (string | object[]) `timeline`\n* (object) `opts`\n\nReturns a (Promise) resolving with an object containing:\n  * `beginning` (number) - Recording start timestamp\n  * `end` (number) - Recording end timestamp\n  * `speedIndex` (number) - speed index value.\n  * `perceptualSpeedIndex` (number) - perceptual speed index value.\n  * `first` (number) - duration before the first visual change in ms.\n  * `complete` (number) - duration before the last visual change in ms.\n  * `duration` (number) - timeline recording duration in ms.\n  * `frames` ([Frame](#frame)[]) - array of all the frames extracted from the timeline.\n\n**`timeline` parameter**:\n* `string` - the parameter represents the location of the of file containing the timeline.\n* `array` - the parameter represents the traceEvents content of the timeline file.\n\n**`opts` parameter**:\n* `timeOrigin`: Provides the baseline timeStamp, typically navigationStart. Must be a monotonic clock timestamp that matches the trace.  E.g. `speedline('trace.json', {timeOrigin: 103205446186})`\n* `fastMode`: If the elapsed time and difference in similarity between two screenshots are small, fastMode will skip decoding and evaluating the frames between them.\n* `include`: Specifies which speed indexes to compute, can be one of `all|speedIndex|perceptualSpeedIndex`, defaults to `all`.\n\n#### `Frame`\n\nObject representing a single screenshot.\n\n* `frame.getHistogram()`: (number[][]) - returns the frame histogram. Note that light pixels informations are removed from the histogram, for better speed index calculation accuracy.\n* `frame.getTimeStamp()`: (number) - return the frame timestamp.\n* `frame.getImage()`: (Buffer) - return the frame content.\n* `frame.getProgress()`: (number) - return the frame visual progress.\n* `frame.getPerceptualProgress()`: (number) - return the frame perceptual visual progress.\n\n\n## License\n\nMIT © [Pierre-Marie Dartus](https://github.com/pmdartus)\n","readmeFilename":"readme.md"}