developit / developit/redaxios

Improve documentation regarding response.headers

Abierto
#73 0 comentarios 3 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
4.9k
Forks
104
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.