Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Request: Improve documentation for `openWhenHidden` property

Abierto
#36 15 comentarios 75 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
typescript

Línea de trabajo

Comienza en el README y localiza la documentación de la propiedad openWhenHidden. Añade una nota que explique que establecerla en true mantiene el streaming de SSE mientras el documento del navegador está oculto y, a continuación, verifica que la redacción refleje con precisión el comportamiento predeterminado de la propiedad.

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

Descripción

The default for openWhenHidden is false. This means that the SSE will abort on the client side if the document is hidden, however the default SSE behaviour is that the SSE will continue even if the document is hidden.

Since this is different then normal SSE, I think there should be something in the readme that says something along the lines of "To continue SSE streaming when browser is hidden, set openWhenHidden flag to true". I'm happy to do so if this is approved.

Thank you!

Lenguaje dominante
TypeScript
Estrellas
2.9k
Forks
197
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/fetch-event-source

Todos los issues de Azure/fetch-event-source

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.