node-fetch/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2015-01-26 01:02:34 -08:00
node-fetch
==========
[![npm version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
2015-01-26 09:46:32 -08:00
A light-weight module that brings `window.fetch` to node.js
2015-01-26 01:02:34 -08:00
# Motivation
2015-01-26 09:46:32 -08:00
I really like the notion of Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch): it bridges the API gap between client-side and server-side http requests, so developers have less to worry about.
2015-01-26 01:02:34 -08:00
2015-01-27 05:11:26 -08:00
But I think the term [isomorphic](http://isomorphic.net/) is generally misleading: it gives developers a false sense of security that their javascript code will run happily on both controlled server environment as well as uncontrollable user browsers. When the latter is only true for a subset of modern browsers, not to mention quirks in native implementation.
2015-01-26 01:02:34 -08:00
2015-01-26 09:46:32 -08:00
Instead of implementing `XMLHttpRequest` in node to run browser-specific [fetch polyfill](https://github.com/github/fetch), why not go from node's `http` to `fetch` API directly? Node has native stream support, browserify build targets (browsers) don't, so underneath they are going to be vastly different anyway.
2015-01-26 05:28:23 -08:00
2015-01-27 05:11:26 -08:00
Hence `node-fetch`, minimal code for a `window.fetch` compatible API on node.js runtime.
2015-01-26 01:02:34 -08:00
# Features
2015-01-26 05:28:23 -08:00
- Stay consistent with `window.fetch` API.
- Make conscious trade-off when following [whatwg fetch spec](https://fetch.spec.whatwg.org/) and [stream spec](https://streams.spec.whatwg.org/) implementation details, document known difference.
- Use native promise, but allow substituting it with [insert your favorite promise library].
2015-01-27 05:11:26 -08:00
# Difference from client-side fetch
2015-01-26 05:28:23 -08:00
2015-01-27 05:11:26 -08:00
- See [Known limits](https://github.com/bitinn/node-fetch/blob/master/LIMITS.md) for details.
- If you happen to use a missing feature that `window.fetch` offers, feel free to open an issue.
- Pull requests are welcomed too!
2015-01-26 01:02:34 -08:00
# Install
`npm install node-fetch --save`
# Usage
TODO
2015-01-26 05:28:23 -08:00
# License
2015-01-26 01:02:34 -08:00
2015-01-26 05:28:23 -08:00
MIT
2015-01-26 01:02:34 -08:00
2015-01-26 05:28:23 -08:00
# Acknowledgement
2015-01-26 09:46:32 -08:00
Thanks to [github/fetch](https://github.com/github/fetch) for providing a solid implementation reference.
2015-01-26 01:02:34 -08:00
[npm-image]: https://img.shields.io/npm/v/node-fetch.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/node-fetch
[travis-image]: https://img.shields.io/travis/bitinn/node-fetch.svg?style=flat-square
[travis-url]: https://travis-ci.org/bitinn/node-fetch