Fascinated/node-fetch-cache
Archived
1
0
Fork 0
Code Issues Pull Requests 1 Actions Activity

update readme

Browse Source
This commit is contained in:
Randall Schmidt 2021-06-10 12:24:43 -04:00
parent 28348f511f
commit c46d08d76a
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -20,6 +20,10 @@ fetch('http://google.com')
This module aims to expose the same API as `node-fetch` does for the most common use cases, but may not support some of the less common use cases. This module aims to expose the same API as `node-fetch` does for the most common use cases, but may not support some of the less common use cases.
### const fetch = require('node-fetch-cache')('./path/to/cache/dir')
Load the module and specify the directory to cache respones in.
### async fetch(resource [, init]) ### async fetch(resource [, init])
Same arguments as [node-fetch](https://www.npmjs.com/package/node-fetch). Same arguments as [node-fetch](https://www.npmjs.com/package/node-fetch).
@ -58,6 +62,12 @@ Returns true if the request was redirected, false otherwise, same as [node-fetch
Returns a **ResponseHeaders** object representing the headers of the response, same as [node-fetch](https://www.npmjs.com/package/node-fetch). Returns a **ResponseHeaders** object representing the headers of the response, same as [node-fetch](https://www.npmjs.com/package/node-fetch).
### async CachedResponse.ejectFromCache()
Eject the response from the cache, so that the next request will perform a true HTTP request rather than returning a cached response.
Keep in mind that this module caches **all** responses, even if they return error status codes. You might want to use this function when `!response.ok`, so that you can retry requests.
### ResponseHeaders.entries() ### ResponseHeaders.entries()
Returns the raw headers as an array of `[key, value]` pairs, same as [node-fetch](https://www.npmjs.com/package/node-fetch). Returns the raw headers as an array of `[key, value]` pairs, same as [node-fetch](https://www.npmjs.com/package/node-fetch).