Package description
The etag npm package is used to generate HTTP ETags, which are typically used for cache validation. It can generate ETags based on the contents of a file or a buffer, a string, or based on a specified entity and its attributes.
Generating ETags from a file
This code sample demonstrates how to generate an ETag for the contents of a file. It reads the file 'example.txt' and uses the etag function to create an ETag based on the file's contents.
const etag = require('etag');
const fs = require('fs');
fs.readFile('example.txt', function(err, data) {
if (err) throw err;
const eTagValue = etag(data);
console.log(eTagValue);
});Generating ETags from a string
This code sample shows how to generate an ETag from a string. The etag function is called with a string 'Hello, World!' to produce an ETag for that specific string.
const etag = require('etag');
const entity = 'Hello, World!';
const eTagValue = etag(entity);
console.log(eTagValue);Generating ETags with options
This example illustrates how to generate a weak ETag by passing an options object to the etag function. The options object specifies that the ETag should be weak, which is indicated by a 'W/' prefix in the ETag value.
const etag = require('etag');
const entity = Buffer.from('Hello, World!');
const options = { weak: true };
const eTagValue = etag(entity, options);
console.log(eTagValue);The 'fresh' package is used to check if the HTTP response is still 'fresh' on the client side. It is similar to etag in that it deals with HTTP caching mechanisms, but it focuses on cache validation rather than ETag generation.
The 'cacheable-response' package is a higher-level abstraction for creating cacheable responses in Node.js servers. It uses ETags among other headers to manage caching. It provides a more comprehensive solution compared to etag, which is focused solely on ETag generation.
Readme
Create simple HTTP ETags
This module generates HTTP ETags (as defined in RFC 7232) for use in HTTP responses.
This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:
$ npm install etag
var etag = require('etag')
Generate a strong ETag for the given entity. This should be the complete
body of the entity. Strings, Buffers, and fs.Stats are accepted. By
default, a strong ETag is generated except for fs.Stats, which will
generate a weak ETag (this can be overwritten by options.weak).
res.setHeader('ETag', etag(body))
etag accepts these properties in the options object.
Specifies if the generated ETag will include the weak validator mark (that
is, the leading W/). The actual entity tag is the same. The default value
is false, unless the entity is fs.Stats, in which case it is true.
$ npm test
$ npm run-script bench
> etag@1.8.0 bench nodejs-etag
> node benchmark/index.js
http_parser@2.7.0
node@6.9.1
v8@5.1.281.84
uv@1.9.1
zlib@1.2.8
ares@1.10.1-DEV
icu@57.1
modules@48
openssl@1.0.2j
> node benchmark/body0-100b.js
100B body
4 tests completed.
* buffer - strong x 498,600 ops/sec ±0.82% (191 runs sampled)
* buffer - weak x 496,249 ops/sec ±0.59% (179 runs sampled)
string - strong x 466,298 ops/sec ±0.88% (186 runs sampled)
string - weak x 464,298 ops/sec ±0.84% (184 runs sampled)
> node benchmark/body1-1kb.js
1KB body
4 tests completed.
* buffer - strong x 346,535 ops/sec ±0.32% (189 runs sampled)
* buffer - weak x 344,958 ops/sec ±0.52% (185 runs sampled)
string - strong x 259,672 ops/sec ±0.82% (191 runs sampled)
string - weak x 260,931 ops/sec ±0.76% (190 runs sampled)
> node benchmark/body2-5kb.js
5KB body
4 tests completed.
* buffer - strong x 136,510 ops/sec ±0.62% (189 runs sampled)
* buffer - weak x 136,604 ops/sec ±0.51% (191 runs sampled)
string - strong x 80,903 ops/sec ±0.84% (192 runs sampled)
string - weak x 82,785 ops/sec ±0.50% (193 runs sampled)
> node benchmark/body3-10kb.js
10KB body
4 tests completed.
* buffer - strong x 78,650 ops/sec ±0.31% (193 runs sampled)
* buffer - weak x 78,685 ops/sec ±0.41% (193 runs sampled)
string - strong x 43,999 ops/sec ±0.43% (193 runs sampled)
string - weak x 44,081 ops/sec ±0.45% (192 runs sampled)
> node benchmark/body4-100kb.js
100KB body
4 tests completed.
buffer - strong x 8,860 ops/sec ±0.66% (191 runs sampled)
* buffer - weak x 9,030 ops/sec ±0.26% (193 runs sampled)
string - strong x 4,838 ops/sec ±0.16% (194 runs sampled)
string - weak x 4,800 ops/sec ±0.52% (192 runs sampled)
> node benchmark/stats.js
stat
4 tests completed.
* real - strong x 1,468,073 ops/sec ±0.32% (191 runs sampled)
* real - weak x 1,446,852 ops/sec ±0.64% (190 runs sampled)
fake - strong x 635,707 ops/sec ±0.33% (194 runs sampled)
fake - weak x 627,708 ops/sec ±0.36% (192 runs sampled)
FAQs
Create simple HTTP ETags
The npm package etag receives a total of 19,817,340 weekly downloads. As such, etag popularity was classified as popular.
We found that etag demonstrated a not healthy version release cadence and project activity because the last version was released 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
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.