From b0b454de8552217f04d6ad1cda11a0b058f9a15d Mon Sep 17 00:00:00 2001 From: Randall Schmidt Date: Sat, 12 Jun 2021 19:24:17 -0400 Subject: [PATCH] update README --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 429ff1a..a9d9108 100644 --- a/README.md +++ b/README.md @@ -28,21 +28,27 @@ This module aims to expose the same API as `node-fetch` does for the most common Load the module. -### async fetch(resource [, init]) +### await fetch(resource [, init]) Same arguments as [node-fetch](https://www.npmjs.com/package/node-fetch). 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). -### 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). -### async CachedResponse.buffer() +### await CachedResponse.buffer() 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). -### 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() 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: ```js -const fetchBuilder, { MemoryCache } = require('node-fetch-cache'); +const { fetchBuilder, MemoryCache } = require('node-fetch-cache'); 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: ```js -const fetchBuilder, { FileSystemCache } = require('node-fetch-cache'); +const { fetchBuilder, FileSystemCache } = require('node-fetch-cache'); const fetch = fetchBuilder.withCache(new FileSystemCache(options)); ```