npmpackage.info

Gathering detailed insights and metrics for fresh

Other packages similar to fresh

@types/fresh

0.5.2

TypeScript definitions for fresh

es-fresh

0.0.11

fresh rewrite in TypeScript with ESM targets

jsdoc-fresh

3.0.0

Fresh JSDoc 3 Template

taze

0.18.0

A modern cli tool that keeps your deps fresh

Gathering detailed insights and metrics for fresh

fresh

HTTP request freshness testing

0.5.2

161

MIT

JavaScript

507.00 B

6,561,293,053 4.4

Installations

npm install fresh

Pull Requests

Open

2

Total

25

Closed

12

Merged

11

Issues

Open

1

Total

16

Closed

15

Releases

Unable to fetch releases

Developer

jshttp

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>= 0.6

Typescript Support

No

Node Version

6.11.1

NPM Version

3.10.10 Statistics

161 Stars

217 Commits

29 Forks

14 Watching

3 Branches

37 Contributors

Updated on 17 Sept 2024

Bundle Size

835.00 B

Minified

507.00 B

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

6,561,293,053

Last day

-5.8%

5,907,807

Compared to previous day

Last week

2.2%

34,546,615

Compared to previous week

Last month

8.2%

143,040,486

Compared to previous month

Last year

5.8%

1,488,362,665

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

mocha eslint istanbul benchmark beautify-benchmark eslint-plugin-node eslint-plugin-import eslint-plugin-promise eslint-config-standard eslint-plugin-markdown eslint-plugin-standard

Versions

fresh

HTTP response freshness testing

Installation

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

$ npm install fresh

API

1var fresh = require('fresh')

fresh(reqHeaders, resHeaders)

Check freshness of the response using request and response headers.

When the response is still "fresh" in the client's cache true is returned, otherwise false is returned to indicate that the client cache is now stale and the full response should be sent.

When a client sends the Cache-Control: no-cache request header to indicate an end-to-end reload request, this module will return false to make handling these requests transparent.

Known Issues

This module is designed to only follow the HTTP specifications, not to work-around all kinda of client bugs (especially since this module typically does not receive enough information to understand what the client actually is).

There is a known issue that in certain versions of Safari, Safari will incorrectly make a request that allows this module to validate freshness of the resource even when Safari does not have a representation of the resource in the cache. The module jumanji can be used in an Express application to work-around this issue and also provides links to further reading on this Safari bug.

Example

API usage

1var reqHeaders = { 'if-none-match': '"foo"' }
2var resHeaders = { etag: '"bar"' }
3fresh(reqHeaders, resHeaders)
4// => false
5
6var reqHeaders = { 'if-none-match': '"foo"' }
7var resHeaders = { etag: '"foo"' }
8fresh(reqHeaders, resHeaders)
9// => true

Using with Node.js http server

1var fresh = require('fresh')
2var http = require('http')
3
4var server = http.createServer(function (req, res) {
5  // perform server logic
6  // ... including adding ETag / Last-Modified response headers
7
8  if (isFresh(req, res)) {
9    // client has a fresh copy of resource
10    res.statusCode = 304
11    res.end()
12    return
13  }
14
15  // send the resource
16  res.statusCode = 200
17  res.end('hello, world!')
18})
19
20function isFresh (req, res) {
21  return fresh(req.headers, {
22    etag: res.getHeader('ETag'),
23    'last-modified': res.getHeader('Last-Modified')
24  })
25}
26
27server.listen(3000)

License

MIT

Stable Version

The latest stable version of the package.

Stable Version

0.5.2

HIGH

7.5/10

Summary

Regular Expression Denial of Service in fresh

Affected Versions

< 0.5.2

Patched Versions

0.5.2

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

4

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.4

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More