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-12 19:24:17 -04:00
parent 7b0835fcf1
commit b0b454de85
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -28,21 +28,27 @@ This module aims to expose the same API as `node-fetch` does for the most common
Load the module. Load the module.
### async fetch(resource [, init]) ### await 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).
Returns a **CachedResponse**. Returns a **CachedResponse**.
### async CachedResponse.text() ### await 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 errors. You might want to use this function in certain cases like receiving a 5xx response status, so that you can retry requests.
### await CachedResponse.text()
Returns the body as a string, same as [node-fetch](https://www.npmjs.com/package/node-fetch). Returns the body as a string, same as [node-fetch](https://www.npmjs.com/package/node-fetch).
### async CachedResponse.json() ### await CachedResponse.json()
Returns the body as a JavaScript object, parsed from JSON, same as [node-fetch](https://www.npmjs.com/package/node-fetch). Returns the body as a JavaScript object, parsed from JSON, same as [node-fetch](https://www.npmjs.com/package/node-fetch).
### async CachedResponse.buffer() ### await CachedResponse.buffer()
Returns the body as a Buffer, same as [node-fetch](https://www.npmjs.com/package/node-fetch). Returns the body as a Buffer, same as [node-fetch](https://www.npmjs.com/package/node-fetch).
@ -66,12 +72,6 @@ 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).
@ -114,7 +114,7 @@ This is the default cache delegate. It caches responses in-process in a POJO.
Usage: Usage:
```js ```js
const fetchBuilder, { MemoryCache } = require('node-fetch-cache'); const { fetchBuilder, MemoryCache } = require('node-fetch-cache');
const fetch = fetchBuilder.withCache(new MemoryCache(options)); const fetch = fetchBuilder.withCache(new MemoryCache(options));
``` ```
@ -135,7 +135,7 @@ Cache to a directory on disk. This allows the cache to survive the process exiti
Usage: Usage:
```js ```js
const fetchBuilder, { FileSystemCache } = require('node-fetch-cache'); const { fetchBuilder, FileSystemCache } = require('node-fetch-cache');
const fetch = fetchBuilder.withCache(new FileSystemCache(options)); const fetch = fetchBuilder.withCache(new FileSystemCache(options));
``` ```