doc(replay): Add jsdoc to extracted functions

Author: mydea

packages/replay/src/coreHandlers/handleFetch.ts

@@ -45,6 +45,9 @@ export function handleFetch(handlerData: FetchHandlerData): null | ReplayPerform
   };
 }
 
+/**
+ * Returns a listener to be added to `addInstrumentationHandler('fetch', listener)`.
+ */
 export function handleFetchSpanListener(replay: ReplayContainer): (handlerData: FetchHandlerData) => void {
   return (handlerData: FetchHandlerData) => {
     if (!replay.isEnabled()) {

packages/replay/src/coreHandlers/handleGlobalEvent.ts

@@ -4,6 +4,9 @@ import { REPLAY_EVENT_NAME, UNABLE_TO_SEND_REPLAY } from '../constants';
 import { ReplayContainer } from '../replay';
 import { addInternalBreadcrumb } from '../util/addInternalBreadcrumb';
 
+/**
+ * Returns a listener to be added to `addGlobalEventProcessor(listener)`.
+ */
 export function handleGlobalEventListener(replay: ReplayContainer): (event: Event) => Event {
   return (event: Event) => {
     // Do not apply replayId to the root event

packages/replay/src/coreHandlers/handleHistory.ts

@@ -23,6 +23,9 @@ function handleHistory(handlerData: HistoryHandlerData): ReplayPerformanceEntry
   };
 }
 
+/**
+ * Returns a listener to be added to `addInstrumentationHandler('history', listener)`.
+ */
 export function handleHistorySpanListener(replay: ReplayContainer): (handlerData: HistoryHandlerData) => void {
   return (handlerData: HistoryHandlerData) => {
     if (!replay.isEnabled()) {

packages/replay/src/coreHandlers/handleXhr.ts

@@ -64,6 +64,9 @@ function handleXhr(handlerData: XhrHandlerData): ReplayPerformanceEntry | null {
   };
 }
 
+/**
+ * Returns a listener to be added to `addInstrumentationHandler('xhr', listener)`.
+ */
 export function handleXhrSpanListener(replay: ReplayContainer): (handlerData: XhrHandlerData) => void {
   return (handlerData: XhrHandlerData) => {
     if (!replay.isEnabled()) {

packages/replay/src/coreHandlers/performanceObserver.ts

@@ -2,6 +2,9 @@ import { ReplayContainer } from '../replay';
 import { AllPerformanceEntry } from '../types';
 import { dedupePerformanceEntries } from '../util/dedupePerformanceEntries';
 
+/**
+ * Sets up a PerformanceObserver to listen to all performance entry types.
+ */
 export function setupPerformanceObserver(replay: ReplayContainer): PerformanceObserver {
   const performanceObserverHandler = (list: PerformanceObserverEntryList): void => {
     // For whatever reason the observer was returning duplicate navigation