Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BREAKING CHANGE: remove node-fetch in favor of global #580

Merged
merged 11 commits into from
May 21, 2023
Merged

BREAKING CHANGE: remove node-fetch in favor of global #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f256f7f
BREAKING CHANGE: remove `node-fetch` in favor of global
styfle May 13, 2023
f61f6cd
fix: tests should use node-fetch
styfle May 13, 2023
d9e477d
Apply suggestion to readme
styfle May 20, 2023
3bf62df
Remove `timeout` from readme
styfle May 20, 2023
ea7c2ab
Remove timeout from tests
styfle May 20, 2023
93869aa
Add test for error message
styfle May 20, 2023
7b2709e
Remove `node-fetch` from tests
styfle May 20, 2023
3cfc7c8
Remove test "passes node-fetch options to fetch only"
styfle May 21, 2023
0d0b3e9
Merge branch 'beta' into remove-node-fetch
styfle May 21, 2023
7c9d8d2
Run `npm install` to generate package-lock.json
styfle May 21, 2023
9d1b647
style: run prettier
wolfy1339 May 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ to interact with [GitHub’s REST API](https://developer.github.com/v3/) and
[GitHub’s GraphQL API](https://developer.github.com/v4/guides/forming-calls/#the-graphql-endpoint).

It uses [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) to parse
the passed options and sends the request using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
([node-fetch](https://github.com/bitinn/node-fetch) when the runtime has no native `fetch` API).
the passed options and sends the request using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). You can pass a custom `fetch` function using the `options.request.fetch` option, see below.

<!-- update table of contents by running `npx markdown-toc README.md -i` -->

Expand Down Expand Up @@ -319,7 +318,7 @@ const { data: app } = await requestWithAuth(
Function
</td>
<td>
Custom replacement for <a href="https://github.com/bitinn/node-fetch">built-in fetch method</a>. Useful for testing or request hooks.
Custom replacement for <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">fetch</a>. Useful for testing or request hooks.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -354,17 +353,6 @@ const { data: app } = await requestWithAuth(
Used for internal logging. Defaults to <a href="https://developer.mozilla.org/en-US/docs/Web/API/console"><code>console</code></a>.
</td>
</tr>
<tr>
<th align=left>
<code>options.request.timeout</code>
</th>
<td>
Number
</td>
<td>
Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). <a href="#options-request-signal">options.request.signal</a> is recommended instead.
</td>
</tr>
</table>

All other options except `options.request.*` will be passed depending on the `method` and `url` options.
Expand Down
Loading