Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
#509 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
58/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
7.1k
Fork
510
Merge medio
5g 13h
PR unite (30g)
6

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Openpanel-dev/openpanel

Tutte le issue di Openpanel-dev/openpanel

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.