sync-fetch

Synchronous wrapper around the Fetch API. Uses node-fetch. For a package using version of fetch built into Node.js, see sync-fetch-undici.

Install

npm install sync-fetch

In the browser, a browserify bundle can be loaded from CDNs like unpkg.com.

<script src="https://unpkg.com/sync-fetch"></script>
<script src="https://unpkg.com/sync-fetch@VERSION"></script>

Use

const fetch = require('sync-fetch')

const metadata = fetch('https://doi.org/10.7717/peerj-cs.214', {
  headers: {
    Accept: 'application/vnd.citationstyles.csl+json'
  }
}).json()
// arrayBuffer(), blob(), buffer(), json(), and text() supported

Limitations

Node.js

• Does not support Stream or Blob as input body since they cannot be read or serialized synchronously
• Does not support FormData as input body yet as it can contain a Blob
• Does not support signal as it cannot be implemented synchronously
• Does not support the non-spec agent option as its value cannot be serialized
• Does not support non-standard textConverted() method on SyncResponse and SyncRequest

Browser

• Does not support most options, since XMLHttpRequest is pretty limited. Supported are:
  • method
  • body
  • headers
  • credentials (but not omit)
  • (Non-spec) timeout
• The non-standard buffer() and textConverted() methods are not supported
• CORS limitations apply, of course (note they may be stricter for synchronous requests)