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

Session replay options inconsistency across docs and exported types for JS Web SDK

Abierto
  • ¿Algo no está bien?
#509 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
58/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
typescript
Área
documentation, web-dev

Línea de trabajo

Compare the session replay documentation at /docs/sdks/web and /docs/session-replay with packages/sdks/web/src/index.ts and packages/sdks/web/src/replay/recorder.ts. First determine whether maskTextSelector is intended to be supported; done means the chosen behavior, exported type, recorder handling, and documentation consistently agree.

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

Descripción

In https://openpanel.dev/docs/sdks/web, a maskTextSelector option is mentioned. This option is neither present in https://openpanel.dev/docs/session-replay or in the declared ‎SessionReplayOptions type.

A value which seems it could come from this configuration is hard-coded in https://github.com/Openpanel-dev/openpanel/blob/6ae4a60d9035acc70923d70c34fdc6358d70cea7/packages/sdks/web/src/replay/recorder.ts#L113. The hard-coded [data-openpanel-replay-mask] matches the default described in https://openpanel.dev/docs/sdks/web.

This creates a documentation inconsistency, and I'm unsure whether I should rely on the documented default as a workaround, or if this is not intended to be a feature at all.

Given a direction, I'm happy to open a PR to either remove the mention from the docs or to fix the config and wire it to the point where it should be consumed.

Lenguaje dominante
TypeScript
Estrellas
7.1k
Forks
510
Merge medio
5 d 13 h
PR fusionados (30 d)
6

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 Openpanel-dev/openpanel

Todos los issues de Openpanel-dev/openpanel

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.