express-json-compress

Module gzip's json data and sends decompressed content length by headers

npm install --save express-json-compressor

or

yarn install express-json-compressor

Import module

1const jsonCompress = require("express-json-compress");

or

1import * as jsonCompress from "express-json-compress";

Why ?

This compressor creates response header x-decompressed-content-length, which helps to calculate ajax download progress in client side. Check example below.

Important

Disable or filter out other compressors for json data.

Example

Server side

1const express = require("express");
2const app = express();
3const jsonCompress = require("express-json-compress");
4
5app.use(jsonCompress); // add json compress middleware
6
7app.get("/api", function(req, res) {
8    var jsonObject = { foo: "bar" };
9    var jsonString = JSON.stringify(jsonObject);
10    // send compressed json data with header
11    res.compressJson(jsonString);
12});
13
14app.listen(3000, function() {
15    console.log("Example app listening on port 3000!");
16});

Client side

1var req = new XMLHttpRequest();
2req.onprogress = updateProgress;
3req.open("GET", "/api", true);
4
5req.onprogress = function(event) {
6    var contentLength;
7    if (e.lengthComputable) {
8        contentLength = e.total;
9    } else {
10        contentLength = e.target.getResponseHeader(
11            "x-decompressed-content-length"
12        );
13    }
14    if (!contentLength) return;
15    var progress = (e.loaded / contentLength) * 100.0;
16    //use progress in percentage
17    //...
18};
19
20req.onreadystatechange = function(event) {
21    //....
22};
23
24req.send();

Author

Edvinas pranka

@epranka

https://www.kodmina.lt

License

The MIT License (MIT)

Copyright (c) 2019 Edvinas Pranka

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.