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

docs: add agent option usage #173

Merged
merged 4 commits into from
Jan 12, 2023
Merged

docs: add agent option usage #173

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9b7bf9
docs: add agent option usage
yuyinws Nov 22, 2022
476ea77
docs: typo
yuyinws Nov 22, 2022
e868484
docs: modify format
nozomuikuta Jan 12, 2023
b2f0ca3
docs: add line break
nozomuikuta Jan 12, 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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,17 @@ await ofetch('/movies', {
})
```

## 💡 Adding HTTP(S) Agent

If you need use HTTP(S) Agent, can add `agent` option with `https-proxy-agent`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add a note that this is for Node.js only.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow up: #202

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add a note that this is for Node.js only.

By this you mean server side only right? This should work in nuxt /server right?

```js
nozomuikuta marked this conversation as resolved.
Show resolved Hide resolved
import { HttpsProxyAgent } from "https-proxy-agent";

await ofetch('/api', {
agent: new HttpsProxyAgent('http://example.com')
})
```

## 🍣 Access to Raw Response

If you need to access raw response (for headers, etc), can use `ofetch.raw`:
Expand Down