developit / developit/redaxios

Improve documentation regarding response.headers

Offen
#73 0 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
4.9k
Forks
104
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The Redaxios documentation refers us to the Axios documentation but that's not correct for some features. In the case of `response.headers` if we were to follow the Axios documentation to retrieve say `Content-Disposition` it would look like this:

```js
response.headers['Content-Disposition']
```

However, redaxios has forwarded the fetch api response interface that is like so:

```js
response.headers.get('Content-Disposition')
```

It would be nice to have better documentation that points out the differences between Axios and Redaxios and further highlights that redaxios is definitely not a drop-in replacement for axios.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the Redaxios documentation and compare its Axios references with the Fetch-style response.headers API described in the issue. Document that Content-Disposition is retrieved with response.headers.get('Content-Disposition'), explain the relevant Axios differences, and make clear that Redaxios is not a drop-in Axios replacement.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.