Skip to content

Commit 29ac32a

Browse files
Update README with anchor links and formatting
1 parent a3b5f1b commit 29ac32a

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ npm install node-wreq
1212

1313
## Contents
1414

15-
**[Quick Start](#quick-start)**\
16-
🌐 **[Fetch](#fetch)**\
17-
🧩 **[Client](#client)** — shared defaults, reusable config.\
18-
🎭 **[Browser Profiles](#browser-profiles)**\
19-
🪝 **[Hooks](#hooks)** — request lifecycle, dynamic auth, retries, etc.\
20-
🍪 **[Cookies and Sessions](#cookie-jar)**\
21-
🔁 **[Redirects and Retries](#redirects-and-retries)**\
22-
📊 **[Observability](#observability)**\
23-
🚨 **[Error Handling](#errors)**\
24-
🔌 **[WebSockets](#websockets)**\
25-
🧪 **[Networking / Transport Knobs](#networking--transport-knobs)** — TLS, HTTP/1, HTTP/2 options; header ordering.
15+
#### ⚡   **[Quick Start](#quick-start)**
16+
#### 🌐   **[Fetch](#fetch)**
17+
#### 🧩   **[Client](#client)** — shared defaults, reusable config.
18+
#### 🎭   **[Browser Profiles](#browser-profiles)**
19+
#### 🪝   **[Hooks](#hooks)** — request lifecycle, dynamic auth, retries, etc.
20+
#### 🍪   **[Cookies and Sessions](#cookies)**
21+
#### 🔁   **[Redirects and Retries](#redirects-and-retries)**
22+
#### 📊   **[Observability](#observability)**
23+
#### 🚨   **[Error Handling](#errors)**
24+
#### 🔌   **[WebSockets](#websockets)**
25+
#### 🧪   **[Networking / Transport Knobs](#networking)** — TLS, HTTP/1, HTTP/2 options; header ordering.
2626

27-
## Quick Start
27+
## <a id="quick-start"></a>Quick Start [](#contents)
2828

2929
```ts
3030
import { fetch } from 'node-wreq';
@@ -59,7 +59,7 @@ console.log(response.status);
5959
console.log(await response.json());
6060
```
6161

62-
## Fetch
62+
## <a id="fetch"></a>Fetch [](#contents)
6363

6464
### Simple GET
6565

@@ -148,7 +148,7 @@ const readable = response.wreq.readable();
148148
readable.pipe(process.stdout);
149149
```
150150

151-
## Client
151+
## <a id="client"></a>Client [](#contents)
152152

153153
Use `createClient(...)` when requests share defaults:
154154

@@ -214,7 +214,7 @@ await base.get('/health');
214214
await admin.get('/admin/stats');
215215
```
216216

217-
## Browser Profiles
217+
## <a id="browser-profiles"></a>Browser Profiles [](#contents)
218218

219219
Inspect the available profiles at runtime:
220220

@@ -235,7 +235,7 @@ Typical profiles include browser families like:
235235
- Opera
236236
- OkHttp
237237

238-
## Hooks
238+
## <a id="hooks"></a>Hooks [](#contents)
239239

240240
Hooks are the request pipeline.
241241

@@ -347,7 +347,7 @@ Rule of thumb:
347347
- use hooks for dynamic behavior
348348
- use client defaults for static behavior
349349

350-
## Cookie Jar
350+
## <a id="cookies"></a>Cookies and Sessions [](#contents)
351351

352352
`node-wreq` does not force a built-in cookie store.
353353

@@ -437,7 +437,7 @@ console.log(response.wreq.setCookies);
437437
console.log(response.wreq.cookies);
438438
```
439439

440-
## Redirects and Retries
440+
## <a id="redirects-and-retries"></a>Redirects and Retries [](#contents)
441441

442442
Both are opt-in controls on top of the normal request pipeline.
443443

@@ -552,7 +552,7 @@ Current timings are wrapper-level timings that are still useful in practice:
552552
- response available
553553
- total time when body consumption is known
554554

555-
## Errors
555+
## <a id="errors"></a>Errors [](#contents)
556556

557557
Main error classes:
558558

@@ -583,7 +583,7 @@ try {
583583
}
584584
```
585585

586-
## WebSockets
586+
## <a id="websockets"></a>WebSockets [](#contents)
587587

588588
You can use either:
589589

@@ -646,7 +646,7 @@ Notes:
646646
- cookies from `cookieJar` are sent during handshake
647647
- duplicate subprotocols are rejected
648648

649-
## Networking / Transport Knobs
649+
## <a id="networkins"></a>Networking / Transport Knobs [](#contents)
650650

651651
This is the "transport nerd" section.
652652

0 commit comments

Comments
 (0)