mikeal/r2

Document support browser versions

Open

#29 opened on Sep 12, 2017

View on GitHub
 (6 comments) (4 reactions) (0 assignees)JavaScript (4,466 stars) (159 forks)batch import
enhancementshelp wanted

Description

Please document the support browser and Node versions.

At least for the browsers, I believe this to be very limited given there isn't any employment of a browser-side polyfill here if the Fetch API is not available. I think many people would be surprised by that when coming to the "spiritual successor of request". Granted, that issue could be solved by incorporating something like #27 (using isomorphic-fetch rather than just node-fetch) if desired.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the repository's codebase to determine the minimum Node.js version required (look at `engines` in package.json or any feature usage like async/await, etc.). Check if the project is intended for browser use or if it relies on Node specific modules like `'http'`. Examine issue #27 and any existing discussion about adding browser support. Document the findings in a new README section. Also consider testing the library against various Node.js versions.