# usertiming-compression > UserTiming compression and decompression Latest version **0.1.9** (published 2019-09-17) · MIT license · 0 weekly downloads ## Install ```sh npm install usertiming-compression pnpm add usertiming-compression yarn add usertiming-compression bun add usertiming-compression ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.9 | | Published | 2019-09-17 | | First published | 2015-12-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 84.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 38 | | Author | Nic Jansma | | Maintainers | nicjansma | ## Links - npm: https://www.npmjs.com/package/usertiming-compression - Repository: https://github.com/nicjansma/usertiming-compression.js - Homepage: https://github.com/nicjansma/usertiming-compression.js#readme - Issues: http://github.com/nicjansma/usertiming-compression.js/issues - npm.io page: https://npm.io/package/usertiming-compression ## Recent versions - 0.1.9 (latest) — 2019-09-17 - 0.1.8 — 2018-11-21 - 0.1.7 — 2018-11-21 - 0.1.6 — 2018-11-21 - 0.1.5 — 2017-10-02 - 0.1.4 — 2016-09-16 - 0.1.3 — 2016-08-10 - 0.1.2 — 2016-04-04 - 0.1.1 — 2016-04-04 - 0.1.0 — 2015-12-11 ## README # usertiming-compression.js v0.1.9 [http://nicj.net](http://nicj.net) Licensed under the MIT license ## Introduction `usertiming-compression.js` compresses data from [UserTiming](http://www.w3.org/TR/user-timing/). A companion script, `usertiming-decompression.js`, converts the compressed data back to the original form. [UserTiming](http://www.w3.org/TR/user-timing/) is a [modern browser](http://caniuse.com/#feat=user-timing) performance API that gives developers the ability the mark important events (timestamps) and measure durations (timestamp deltas) in their web apps. The [PerformanceTimeline](http://www.w3.org/TR/performance-timeline/) has several methods such as `performance.getEntriesByType('mark')` or `performance.getEntriesByType('measure')` that return each mark or measure's `startTime` (timestamp) and `duration` (for measures). `usertiming-compression.js` applies several data-compression techniques to reduce the size of your serialized UserTiming data to 10-15% of it's original size in many cases. See [this blog post](http://nicj.net/compressing-usertiming/) for a description of these techniques. `usertiming-decompression.js` is a companion script that will take the compressed UserTiming data and build it back to its original UserTiming form (eg. `performance.getEntriesByType('mark')`) for analysis. ## Download Releases are available for download from [GitHub](https://github.com/nicjansma/usertiming-compression.js). ### Web - Compression __Development:__ ([UMD](https://github.com/umdjs/umd)) [usertiming-compression.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-compression.js) - 20kb __Development:__ (`window.UserTimingCompression`) [usertiming-compression.vanilla.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-compression.vanilla.js) - 20kb __Production:__ ([UMD](https://github.com/umdjs/umd)) [usertiming-compression.min.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-compression.min.js) - 4.0kb minified, 1.6kb gzipped __Production:__ (`window.UserTimingCompression`) [usertiming-compression.vanilla.min.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-compression.vanilla.min.js) - 3.8kb minified, 1.6kb gzipped ### Web - Decompression __Development:__ ([UMD](https://github.com/umdjs/umd)) [usertiming-decompression.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-decompression.js) - 16kb __Development:__ (`window.UserTimingCompression`) [usertiming-decompression.vanilla.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-decompression.vanilla.js) - 15kb __Production:__ ([UMD](https://github.com/umdjs/umd)) [usertiming-decompression.min.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-decompression.min.js) - 3.7kb minified, 1.5kb gzipped __Production:__ (`window.UserTimingCompression`) [usertiming-decompression.vanilla.min.js](https://github.com/nicjansma/usertiming-compression.js/raw/master/dist/usertiming-decompression.vanilla.min.js) - 3.5kb minified, 1.5kb gzipped ### NPM usertiming-compression.js is also available as the [npm usertiming-compression module](https://npmjs.org/package/usertiming-compression). You can install using Node Package Manager (npm): npm install usertiming-compression ### Bower usertiming-compression.js is also available via [bower](http://bower.io/). You can install using: bower install usertiming-compression ### CLI Compression and decompression can be done on the command line via: node cmd.js ``` $ node cmd.js --help Usage: cmd [options] [command] Commands: decompress decompress file compress compress file Options: -h, --help output usage information -V, --version output the version number -o, --output Output file -p, --pretty Pretty JSON -v, --verbose Verbose debugging ``` ## Usage Please see the [W3C UserTiming API Reference](http://www.w3.org/TR/user-timing/) for details on how to use the UserTiming API. ### usertiming-compression.js To include usertiming-compression.js, include it via a script tag: ```html ``` Once included in the page, a top-level `UserTimingCompression` object is available on `window`. If AMD or CommonJS environments are detected, you can use the UMD version: ```html ``` From the NPM module: ```js var UserTimingCompression = require("usertiming-compression").UserTimingCompression; ``` To get a map of compressed UserTiming names to values, you can call: ```js var utMap = UserTimingCompression.getCompressedUserTiming(options); // { // "mark1": "2s", // "mark2": "5k", // "mark3": "8c" // } ``` If you have a [map](http://nicj.net/compressing-usertiming/) of mark / measure names you want to use, pass them in as `options.map`: ```js var utMap = UserTimingCompression.getCompressedUserTiming({ map: { "mark1": 0, "mark2": 1, "mark3": 2 } }); // { // "0": "2s", // "1": "5k", // "2": "8c" // } ``` If you want to further compress this list for a format suitable for URL transmission (e.g. on a query string), you can use `compressForUri()`: ```js var utData = UserTimingCompression.compressForUri(utMap); // ~(m~(ark~(1~'2s~2~'5k~3~'8c))) ``` ### API #### `UserTimingCompression.getCompressedUserTiming(options)` Gathers all UserTiming marks and measures from the root HTML page and all accessible IFRAMEs. **Arguments**: * `options` (optional) * `options.map`: A map of names to indexes to use for compression. * `options.from`: The minimum `startTime` * `options.to`: The maximum `startTime` * `options.window`: window object that will be queried for UserTiming data **Returns**: A map of names to compressed values. ```js { "mark1": "2s", "mark2": "5k", "mark3": "8c" } ``` #### `UserTimingCompression.compressForUri(map)` Takes the output of `getCompressedUserTiming()` and converts it into a string suitable for URI encoding. **Arguments**: * `map` A map of names to string values **Returns**: A map of names to compressed values. ``` "~(m~(ark~(1~'2s~2~'5k~3~'8c)))" ``` **Note**: The first character of the string denotes what type of [compression](http://nicj.net/compressing-usertiming/) is used: 1. `~` is optimized Trie (JSURL) compression 2. `0` is a tilde array 3. `1` is a mapped array ### usertiming-decompression.js To include usertiming-decompression.js, include it via a script tag: ```html ``` Once included in the page, a top-level `UserTimingDecompression` object is available on `window`. If AMD or CommonJS environments are detected, you can use the UMD version: ```html ``` From the NPM module: ```js var UserTimingDecompression = require("usertiming-compression").UserTimingDecompression; ``` To decompress your resources, you can call: ```js var original = UserTimingDecompression.decompressUserTiming(utData); ``` ### API #### `UserTimingDecompression.decompressUserTiming(data)` Decompresses data from a URI-encoded form. **Arguments**: * `data` Data compressed via `compressForUri()` **Returns**: The original UserTiming data ```js [ {"duration":0,"entryType":"mark","name":"mark1","startTime":100}, {"duration":0,"entryType":"mark","name":"mark1","startTime":150}, {"duration":0,"entryType":"mark","name":"mark1","startTime":500} ] ``` ## Tests Tests are provided in the ``test/`` directory, and can be run via ``mocha``: mocha test/* Or via ``gulp``: gulp test ## Version History * v0.1.0 - 2015-12-10: Initial version * v0.1.1 - 2016-04-04: `getCompressedUserTiming()` gathers Measures that end after the specified `from` * v0.1.2 - 2016-04-04: Protect against X-O frame access that crashes some browsers * v0.1.3 - 2016-07-25: `getCompressedUserTiming()` accepts an alternate window param passed into options * v0.1.4 - 2016-08-10: Round `duration` values on Measures to nearest millisecond * v0.1.5 - 2017-10-01: Fixed NPM entry point * v0.1.6 - 2018-11-21: Changed build process to produce UMD (for Node/require) and "Vanilla" (for Browser) files in `dist/` * v0.1.7 - 2018-11-21: Ensure `dist/` is published in bower * v0.1.8 - 2018-11-21: Also include `*.vanilla.js` in NPM * v0.1.9 - 2019-09-17: Fix: Compression on Trie nodes that are prefixes of another ## Thanks Parts of [JSURL](https://github.com/Sage/jsurl) were incorporated into this library. This project builds upon the work of [ResourceTiming Compression](https://github.com/nicjansma/resourcetiming-compression.js), with guidance from [Philip Tellis](http://bluesmoon.info/) and others at [SOASTA](http://www.soasta.com). --- _Source: https://npm.io/package/usertiming-compression · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._