etag

Create simple HTTP ETags

This module generates HTTP ETags (as defined in RFC 7232) for use in HTTP responses.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

1$ npm install etag

API

1var etag = require('etag')

etag(entity, [options])

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).

1res.setHeader('ETag', etag(body))

Options

etag accepts these properties in the options object.

weak

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.

Testing

1$ npm test

Benchmark

1$ npm run-script bench
2
3> etag@1.8.1 bench nodejs-etag
4> node benchmark/index.js
5
6  http_parser@2.7.0
7  node@6.11.1
8  v8@5.1.281.103
9  uv@1.11.0
10  zlib@1.2.11
11  ares@1.10.1-DEV
12  icu@58.2
13  modules@48
14  openssl@1.0.2k
15
16> node benchmark/body0-100b.js
17
18  100B body
19
20  4 tests completed.
21
22  buffer - strong x 258,647 ops/sec ±1.07% (180 runs sampled)
23  buffer - weak   x 263,812 ops/sec ±0.61% (184 runs sampled)
24  string - strong x 259,955 ops/sec ±1.19% (185 runs sampled)
25  string - weak   x 264,356 ops/sec ±1.09% (184 runs sampled)
26
27> node benchmark/body1-1kb.js
28
29  1KB body
30
31  4 tests completed.
32
33  buffer - strong x 189,018 ops/sec ±1.12% (182 runs sampled)
34  buffer - weak   x 190,586 ops/sec ±0.81% (186 runs sampled)
35  string - strong x 144,272 ops/sec ±0.96% (188 runs sampled)
36  string - weak   x 145,380 ops/sec ±1.43% (187 runs sampled)
37
38> node benchmark/body2-5kb.js
39
40  5KB body
41
42  4 tests completed.
43
44  buffer - strong x 92,435 ops/sec ±0.42% (188 runs sampled)
45  buffer - weak   x 92,373 ops/sec ±0.58% (189 runs sampled)
46  string - strong x 48,850 ops/sec ±0.56% (186 runs sampled)
47  string - weak   x 49,380 ops/sec ±0.56% (190 runs sampled)
48
49> node benchmark/body3-10kb.js
50
51  10KB body
52
53  4 tests completed.
54
55  buffer - strong x 55,989 ops/sec ±0.93% (188 runs sampled)
56  buffer - weak   x 56,148 ops/sec ±0.55% (190 runs sampled)
57  string - strong x 27,345 ops/sec ±0.43% (188 runs sampled)
58  string - weak   x 27,496 ops/sec ±0.45% (190 runs sampled)
59
60> node benchmark/body4-100kb.js
61
62  100KB body
63
64  4 tests completed.
65
66  buffer - strong x 7,083 ops/sec ±0.22% (190 runs sampled)
67  buffer - weak   x 7,115 ops/sec ±0.26% (191 runs sampled)
68  string - strong x 3,068 ops/sec ±0.34% (190 runs sampled)
69  string - weak   x 3,096 ops/sec ±0.35% (190 runs sampled)
70
71> node benchmark/stats.js
72
73  stat
74
75  4 tests completed.
76
77  real - strong x 871,642 ops/sec ±0.34% (189 runs sampled)
78  real - weak   x 867,613 ops/sec ±0.39% (190 runs sampled)
79  fake - strong x 401,051 ops/sec ±0.40% (189 runs sampled)
80  fake - weak   x 400,100 ops/sec ±0.47% (188 runs sampled)

License

MIT