Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc(replay): Add jsdoc to extracted functions
  • Loading branch information
mydea committed Dec 9, 2022
commit 3791c69a43af19d08c348bdd0973e7ff4c7b8406
3 changes: 3 additions & 0 deletions packages/replay/src/coreHandlers/handleFetch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down
3 changes: 3 additions & 0 deletions packages/replay/src/coreHandlers/handleGlobalEvent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions packages/replay/src/coreHandlers/handleHistory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down
3 changes: 3 additions & 0 deletions packages/replay/src/coreHandlers/handleXhr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down
3 changes: 3 additions & 0 deletions packages/replay/src/coreHandlers/performanceObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down