Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
http-encoding
Advanced tools
Readme
Part of HTTP Toolkit: powerful tools for building, testing & debugging HTTP(S)
Everything you need to handle HTTP message body content-encoding
This package includes methods to decode & encode all commonly used HTTP content encodings, in a consistent format, usable in both Node.js and browsers.
The supported codecs are:
All encoding names are case-insensitive (although lowercase is generally standard). The 'identity', 'amz-1.0', 'none', 'text', 'binary', 'utf8' and 'utf-8' encodings are all supported as no-op encodings, passed through with no en/decoding at all. Only 'identity' is standard, but the others are all in common use regardless.
Found a codec used in real-world HTTP that isn't supported? Open an issue!
The library includes two general methods:
decodeBuffer(body, encoding)
Takes an encoded body buffer and encoding (in the format of a standard HTTP content-encoding header) and returns a promise for a decoded buffer, using the zero to many buffers specified in the header.
The input buffer can be any Uint8Array including a Node Buffer (a subclass of Uint8Array). A node-compatible buffer is always returned.
If any encoding is unrecognized or unavailable then this method will throw an exception.
A decodeBufferSync
method is also available for some use cases, but not recommended, as it's less performant and cannot support some encodings (Brotli or Zstandard).
encodeBuffer(body, encoding, { level })
Takes a raw body buffer and a single encoding (a valid HTTP content-encoding name) and returns a promise for an encoded buffer, using the zero to many buffers specified in the header.
The input buffer can be any Uint8Array (including a Node Buffer, which is a Uint8Array subclass) or an ArrayBuffer. A node-compatible buffer is always returned.
If any encoding is unrecognized or unavailable then this method will throw an exception.
This library also exports consistent async methods to compress and decompress each of the codecs directly:
gzip
gunzip
deflate
inflate
inflateRaw
brotliCompress
brotliDecompress
zstdCompress
zstdDecompress
encodeBase64
decodeBase64
Each method accepts a buffer and returns a promise for a buffer.
To use this in a browser, you'll need to use a bundler (e.g. Webpack) that can include standard Node.js polyfill packages, you may need to install those polyfill packages, and your bundler needs to support bundling WebAssembly (e.g. Webpack v4+).
In Webpack v4 this should all work automatically. In Webpack v5 this will require explicit dependencies and configuration. See this package's own test webpack config and dev dependencies for a working example.
Brotli and Zstandard are only supported in runtime environments that support WebAssembly. All WebAssembly packages are loaded on-demand and only when native methods (e.g. Node's zlib.brotli*
) are not available.
FAQs
Everything you need to handle HTTP message body content-encoding
The npm package http-encoding receives a total of 49,559 weekly downloads. As such, http-encoding popularity was classified as popular.
We found that http-encoding demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.