How can I compress binary or text data in a web browser and then decode it on a server-side in JavaScript?

How can I compress any data in client-side JavaScript before sending it to the server?

E.g.

  • Text
  • JSON
  • Binary data

What kind of compression formats can be used?

Today, web browsers support compression natively in JavaScript.

  • You can compress any data using common compression methods like Gzip
  • For images, you can export PNG out of a canvas
  • Web browsers support Streams API that with CompressionStream
  • Node.js has zlib built-in that provides some common compression methods (although its interface is very archaic and needs to be tweaked for async).
  • In web, you might need to base64 encode and decode the compressed payload because embedding it in formats like JSON does not support binary
  • A good compression format is gzip as it is universally supported

CompressionStream supports only deflate (zip) and Gzip.

An example is how to compress a string (e.g. JSON) on the client-side JavaScript.

Example compress.js:



/**
 * Compress strings and Blobs as gzip.
 * 
 * Based on https://dev.to/ternentdotdev/json-compression-in-the-browser-with-gzip-and-the-compression-streams-api-4135
 * 
 * @param {string | Blob} data Plain-text data as a string or Blob for binary data
 * 
 * @param {boolean} base64 Set true to output base64 encoded (can be embedded in JSON, query parameters, etc.), otherwise return JavaScript blob
 * 
 * @returns {Promise<string | Blob>} Compressed binary or
 */
export async function compressStringGzip(data, base64) {
    
    // Convert incoming string to a stream
    let stream;
    if(typeof data == "string") {
        stream = new Blob([data], {
            type: 'text/plain',
        }).stream();    
    } else {
        // Assume blog
        stream = data.stream();            
    }

    // gzip stream
    const compressedReadableStream = stream.pipeThrough(
        new CompressionStream("gzip")
    );
    
     // create Response
    const compressedResponse = await new Response(compressedReadableStream);

    // Get response Blob
    const blob = await compressedResponse.blob();

    if(base64) {
        // Get the ArrayBuffer
        const buffer = await blob.arrayBuffer();
        
        // convert ArrayBuffer to base64 encoded string
        const compressedBase64 = btoa(
          String.fromCharCode(
            ...new Uint8Array(buffer)
          )
        );        

        return compressedBase64;

    } else {
        return blob;
    }
}

Example decompress.js:

import * as zlib from "zlib";
import * as util from "util";

/**
 * Decompress a string or a Buffer as gzip.
 * 
 * Assume the encoded data compresses as UTF-8 text.
 * 
 * Only for server-side Node.js.
 * 
 * @param {*} data Data to decompress, either Buffer or a string
 * 
 * @param {*} plainText Set true if the encoded data is utf-8 and you want to decode the stirng
 * 
 * @returns {Promise<string | Buffer>} Decompressed data as a Buffer object or a string if plainText is set
 */
export async function decompressStringGzip(data, plainText) {

    const gunzip = util.promisify(zlib.gunzip);

    // Assume base64 encoded if we are given data as a string
    if(typeof data == "string") {
        data = Buffer.from(data, 'base64');
    }

    const raw = await gunzip(data);

    if(plainText) {
        return raw.toString("utf-8");
    }
    
    return raw;
}


Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật