From 3e621a861121b7b52b9708264621c263af241fd9 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Mon, 26 May 2025 14:51:54 +0200 Subject: [PATCH 01/21] api --- .../rum/browser-logs.datadoglogs.md | 11 + .../rum/browser-logs.handlertype.md | 15 + .../rum/browser-logs.logger._constructor_.md | 111 + .../rum/browser-logs.logger.alert.md | 81 + .../rum/browser-logs.logger.clearcontext.md | 15 + .../rum/browser-logs.logger.critical.md | 81 + .../rum/browser-logs.logger.debug.md | 81 + .../rum/browser-logs.logger.emerg.md | 81 + .../rum/browser-logs.logger.error.md | 81 + .../rum/browser-logs.logger.getcontext.md | 15 + .../rum/browser-logs.logger.gethandler.md | 15 + .../rum/browser-logs.logger.getlevel.md | 15 + .../rum/browser-logs.logger.info.md | 81 + .../rum/browser-logs.logger.log.md | 97 + .../browser-logs.logger.logimplementation.md | 113 + docs/api-reference/rum/browser-logs.logger.md | 107 + .../rum/browser-logs.logger.notice.md | 81 + .../rum/browser-logs.logger.ok.md | 81 + ...owser-logs.logger.removecontextproperty.md | 49 + .../rum/browser-logs.logger.setcontext.md | 49 + .../browser-logs.logger.setcontextproperty.md | 63 + .../rum/browser-logs.logger.sethandler.md | 49 + .../rum/browser-logs.logger.setlevel.md | 49 + .../rum/browser-logs.logger.warn.md | 81 + ...rowser-logs.loggerconfiguration.context.md | 11 + ...rowser-logs.loggerconfiguration.handler.md | 11 + .../browser-logs.loggerconfiguration.level.md | 11 + .../rum/browser-logs.loggerconfiguration.md | 93 + .../browser-logs.logsevent.application_id.md | 13 + .../rum/browser-logs.logsevent.date.md | 13 + .../rum/browser-logs.logsevent.error.md | 25 + .../rum/browser-logs.logsevent.http.md | 18 + .../rum/browser-logs.logsevent.logger.md | 16 + .../rum/browser-logs.logsevent.md | 264 ++ .../rum/browser-logs.logsevent.message.md | 13 + .../rum/browser-logs.logsevent.origin.md | 13 + .../rum/browser-logs.logsevent.service.md | 13 + .../rum/browser-logs.logsevent.session.md | 16 + .../rum/browser-logs.logsevent.session_id.md | 13 + .../rum/browser-logs.logsevent.status.md | 13 + .../rum/browser-logs.logsevent.view.md | 18 + .../browser-logs.logseventdomaincontext.md | 11 + .../browser-logs.logsglobal.clearaccount.md | 13 + ...wser-logs.logsglobal.clearglobalcontext.md | 15 + .../rum/browser-logs.logsglobal.clearuser.md | 15 + .../browser-logs.logsglobal.createlogger.md | 15 + .../rum/browser-logs.logsglobal.getaccount.md | 13 + ...rowser-logs.logsglobal.getglobalcontext.md | 15 + ...er-logs.logsglobal.getinitconfiguration.md | 13 + ...wser-logs.logsglobal.getinternalcontext.md | 15 + .../rum/browser-logs.logsglobal.getlogger.md | 15 + .../rum/browser-logs.logsglobal.getuser.md | 15 + .../rum/browser-logs.logsglobal.init.md | 13 + .../rum/browser-logs.logsglobal.logger.md | 11 + .../rum/browser-logs.logsglobal.md | 491 +++ ...r-logs.logsglobal.removeaccountproperty.md | 13 + ....logsglobal.removeglobalcontextproperty.md | 15 + ...wser-logs.logsglobal.removeuserproperty.md | 15 + .../rum/browser-logs.logsglobal.setaccount.md | 13 + ...wser-logs.logsglobal.setaccountproperty.md | 13 + ...rowser-logs.logsglobal.setglobalcontext.md | 13 + ...ogs.logsglobal.setglobalcontextproperty.md | 13 + ...wser-logs.logsglobal.settrackingconsent.md | 13 + .../rum/browser-logs.logsglobal.setuser.md | 55 + .../rum/browser-logs.logsglobal.setuser_1.md | 56 + ...browser-logs.logsglobal.setuserproperty.md | 13 + ...r-logs.logsinitconfiguration.beforesend.md | 13 + ...ogsinitconfiguration.forwardconsolelogs.md | 13 + ...gsinitconfiguration.forwarderrorstologs.md | 13 + ...gs.logsinitconfiguration.forwardreports.md | 13 + .../rum/browser-logs.logsinitconfiguration.md | 132 + ...logs.logsinitconfiguration.usepciintake.md | 13 + .../rum/browser-logs.logsmessage.context.md | 11 + .../rum/browser-logs.logsmessage.md | 89 + .../rum/browser-logs.logsmessage.message.md | 11 + .../rum/browser-logs.logsmessage.status.md | 11 + docs/api-reference/rum/browser-logs.md | 182 + .../rum/browser-logs.statustype.md | 21 + .../rum/browser-rum-react.addreacterror.md | 63 + ...r-rum-react.errorboundary._constructor_.md | 47 + ...m-react.errorboundary.componentdidcatch.md | 63 + ....errorboundary.getderivedstatefromerror.md | 49 + .../rum/browser-rum-react.errorboundary.md | 146 + .../browser-rum-react.errorboundary.render.md | 15 + ...wser-rum-react.errorboundary.reseterror.md | 11 + docs/api-reference/rum/browser-rum-react.md | 86 + .../rum/browser-rum-react.reactplugin.md | 63 + ...um-react.unstable_reactcomponenttracker.md | 14 + .../rum/browser-rum-slim.datadogrum.md | 11 + docs/api-reference/rum/browser-rum-slim.md | 29 + .../rum/browser-rum.datadogrum.md | 11 + docs/api-reference/rum/browser-rum.md | 29 + docs/api-reference/rum/index.md | 56 + etc/browser-logs.api.json | 3521 +++++++++++++++++ etc/browser-rum-react.api.json | 625 +++ etc/browser-rum-slim.api.json | 202 + etc/browser-rum.api.json | 202 + package.json | 10 +- packages/logs/api-extractor.json | 35 + packages/rum-react/api-extractor.json | 35 + packages/rum-slim/api-extractor.json | 35 + packages/rum/api-extractor.json | 35 + yarn.lock | 415 +- 103 files changed, 9297 insertions(+), 11 deletions(-) create mode 100644 docs/api-reference/rum/browser-logs.datadoglogs.md create mode 100644 docs/api-reference/rum/browser-logs.handlertype.md create mode 100644 docs/api-reference/rum/browser-logs.logger._constructor_.md create mode 100644 docs/api-reference/rum/browser-logs.logger.alert.md create mode 100644 docs/api-reference/rum/browser-logs.logger.clearcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logger.critical.md create mode 100644 docs/api-reference/rum/browser-logs.logger.debug.md create mode 100644 docs/api-reference/rum/browser-logs.logger.emerg.md create mode 100644 docs/api-reference/rum/browser-logs.logger.error.md create mode 100644 docs/api-reference/rum/browser-logs.logger.getcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logger.gethandler.md create mode 100644 docs/api-reference/rum/browser-logs.logger.getlevel.md create mode 100644 docs/api-reference/rum/browser-logs.logger.info.md create mode 100644 docs/api-reference/rum/browser-logs.logger.log.md create mode 100644 docs/api-reference/rum/browser-logs.logger.logimplementation.md create mode 100644 docs/api-reference/rum/browser-logs.logger.md create mode 100644 docs/api-reference/rum/browser-logs.logger.notice.md create mode 100644 docs/api-reference/rum/browser-logs.logger.ok.md create mode 100644 docs/api-reference/rum/browser-logs.logger.removecontextproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logger.setcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logger.setcontextproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logger.sethandler.md create mode 100644 docs/api-reference/rum/browser-logs.logger.setlevel.md create mode 100644 docs/api-reference/rum/browser-logs.logger.warn.md create mode 100644 docs/api-reference/rum/browser-logs.loggerconfiguration.context.md create mode 100644 docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md create mode 100644 docs/api-reference/rum/browser-logs.loggerconfiguration.level.md create mode 100644 docs/api-reference/rum/browser-logs.loggerconfiguration.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.application_id.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.date.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.error.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.http.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.logger.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.message.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.origin.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.service.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.session.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.session_id.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.status.md create mode 100644 docs/api-reference/rum/browser-logs.logsevent.view.md create mode 100644 docs/api-reference/rum/browser-logs.logseventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.clearuser.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.createlogger.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getaccount.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getlogger.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.getuser.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.init.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.logger.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setaccount.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setuser.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md create mode 100644 docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.md create mode 100644 docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md create mode 100644 docs/api-reference/rum/browser-logs.logsmessage.context.md create mode 100644 docs/api-reference/rum/browser-logs.logsmessage.md create mode 100644 docs/api-reference/rum/browser-logs.logsmessage.message.md create mode 100644 docs/api-reference/rum/browser-logs.logsmessage.status.md create mode 100644 docs/api-reference/rum/browser-logs.md create mode 100644 docs/api-reference/rum/browser-logs.statustype.md create mode 100644 docs/api-reference/rum/browser-rum-react.addreacterror.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary.render.md create mode 100644 docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md create mode 100644 docs/api-reference/rum/browser-rum-react.md create mode 100644 docs/api-reference/rum/browser-rum-react.reactplugin.md create mode 100644 docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md create mode 100644 docs/api-reference/rum/browser-rum-slim.datadogrum.md create mode 100644 docs/api-reference/rum/browser-rum-slim.md create mode 100644 docs/api-reference/rum/browser-rum.datadogrum.md create mode 100644 docs/api-reference/rum/browser-rum.md create mode 100644 docs/api-reference/rum/index.md create mode 100644 etc/browser-logs.api.json create mode 100644 etc/browser-rum-react.api.json create mode 100644 etc/browser-rum-slim.api.json create mode 100644 etc/browser-rum.api.json create mode 100644 packages/logs/api-extractor.json create mode 100644 packages/rum-react/api-extractor.json create mode 100644 packages/rum-slim/api-extractor.json create mode 100644 packages/rum/api-extractor.json diff --git a/docs/api-reference/rum/browser-logs.datadoglogs.md b/docs/api-reference/rum/browser-logs.datadoglogs.md new file mode 100644 index 0000000000..d63ae48180 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.datadoglogs.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [datadogLogs](./browser-logs.datadoglogs.md) + +## datadogLogs variable + +**Signature:** + +```typescript +datadogLogs: LogsPublicApi +``` diff --git a/docs/api-reference/rum/browser-logs.handlertype.md b/docs/api-reference/rum/browser-logs.handlertype.md new file mode 100644 index 0000000000..b70f91c4f4 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.handlertype.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [HandlerType](./browser-logs.handlertype.md) + +## HandlerType variable + +**Signature:** + +```typescript +HandlerType: { + readonly console: "console"; + readonly http: "http"; + readonly silent: "silent"; +} +``` diff --git a/docs/api-reference/rum/browser-logs.logger._constructor_.md b/docs/api-reference/rum/browser-logs.logger._constructor_.md new file mode 100644 index 0000000000..6f5726d63f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger._constructor_.md @@ -0,0 +1,111 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [(constructor)](./browser-logs.logger._constructor_.md) + +## Logger.(constructor) + +Constructs a new instance of the `Logger` class + +**Signature:** + +```typescript +constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void, name?: string, handlerType?: HandlerType | HandlerType[], level?: StatusType, loggerContext?: object); +``` + +## Parameters + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +handleLogStrategy + + + + +(logsMessage: [LogsMessage](./browser-logs.logsmessage.md), logger: [Logger](./browser-logs.logger.md), handlingStack?: string) => void + + + + + +
+ +name + + + + +string + + + + +_(Optional)_ + + +
+ +handlerType + + + + +[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] + + + + +_(Optional)_ + + +
+ +level + + + + +[StatusType](./browser-logs.statustype.md) + + + + +_(Optional)_ + + +
+ +loggerContext + + + + +object + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-logs.logger.alert.md b/docs/api-reference/rum/browser-logs.logger.alert.md new file mode 100644 index 0000000000..4eafe97085 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.alert.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [alert](./browser-logs.logger.alert.md) + +## Logger.alert() method + +**Signature:** + +```typescript +alert(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.clearcontext.md b/docs/api-reference/rum/browser-logs.logger.clearcontext.md new file mode 100644 index 0000000000..1ef0e01199 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.clearcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [clearContext](./browser-logs.logger.clearcontext.md) + +## Logger.clearContext() method + +**Signature:** + +```typescript +clearContext(): void; +``` +**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.critical.md b/docs/api-reference/rum/browser-logs.logger.critical.md new file mode 100644 index 0000000000..54eb8d73af --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.critical.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [critical](./browser-logs.logger.critical.md) + +## Logger.critical() method + +**Signature:** + +```typescript +critical(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.debug.md b/docs/api-reference/rum/browser-logs.logger.debug.md new file mode 100644 index 0000000000..436c88e31b --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.debug.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [debug](./browser-logs.logger.debug.md) + +## Logger.debug() method + +**Signature:** + +```typescript +debug(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.emerg.md b/docs/api-reference/rum/browser-logs.logger.emerg.md new file mode 100644 index 0000000000..a36c11273f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.emerg.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [emerg](./browser-logs.logger.emerg.md) + +## Logger.emerg() method + +**Signature:** + +```typescript +emerg(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.error.md b/docs/api-reference/rum/browser-logs.logger.error.md new file mode 100644 index 0000000000..908171b4bd --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.error.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [error](./browser-logs.logger.error.md) + +## Logger.error() method + +**Signature:** + +```typescript +error(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.getcontext.md b/docs/api-reference/rum/browser-logs.logger.getcontext.md new file mode 100644 index 0000000000..e9091d9050 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.getcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getContext](./browser-logs.logger.getcontext.md) + +## Logger.getContext() method + +**Signature:** + +```typescript +getContext(): Context; +``` +**Returns:** + +Context + diff --git a/docs/api-reference/rum/browser-logs.logger.gethandler.md b/docs/api-reference/rum/browser-logs.logger.gethandler.md new file mode 100644 index 0000000000..bdd9e498bb --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.gethandler.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getHandler](./browser-logs.logger.gethandler.md) + +## Logger.getHandler() method + +**Signature:** + +```typescript +getHandler(): HandlerType | HandlerType[]; +``` +**Returns:** + +[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] + diff --git a/docs/api-reference/rum/browser-logs.logger.getlevel.md b/docs/api-reference/rum/browser-logs.logger.getlevel.md new file mode 100644 index 0000000000..11cec704b2 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.getlevel.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getLevel](./browser-logs.logger.getlevel.md) + +## Logger.getLevel() method + +**Signature:** + +```typescript +getLevel(): StatusType; +``` +**Returns:** + +[StatusType](./browser-logs.statustype.md) + diff --git a/docs/api-reference/rum/browser-logs.logger.info.md b/docs/api-reference/rum/browser-logs.logger.info.md new file mode 100644 index 0000000000..4266726e4c --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.info.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [info](./browser-logs.logger.info.md) + +## Logger.info() method + +**Signature:** + +```typescript +info(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.log.md b/docs/api-reference/rum/browser-logs.logger.log.md new file mode 100644 index 0000000000..502feca884 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.log.md @@ -0,0 +1,97 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [log](./browser-logs.logger.log.md) + +## Logger.log() method + +**Signature:** + +```typescript +log(message: string, messageContext?: object, status?: StatusType, error?: Error): void; +``` + +## Parameters + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +status + + + + +[StatusType](./browser-logs.statustype.md) + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.logimplementation.md b/docs/api-reference/rum/browser-logs.logger.logimplementation.md new file mode 100644 index 0000000000..394b65ed34 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.logimplementation.md @@ -0,0 +1,113 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [logImplementation](./browser-logs.logger.logimplementation.md) + +## Logger.logImplementation() method + +**Signature:** + +```typescript +logImplementation(message: string, messageContext?: object, status?: StatusType, error?: Error, handlingStack?: string): void; +``` + +## Parameters + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +status + + + + +[StatusType](./browser-logs.statustype.md) + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+ +handlingStack + + + + +string + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.md b/docs/api-reference/rum/browser-logs.logger.md new file mode 100644 index 0000000000..48935adfd3 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.md @@ -0,0 +1,107 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) + +## Logger interface + +**Signature:** + +```typescript +export interface Logger +``` + +## Methods + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[alert(message, messageContext, error)](./browser-logs.logger.alert.md) + + + + + +
+ +[critical(message, messageContext, error)](./browser-logs.logger.critical.md) + + + + + +
+ +[debug(message, messageContext, error)](./browser-logs.logger.debug.md) + + + + + +
+ +[emerg(message, messageContext, error)](./browser-logs.logger.emerg.md) + + + + + +
+ +[error(message, messageContext, error)](./browser-logs.logger.error.md) + + + + + +
+ +[info(message, messageContext, error)](./browser-logs.logger.info.md) + + + + + +
+ +[notice(message, messageContext, error)](./browser-logs.logger.notice.md) + + + + + +
+ +[ok(message, messageContext, error)](./browser-logs.logger.ok.md) + + + + + +
+ +[warn(message, messageContext, error)](./browser-logs.logger.warn.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-logs.logger.notice.md b/docs/api-reference/rum/browser-logs.logger.notice.md new file mode 100644 index 0000000000..2ed3948168 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.notice.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [notice](./browser-logs.logger.notice.md) + +## Logger.notice() method + +**Signature:** + +```typescript +notice(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.ok.md b/docs/api-reference/rum/browser-logs.logger.ok.md new file mode 100644 index 0000000000..a3fff4e0e2 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.ok.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [ok](./browser-logs.logger.ok.md) + +## Logger.ok() method + +**Signature:** + +```typescript +ok(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.removecontextproperty.md b/docs/api-reference/rum/browser-logs.logger.removecontextproperty.md new file mode 100644 index 0000000000..a77c4005c6 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.removecontextproperty.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [removeContextProperty](./browser-logs.logger.removecontextproperty.md) + +## Logger.removeContextProperty() method + +**Signature:** + +```typescript +removeContextProperty(key: string): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +key + + + + +string + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.setcontext.md b/docs/api-reference/rum/browser-logs.logger.setcontext.md new file mode 100644 index 0000000000..a180b803da --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.setcontext.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setContext](./browser-logs.logger.setcontext.md) + +## Logger.setContext() method + +**Signature:** + +```typescript +setContext(context: object): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +context + + + + +object + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.setcontextproperty.md b/docs/api-reference/rum/browser-logs.logger.setcontextproperty.md new file mode 100644 index 0000000000..d2c87ba949 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.setcontextproperty.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setContextProperty](./browser-logs.logger.setcontextproperty.md) + +## Logger.setContextProperty() method + +**Signature:** + +```typescript +setContextProperty(key: string, value: any): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +key + + + + +string + + + + + +
+ +value + + + + +any + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.sethandler.md b/docs/api-reference/rum/browser-logs.logger.sethandler.md new file mode 100644 index 0000000000..429b82f9f0 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.sethandler.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setHandler](./browser-logs.logger.sethandler.md) + +## Logger.setHandler() method + +**Signature:** + +```typescript +setHandler(handler: HandlerType | HandlerType[]): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +handler + + + + +[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.setlevel.md b/docs/api-reference/rum/browser-logs.logger.setlevel.md new file mode 100644 index 0000000000..faf313ca77 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.setlevel.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setLevel](./browser-logs.logger.setlevel.md) + +## Logger.setLevel() method + +**Signature:** + +```typescript +setLevel(level: StatusType): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +level + + + + +[StatusType](./browser-logs.statustype.md) + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logger.warn.md b/docs/api-reference/rum/browser-logs.logger.warn.md new file mode 100644 index 0000000000..899ed0c326 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logger.warn.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [warn](./browser-logs.logger.warn.md) + +## Logger.warn() method + +**Signature:** + +```typescript +warn(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.context.md b/docs/api-reference/rum/browser-logs.loggerconfiguration.context.md new file mode 100644 index 0000000000..e703f68440 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.loggerconfiguration.context.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [context](./browser-logs.loggerconfiguration.context.md) + +## LoggerConfiguration.context property + +**Signature:** + +```typescript +context?: object; +``` diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md b/docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md new file mode 100644 index 0000000000..e49f7ce6c5 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [handler](./browser-logs.loggerconfiguration.handler.md) + +## LoggerConfiguration.handler property + +**Signature:** + +```typescript +handler?: HandlerType | HandlerType[]; +``` diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.level.md b/docs/api-reference/rum/browser-logs.loggerconfiguration.level.md new file mode 100644 index 0000000000..6308843b81 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.loggerconfiguration.level.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [level](./browser-logs.loggerconfiguration.level.md) + +## LoggerConfiguration.level property + +**Signature:** + +```typescript +level?: StatusType; +``` diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.md b/docs/api-reference/rum/browser-logs.loggerconfiguration.md new file mode 100644 index 0000000000..1a28967ce5 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.loggerconfiguration.md @@ -0,0 +1,93 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) + +## LoggerConfiguration interface + +**Signature:** + +```typescript +export interface LoggerConfiguration +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[context?](./browser-logs.loggerconfiguration.context.md) + + + + + + + +object + + + + +_(Optional)_ + + +
+ +[handler?](./browser-logs.loggerconfiguration.handler.md) + + + + + + + +[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] + + + + +_(Optional)_ + + +
+ +[level?](./browser-logs.loggerconfiguration.level.md) + + + + + + + +[StatusType](./browser-logs.statustype.md) + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-logs.logsevent.application_id.md b/docs/api-reference/rum/browser-logs.logsevent.application_id.md new file mode 100644 index 0000000000..ed0ca7e273 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.application_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [application\_id](./browser-logs.logsevent.application_id.md) + +## LogsEvent.application\_id property + +UUID of the application + +**Signature:** + +```typescript +application_id?: string; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.date.md b/docs/api-reference/rum/browser-logs.logsevent.date.md new file mode 100644 index 0000000000..eb124dea7c --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [date](./browser-logs.logsevent.date.md) + +## LogsEvent.date property + +Start of the log in ms from epoch + +**Signature:** + +```typescript +date: number; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.error.md b/docs/api-reference/rum/browser-logs.logsevent.error.md new file mode 100644 index 0000000000..f6375002da --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.error.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [error](./browser-logs.logsevent.error.md) + +## LogsEvent.error property + +Error properties + +**Signature:** + +```typescript +error?: { + kind?: string; + stack?: string; + fingerprint?: string; + message?: string; + causes?: Array<{ + message: string; + source: string; + type?: string; + stack?: string; + }>; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.http.md b/docs/api-reference/rum/browser-logs.logsevent.http.md new file mode 100644 index 0000000000..1a655934b2 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.http.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [http](./browser-logs.logsevent.http.md) + +## LogsEvent.http property + +Resource properties of the error + +**Signature:** + +```typescript +http?: { + method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; + status_code: number; + url: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.logger.md b/docs/api-reference/rum/browser-logs.logsevent.logger.md new file mode 100644 index 0000000000..71865f0597 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.logger.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [logger](./browser-logs.logsevent.logger.md) + +## LogsEvent.logger property + +Logger properties + +**Signature:** + +```typescript +logger?: { + name: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.md b/docs/api-reference/rum/browser-logs.logsevent.md new file mode 100644 index 0000000000..9b084c7ded --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.md @@ -0,0 +1,264 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) + +## LogsEvent interface + +**Signature:** + +```typescript +export interface LogsEvent +``` + +## Properties + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[application\_id?](./browser-logs.logsevent.application_id.md) + + + + + + + +string + + + + +_(Optional)_ UUID of the application + + +
+ +[date](./browser-logs.logsevent.date.md) + + + + + + + +number + + + + +Start of the log in ms from epoch + + +
+ +[error?](./browser-logs.logsevent.error.md) + + + + + + + +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } + + + + +_(Optional)_ Error properties + + +
+ +[http?](./browser-logs.logsevent.http.md) + + + + + + + +{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Resource properties of the error + + +
+ +[logger?](./browser-logs.logsevent.logger.md) + + + + + + + +{ name: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Logger properties + + +
+ +[message](./browser-logs.logsevent.message.md) + + + + + + + +string + + + + +The log message + + +
+ +[origin](./browser-logs.logsevent.origin.md) + + + + + + + +'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' + + + + +Origin of the log + + +
+ +[service?](./browser-logs.logsevent.service.md) + + + + + + + +string + + + + +_(Optional)_ The service name + + +
+ +[session\_id?](./browser-logs.logsevent.session_id.md) + + + + + + + +string + + + + +_(Optional)_ UUID of the session (deprecated in favor of session.id) + + +
+ +[session?](./browser-logs.logsevent.session.md) + + + + + + + +{ id?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Session properties + + +
+ +[status](./browser-logs.logsevent.status.md) + + + + + + + +'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' + + + + +The log status + + +
+ +[view](./browser-logs.logsevent.view.md) + + + + + + + +{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } + + + + +View properties + + +
diff --git a/docs/api-reference/rum/browser-logs.logsevent.message.md b/docs/api-reference/rum/browser-logs.logsevent.message.md new file mode 100644 index 0000000000..b885d16a60 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.message.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [message](./browser-logs.logsevent.message.md) + +## LogsEvent.message property + +The log message + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.origin.md b/docs/api-reference/rum/browser-logs.logsevent.origin.md new file mode 100644 index 0000000000..774dac3ef9 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.origin.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [origin](./browser-logs.logsevent.origin.md) + +## LogsEvent.origin property + +Origin of the log + +**Signature:** + +```typescript +origin: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.service.md b/docs/api-reference/rum/browser-logs.logsevent.service.md new file mode 100644 index 0000000000..c2b4e51a6f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.service.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [service](./browser-logs.logsevent.service.md) + +## LogsEvent.service property + +The service name + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.session.md b/docs/api-reference/rum/browser-logs.logsevent.session.md new file mode 100644 index 0000000000..802a18bafe --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.session.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [session](./browser-logs.logsevent.session.md) + +## LogsEvent.session property + +Session properties + +**Signature:** + +```typescript +session?: { + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.session_id.md b/docs/api-reference/rum/browser-logs.logsevent.session_id.md new file mode 100644 index 0000000000..42d6204c28 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.session_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [session\_id](./browser-logs.logsevent.session_id.md) + +## LogsEvent.session\_id property + +UUID of the session (deprecated in favor of session.id) + +**Signature:** + +```typescript +session_id?: string; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.status.md b/docs/api-reference/rum/browser-logs.logsevent.status.md new file mode 100644 index 0000000000..30f49e0660 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.status.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [status](./browser-logs.logsevent.status.md) + +## LogsEvent.status property + +The log status + +**Signature:** + +```typescript +status: 'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'; +``` diff --git a/docs/api-reference/rum/browser-logs.logsevent.view.md b/docs/api-reference/rum/browser-logs.logsevent.view.md new file mode 100644 index 0000000000..1823fa2642 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsevent.view.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [view](./browser-logs.logsevent.view.md) + +## LogsEvent.view property + +View properties + +**Signature:** + +```typescript +view: { + referrer?: string; + url: string; + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-logs.logseventdomaincontext.md b/docs/api-reference/rum/browser-logs.logseventdomaincontext.md new file mode 100644 index 0000000000..d6ac5e49f4 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logseventdomaincontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEventDomainContext](./browser-logs.logseventdomaincontext.md) + +## LogsEventDomainContext type + +**Signature:** + +```typescript +export type LogsEventDomainContext = T extends typeof ErrorSource.NETWORK ? NetworkLogsEventDomainContext : T extends typeof ErrorSource.CONSOLE ? ConsoleLogsEventDomainContext : T extends typeof ErrorSource.LOGGER ? LoggerLogsEventDomainContext : never; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md b/docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md new file mode 100644 index 0000000000..93b14f6568 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearAccount](./browser-logs.logsglobal.clearaccount.md) + +## LogsGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md b/docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md new file mode 100644 index 0000000000..f011c75030 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearGlobalContext](./browser-logs.logsglobal.clearglobalcontext.md) + +## LogsGlobal.clearGlobalContext property + +Clear the global context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearuser.md b/docs/api-reference/rum/browser-logs.logsglobal.clearuser.md new file mode 100644 index 0000000000..ee1ef67d15 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.clearuser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearUser](./browser-logs.logsglobal.clearuser.md) + +## LogsGlobal.clearUser property + +Clear all user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.createlogger.md b/docs/api-reference/rum/browser-logs.logsglobal.createlogger.md new file mode 100644 index 0000000000..1f420e1d8b --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.createlogger.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [createLogger](./browser-logs.logsglobal.createlogger.md) + +## LogsGlobal.createLogger property + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + +**Signature:** + +```typescript +createLogger: (name: string, conf?: LoggerConfiguration) => Logger; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getaccount.md b/docs/api-reference/rum/browser-logs.logsglobal.getaccount.md new file mode 100644 index 0000000000..c35a4aba7b --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getAccount](./browser-logs.logsglobal.getaccount.md) + +## LogsGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md b/docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md new file mode 100644 index 0000000000..e4d7c4ba4c --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getGlobalContext](./browser-logs.logsglobal.getglobalcontext.md) + +## LogsGlobal.getGlobalContext property + +Get the global Context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md b/docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md new file mode 100644 index 0000000000..e1f2c4db2c --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getInitConfiguration](./browser-logs.logsglobal.getinitconfiguration.md) + +## LogsGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => LogsInitConfiguration | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md b/docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md new file mode 100644 index 0000000000..957235379e --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getInternalContext](./browser-logs.logsglobal.getinternalcontext.md) + +## LogsGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getlogger.md b/docs/api-reference/rum/browser-logs.logsglobal.getlogger.md new file mode 100644 index 0000000000..092fa0586b --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getlogger.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getLogger](./browser-logs.logsglobal.getlogger.md) + +## LogsGlobal.getLogger property + +Get a logger + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + +**Signature:** + +```typescript +getLogger: (name: string) => Logger | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getuser.md b/docs/api-reference/rum/browser-logs.logsglobal.getuser.md new file mode 100644 index 0000000000..14144d86dc --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.getuser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getUser](./browser-logs.logsglobal.getuser.md) + +## LogsGlobal.getUser property + +Get user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +getUser: () => Context; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.init.md b/docs/api-reference/rum/browser-logs.logsglobal.init.md new file mode 100644 index 0000000000..6d8a8b3a77 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.init.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [init](./browser-logs.logsglobal.init.md) + +## LogsGlobal.init property + +Init the Logs browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: LogsInitConfiguration) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.logger.md b/docs/api-reference/rum/browser-logs.logsglobal.logger.md new file mode 100644 index 0000000000..aa7d9de05d --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.logger.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [logger](./browser-logs.logsglobal.logger.md) + +## LogsGlobal.logger property + +**Signature:** + +```typescript +logger: Logger; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.md b/docs/api-reference/rum/browser-logs.logsglobal.md new file mode 100644 index 0000000000..1cd2967b47 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.md @@ -0,0 +1,491 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) + +## LogsGlobal interface + +**Signature:** + +```typescript +export interface LogsPublicApi extends PublicApi +``` +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[clearAccount](./browser-logs.logsglobal.clearaccount.md) + + + + + + + +() => void + + + + +Clear all account information + + +
+ +[clearGlobalContext](./browser-logs.logsglobal.clearglobalcontext.md) + + + + + + + +() => void + + + + +Clear the global context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + + +
+ +[clearUser](./browser-logs.logsglobal.clearuser.md) + + + + + + + +() => void + + + + +Clear all user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + + +
+ +[createLogger](./browser-logs.logsglobal.createlogger.md) + + + + + + + +(name: string, conf?: [LoggerConfiguration](./browser-logs.loggerconfiguration.md)) => [Logger](./browser-logs.logger.md) + + + + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + + +
+ +[getAccount](./browser-logs.logsglobal.getaccount.md) + + + + + + + +() => Context + + + + +Get account information + + +
+ +[getGlobalContext](./browser-logs.logsglobal.getglobalcontext.md) + + + + + + + +() => Context + + + + +Get the global Context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + + +
+ +[getInitConfiguration](./browser-logs.logsglobal.getinitconfiguration.md) + + + + + + + +() => [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) \| undefined + + + + +Get the init configuration + + +
+ +[getInternalContext](./browser-logs.logsglobal.getinternalcontext.md) + + + + + + + +(startTime?: number) => InternalContext \| undefined + + + + +\[Internal API\] Get the internal SDK context + +See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. + + +
+ +[getLogger](./browser-logs.logsglobal.getlogger.md) + + + + + + + +(name: string) => [Logger](./browser-logs.logger.md) \| undefined + + + + +Get a logger + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + + +
+ +[getUser](./browser-logs.logsglobal.getuser.md) + + + + + + + +() => Context + + + + +Get user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + + +
+ +[init](./browser-logs.logsglobal.init.md) + + + + + + + +(initConfiguration: [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md)) => void + + + + +Init the Logs browser SDK. + + +
+ +[logger](./browser-logs.logsglobal.logger.md) + + + + + + + +[Logger](./browser-logs.logger.md) + + + + + +
+ +[removeAccountProperty](./browser-logs.logsglobal.removeaccountproperty.md) + + + + + + + +(key: string) => void + + + + +Remove an account property + + +
+ +[removeGlobalContextProperty](./browser-logs.logsglobal.removeglobalcontextproperty.md) + + + + + + + +(key: any) => void + + + + +Remove a global context property + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + + +
+ +[removeUserProperty](./browser-logs.logsglobal.removeuserproperty.md) + + + + + + + +(key: any) => void + + + + +Remove a user property + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + + +
+ +[setAccount](./browser-logs.logsglobal.setaccount.md) + + + + + + + +(newAccount: Account) => void + + + + +Set account information to all events, stored in `@account` + + +
+ +[setAccountProperty](./browser-logs.logsglobal.setaccountproperty.md) + + + + + + + +(key: string, property: any) => void + + + + +Set or update the account property, stored in `@account.` + + +
+ +[setGlobalContext](./browser-logs.logsglobal.setglobalcontext.md) + + + + + + + +(context: any) => void + + + + +Set the global context information to all logs, stored in `@context` + + +
+ +[setGlobalContextProperty](./browser-logs.logsglobal.setglobalcontextproperty.md) + + + + + + + +(key: any, value: any) => void + + + + +Set or update a global context property, stored in `@context.` + + +
+ +[setTrackingConsent](./browser-logs.logsglobal.settrackingconsent.md) + + + + + + + +(trackingConsent: TrackingConsent) => void + + + + +Set the tracking consent of the current user. + + +
+ +[setUserProperty](./browser-logs.logsglobal.setuserproperty.md) + + + + + + + +(key: any, property: any) => void + + + + +Set or update the user property, stored in `@usr.` + + +
+ +## Methods + + + + +
+ +Method + + + + +Description + + +
+ +[setUser(newUser)](./browser-logs.logsglobal.setuser.md) + + + + +Set user information to all events, stored in `@usr` + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + + +
+ +[setUser(newUser)](./browser-logs.logsglobal.setuser_1.md) + + + + +Set user information to all events, stored in `@usr` + + +
diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md new file mode 100644 index 0000000000..ae3276cc27 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeAccountProperty](./browser-logs.logsglobal.removeaccountproperty.md) + +## LogsGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md new file mode 100644 index 0000000000..db1094e668 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeGlobalContextProperty](./browser-logs.logsglobal.removeglobalcontextproperty.md) + +## LogsGlobal.removeGlobalContextProperty property + +Remove a global context property + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md new file mode 100644 index 0000000000..09339e7712 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeUserProperty](./browser-logs.logsglobal.removeuserproperty.md) + +## LogsGlobal.removeUserProperty property + +Remove a user property + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setaccount.md b/docs/api-reference/rum/browser-logs.logsglobal.setaccount.md new file mode 100644 index 0000000000..ceceaaa140 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setAccount](./browser-logs.logsglobal.setaccount.md) + +## LogsGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md new file mode 100644 index 0000000000..fdf63305d8 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setAccountProperty](./browser-logs.logsglobal.setaccountproperty.md) + +## LogsGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md b/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md new file mode 100644 index 0000000000..958e929a36 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setGlobalContext](./browser-logs.logsglobal.setglobalcontext.md) + +## LogsGlobal.setGlobalContext property + +Set the global context information to all logs, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md new file mode 100644 index 0000000000..ca58b0e3a2 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setGlobalContextProperty](./browser-logs.logsglobal.setglobalcontextproperty.md) + +## LogsGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md b/docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md new file mode 100644 index 0000000000..839ef98180 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setTrackingConsent](./browser-logs.logsglobal.settrackingconsent.md) + +## LogsGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuser.md b/docs/api-reference/rum/browser-logs.logsglobal.setuser.md new file mode 100644 index 0000000000..34f100a2fe --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setuser.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUser](./browser-logs.logsglobal.setuser.md) + +## LogsGlobal.setUser() method + +Set user information to all events, stored in `@usr` + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User & { id: string; } + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md b/docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md new file mode 100644 index 0000000000..80b3cf568f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUser](./browser-logs.logsglobal.setuser_1.md) + +## LogsGlobal.setUser() method + +> Warning: This API is now obsolete. +> +> You must specified a user id +> + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md b/docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md new file mode 100644 index 0000000000..1e779fc935 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUserProperty](./browser-logs.logsglobal.setuserproperty.md) + +## LogsGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md new file mode 100644 index 0000000000..0f0298c081 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [beforeSend](./browser-logs.logsinitconfiguration.beforesend.md) + +## LogsInitConfiguration.beforeSend property + +Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + +**Signature:** + +```typescript +beforeSend?: ((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md new file mode 100644 index 0000000000..e9f42bee9f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardConsoleLogs](./browser-logs.logsinitconfiguration.forwardconsolelogs.md) + +## LogsInitConfiguration.forwardConsoleLogs property + +Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + +**Signature:** + +```typescript +forwardConsoleLogs?: ConsoleApiName[] | 'all' | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md new file mode 100644 index 0000000000..22b37a6b52 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardErrorsToLogs](./browser-logs.logsinitconfiguration.forwarderrorstologs.md) + +## LogsInitConfiguration.forwardErrorsToLogs property + +Forward console.error logs, uncaught exceptions and network errors to Datadog. true + +**Signature:** + +```typescript +forwardErrorsToLogs?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md new file mode 100644 index 0000000000..e5fb2e5641 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardReports](./browser-logs.logsinitconfiguration.forwardreports.md) + +## LogsInitConfiguration.forwardReports property + +Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + +**Signature:** + +```typescript +forwardReports?: RawReportType[] | 'all' | undefined; +``` diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.md new file mode 100644 index 0000000000..f73f951da0 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.md @@ -0,0 +1,132 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) + +## LogsInitConfiguration interface + +**Signature:** + +```typescript +export interface LogsInitConfiguration extends InitConfiguration +``` +**Extends:** InitConfiguration + +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[beforeSend?](./browser-logs.logsinitconfiguration.beforesend.md) + + + + + + + +((event: [LogsEvent](./browser-logs.logsevent.md), context: [LogsEventDomainContext](./browser-logs.logseventdomaincontext.md)) => boolean) \| undefined + + + + +_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + + +
+ +[forwardConsoleLogs?](./browser-logs.logsinitconfiguration.forwardconsolelogs.md) + + + + + + + +ConsoleApiName\[\] \| 'all' \| undefined + + + + +_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + + +
+ +[forwardErrorsToLogs?](./browser-logs.logsinitconfiguration.forwarderrorstologs.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true + + +
+ +[forwardReports?](./browser-logs.logsinitconfiguration.forwardreports.md) + + + + + + + +RawReportType\[\] \| 'all' \| undefined + + + + +_(Optional)_ Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + + +
+ +[usePciIntake?](./browser-logs.logsinitconfiguration.usepciintake.md) + + + + + + + +boolean + + + + +_(Optional)_ Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false + + +
diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md b/docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md new file mode 100644 index 0000000000..5fe28acdc2 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [usePciIntake](./browser-logs.logsinitconfiguration.usepciintake.md) + +## LogsInitConfiguration.usePciIntake property + +Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false + +**Signature:** + +```typescript +usePciIntake?: boolean; +``` diff --git a/docs/api-reference/rum/browser-logs.logsmessage.context.md b/docs/api-reference/rum/browser-logs.logsmessage.context.md new file mode 100644 index 0000000000..74e411863e --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsmessage.context.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [context](./browser-logs.logsmessage.context.md) + +## LogsMessage.context property + +**Signature:** + +```typescript +context?: Context; +``` diff --git a/docs/api-reference/rum/browser-logs.logsmessage.md b/docs/api-reference/rum/browser-logs.logsmessage.md new file mode 100644 index 0000000000..597307fc9c --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsmessage.md @@ -0,0 +1,89 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) + +## LogsMessage interface + +**Signature:** + +```typescript +export interface LogsMessage +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[context?](./browser-logs.logsmessage.context.md) + + + + + + + +Context + + + + +_(Optional)_ + + +
+ +[message](./browser-logs.logsmessage.message.md) + + + + + + + +string + + + + + +
+ +[status](./browser-logs.logsmessage.status.md) + + + + + + + +[StatusType](./browser-logs.statustype.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-logs.logsmessage.message.md b/docs/api-reference/rum/browser-logs.logsmessage.message.md new file mode 100644 index 0000000000..a9110aacc0 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsmessage.message.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [message](./browser-logs.logsmessage.message.md) + +## LogsMessage.message property + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/api-reference/rum/browser-logs.logsmessage.status.md b/docs/api-reference/rum/browser-logs.logsmessage.status.md new file mode 100644 index 0000000000..39a33dc74f --- /dev/null +++ b/docs/api-reference/rum/browser-logs.logsmessage.status.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [status](./browser-logs.logsmessage.status.md) + +## LogsMessage.status property + +**Signature:** + +```typescript +status: StatusType; +``` diff --git a/docs/api-reference/rum/browser-logs.md b/docs/api-reference/rum/browser-logs.md new file mode 100644 index 0000000000..8c4fe87ad1 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.md @@ -0,0 +1,182 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) + +## browser-logs package + +## Classes + + + +
+ +Class + + + + +Description + + +
+ +[Logger](./browser-logs.logger.md) + + + + + +
+ +## Interfaces + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[Logger](./browser-logs.logger.md) + + + + + +
+ +[LoggerConfiguration](./browser-logs.loggerconfiguration.md) + + + + + +
+ +[LogsEvent](./browser-logs.logsevent.md) + + + + + +
+ +[LogsGlobal](./browser-logs.logsglobal.md) + + + + + +
+ +[LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) + + + + + +
+ +[LogsMessage](./browser-logs.logsmessage.md) + + + + + +
+ +## Variables + + + + + +
+ +Variable + + + + +Description + + +
+ +[datadogLogs](./browser-logs.datadoglogs.md) + + + + + +
+ +[HandlerType](./browser-logs.handlertype.md) + + + + + +
+ +[StatusType](./browser-logs.statustype.md) + + + + + +
+ +## Type Aliases + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[HandlerType](./browser-logs.handlertype.md) + + + + + +
+ +[LogsEventDomainContext](./browser-logs.logseventdomaincontext.md) + + + + + +
+ +[StatusType](./browser-logs.statustype.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-logs.statustype.md b/docs/api-reference/rum/browser-logs.statustype.md new file mode 100644 index 0000000000..f0c2952fa7 --- /dev/null +++ b/docs/api-reference/rum/browser-logs.statustype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [StatusType](./browser-logs.statustype.md) + +## StatusType variable + +**Signature:** + +```typescript +StatusType: { + readonly ok: "ok"; + readonly debug: "debug"; + readonly info: "info"; + readonly notice: "notice"; + readonly warn: "warn"; + readonly error: "error"; + readonly critical: "critical"; + readonly alert: "alert"; + readonly emerg: "emerg"; +} +``` diff --git a/docs/api-reference/rum/browser-rum-react.addreacterror.md b/docs/api-reference/rum/browser-rum-react.addreacterror.md new file mode 100644 index 0000000000..10e44ca54a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.addreacterror.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [addReactError](./browser-rum-react.addreacterror.md) + +## addReactError() function + +**Signature:** + +```typescript +export declare function addReactError(error: Error, info: ErrorInfo): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+ +info + + + + +ErrorInfo + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md b/docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md new file mode 100644 index 0000000000..4c94bc4bab --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [(constructor)](./browser-rum-react.errorboundary._constructor_.md) + +## ErrorBoundary.(constructor) + +Constructs a new instance of the `ErrorBoundary` class + +**Signature:** + +```typescript +constructor(props: Props); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +props + + + + +Props + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md b/docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md new file mode 100644 index 0000000000..0ba5ed93a7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [componentDidCatch](./browser-rum-react.errorboundary.componentdidcatch.md) + +## ErrorBoundary.componentDidCatch() method + +**Signature:** + +```typescript +componentDidCatch(error: Error, errorInfo: ErrorInfo): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+ +errorInfo + + + + +ErrorInfo + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md new file mode 100644 index 0000000000..136a142feb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [getDerivedStateFromError](./browser-rum-react.errorboundary.getderivedstatefromerror.md) + +## ErrorBoundary.getDerivedStateFromError() method + +**Signature:** + +```typescript +static getDerivedStateFromError(error: Error): State; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+**Returns:** + +State + diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.md b/docs/api-reference/rum/browser-rum-react.errorboundary.md new file mode 100644 index 0000000000..e57f3c00e0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary.md @@ -0,0 +1,146 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) + +## ErrorBoundary class + +**Signature:** + +```typescript +export declare class ErrorBoundary extends React.Component +``` +**Extends:** React.Component<Props, State> + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(props)](./browser-rum-react.errorboundary._constructor_.md) + + + + + + + +Constructs a new instance of the `ErrorBoundary` class + + +
+ +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[resetError](./browser-rum-react.errorboundary.reseterror.md) + + + + + + + +() => void + + + + + +
+ +## Methods + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[componentDidCatch(error, errorInfo)](./browser-rum-react.errorboundary.componentdidcatch.md) + + + + + + + + +
+ +[getDerivedStateFromError(error)](./browser-rum-react.errorboundary.getderivedstatefromerror.md) + + + + +`static` + + + + + +
+ +[render()](./browser-rum-react.errorboundary.render.md) + + + + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.render.md b/docs/api-reference/rum/browser-rum-react.errorboundary.render.md new file mode 100644 index 0000000000..59104a5388 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary.render.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [render](./browser-rum-react.errorboundary.render.md) + +## ErrorBoundary.render() method + +**Signature:** + +```typescript +render(): React.ReactNode; +``` +**Returns:** + +React.ReactNode + diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md b/docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md new file mode 100644 index 0000000000..a15c2f05c2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [resetError](./browser-rum-react.errorboundary.reseterror.md) + +## ErrorBoundary.resetError property + +**Signature:** + +```typescript +resetError: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-react.md b/docs/api-reference/rum/browser-rum-react.md new file mode 100644 index 0000000000..3e5c1f343c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.md @@ -0,0 +1,86 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) + +## browser-rum-react package + +## Classes + + + +
+ +Class + + + + +Description + + +
+ +[ErrorBoundary](./browser-rum-react.errorboundary.md) + + + + + +
+ +## Functions + + + + +
+ +Function + + + + +Description + + +
+ +[addReactError(error, info)](./browser-rum-react.addreacterror.md) + + + + + +
+ +[reactPlugin(configuration)](./browser-rum-react.reactplugin.md) + + + + + +
+ +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +[UNSTABLE\_ReactComponentTracker](./browser-rum-react.unstable_reactcomponenttracker.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-react.reactplugin.md b/docs/api-reference/rum/browser-rum-react.reactplugin.md new file mode 100644 index 0000000000..14abf1f0ec --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.reactplugin.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [reactPlugin](./browser-rum-react.reactplugin.md) + +## reactPlugin() function + +**Signature:** + +```typescript +export declare function reactPlugin(configuration?: ReactPluginConfiguration): { + name: string; + onInit({ publicApi, initConfiguration }: { + initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; + publicApi: RumPublicApi; + }): void; + onRumStart({ strategy }: { + strategy: Strategy; + }): void; + getConfigurationTelemetry(): { + router: boolean; + }; +}; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +configuration + + + + +ReactPluginConfiguration + + + + +_(Optional)_ + + +
+**Returns:** + +{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } + diff --git a/docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md b/docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md new file mode 100644 index 0000000000..5f6e8c67ff --- /dev/null +++ b/docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [UNSTABLE\_ReactComponentTracker](./browser-rum-react.unstable_reactcomponenttracker.md) + +## UNSTABLE\_ReactComponentTracker variable + +**Signature:** + +```typescript +UNSTABLE_ReactComponentTracker: ({ name: componentName, children, }: { + name: string; + children?: React.ReactNode; +}) => React.JSX.Element +``` diff --git a/docs/api-reference/rum/browser-rum-slim.datadogrum.md b/docs/api-reference/rum/browser-rum-slim.datadogrum.md new file mode 100644 index 0000000000..a7169f2ae2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-slim.datadogrum.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-slim](./browser-rum-slim.md) > [datadogRum](./browser-rum-slim.datadogrum.md) + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/api-reference/rum/browser-rum-slim.md b/docs/api-reference/rum/browser-rum-slim.md new file mode 100644 index 0000000000..ffa0ea6342 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-slim.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@datadog/browser-rum-slim](./browser-rum-slim.md) + +## browser-rum-slim package + +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +[datadogRum](./browser-rum-slim.datadogrum.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-rum.datadogrum.md b/docs/api-reference/rum/browser-rum.datadogrum.md new file mode 100644 index 0000000000..8f426c7d49 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.datadogrum.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [datadogRum](./browser-rum.datadogrum.md) + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/api-reference/rum/browser-rum.md b/docs/api-reference/rum/browser-rum.md new file mode 100644 index 0000000000..7e1821dafb --- /dev/null +++ b/docs/api-reference/rum/browser-rum.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) + +## browser-rum package + +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +[datadogRum](./browser-rum.datadogrum.md) + + + + + +
diff --git a/docs/api-reference/rum/index.md b/docs/api-reference/rum/index.md new file mode 100644 index 0000000000..3b3651148c --- /dev/null +++ b/docs/api-reference/rum/index.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + + + + + + +
+ +Package + + + + +Description + + +
+ +[@datadog/browser-logs](./browser-logs.md) + + + + + +
+ +[@datadog/browser-rum](./browser-rum.md) + + + + + +
+ +[@datadog/browser-rum-react](./browser-rum-react.md) + + + + + +
+ +[@datadog/browser-rum-slim](./browser-rum-slim.md) + + + + + +
diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json new file mode 100644 index 0000000000..d7dec6a2d3 --- /dev/null +++ b/etc/browser-logs.api.json @@ -0,0 +1,3521 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-logs!", + "docComment": "", + "name": "@datadog/browser-logs", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-logs!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!datadogLogs:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogLogs: " + }, + { + "kind": "Reference", + "text": "LogsPublicApi", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface" + } + ], + "fileUrlPath": "packages/logs/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogLogs", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!HandlerType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type HandlerType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "HandlerType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!HandlerType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "HandlerType: " + }, + { + "kind": "Content", + "text": "{\n readonly console: \"console\";\n readonly http: \"http\";\n readonly silent: \"silent\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "HandlerType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-logs!Logger:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-logs!Logger:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Logger` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(handleLogStrategy: " + }, + { + "kind": "Content", + "text": "(logsMessage: " + }, + { + "kind": "Reference", + "text": "LogsMessage", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface" + }, + { + "kind": "Content", + "text": ", logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ", handlingStack?: string) => void" + }, + { + "kind": "Content", + "text": ", name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", handlerType?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ", level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", loggerContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handleLogStrategy", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlerType", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "isOptional": true + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "isOptional": true + }, + { + "parameterName": "loggerContext", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#clearContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearContext(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "clearContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContext(): " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHandler(): " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLevel(): " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getLevel" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#log:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "log(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "log" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#logImplementation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logImplementation(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlingStack", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "logImplementation" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#removeContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "removeContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContext(context: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", value: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setHandler(handler: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setLevel(level: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setLevel" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!Logger:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "alert(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "alert" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "critical(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "critical" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "debug(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "debug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "emerg(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "emerg" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "error" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "info(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "info" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "notice(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "notice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ok(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "ok" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "warn(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "warn" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LoggerConfiguration " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LoggerConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#handler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handler?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#level:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsEvent " + } + ], + "fileUrlPath": "packages/logs/esm/logsEvent.types.d.ts", + "releaseTag": "Public", + "name": "LogsEvent", + "preserveMemberOrder": false, + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#application_id:member", + "docComment": "/**\n * UUID of the application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "application_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "application_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#date:member", + "docComment": "/**\n * Start of the log in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#error:member", + "docComment": "/**\n * Error properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Content", + "text": "{\n kind?: string;\n stack?: string;\n fingerprint?: string;\n message?: string;\n causes?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<{\n message: string;\n source: string;\n type?: string;\n stack?: string;\n }>;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#http:member", + "docComment": "/**\n * Resource properties of the error\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "http?: " + }, + { + "kind": "Content", + "text": "{\n method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH';\n status_code: number;\n url: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "http", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#logger:member", + "docComment": "/**\n * Logger properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger?: " + }, + { + "kind": "Content", + "text": "{\n name: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#message:member", + "docComment": "/**\n * The log message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#origin:member", + "docComment": "/**\n * Origin of the log\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "origin: " + }, + { + "kind": "Content", + "text": "'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "origin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#service:member", + "docComment": "/**\n * The service name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session_id:member", + "docComment": "/**\n * UUID of the session (deprecated in favor of session.id)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session?: " + }, + { + "kind": "Content", + "text": "{\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#status:member", + "docComment": "/**\n * The log status\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Content", + "text": "'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "view: " + }, + { + "kind": "Content", + "text": "{\n referrer?: string;\n url: string;\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type LogsEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.NETWORK", + "canonicalReference": "@datadog/browser-core!__type#NETWORK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "NetworkLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~NetworkLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.CONSOLE", + "canonicalReference": "@datadog/browser-core!__type#CONSOLE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "ConsoleLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~ConsoleLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.LOGGER", + "canonicalReference": "@datadog/browser-core!__type#LOGGER:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "LoggerLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~LoggerLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "LogsEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 18 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LogsGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#createLogger:member", + "docComment": "/**\n * The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones.\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createLogger: " + }, + { + "kind": "Content", + "text": "(name: string, conf?: " + }, + { + "kind": "Reference", + "text": "LoggerConfiguration", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "createLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n *\n * See [Access internal context](https://docs.datadoghq.com/logs/log_collection/javascript/#access-internal-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-logs!~InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getLogger:member", + "docComment": "/**\n * Get a logger\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLogger: " + }, + { + "kind": "Content", + "text": "(name: string) => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#init:member", + "docComment": "/**\n * Init the Logs browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [Browser Log Collection](https://docs.datadoghq.com/logs/log_collection/javascript) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#logger:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all logs, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Logs will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specified a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/domain/configuration.d.ts", + "releaseTag": "Public", + "name": "LogsInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "LogsEvent", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "LogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardConsoleLogs:member", + "docComment": "/**\n * Forward logs from console.* to Datadog. Use \"all\" to forward everything or an array of console API names to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardConsoleLogs?: " + }, + { + "kind": "Reference", + "text": "ConsoleApiName", + "canonicalReference": "@datadog/browser-core!ConsoleApiName:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardConsoleLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardErrorsToLogs:member", + "docComment": "/**\n * Forward console.error logs, uncaught exceptions and network errors to Datadog. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardErrorsToLogs?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardErrorsToLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardReports:member", + "docComment": "/**\n * Forward reports from the [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) to Datadog. Use \"all\" to forward everything or an array of report types to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardReports?: " + }, + { + "kind": "Reference", + "text": "RawReportType", + "canonicalReference": "@datadog/browser-core!RawReportType:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardReports", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#usePciIntake:member", + "docComment": "/**\n * Use PCI-compliant intake. See [PCI DSS Compliance](https://docs.datadoghq.com/data_security/pci_compliance/?tab=logmanagement) for further information. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "usePciIntake?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "usePciIntake", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsMessage " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "LogsMessage", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!StatusType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type StatusType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "releaseTag": "Public", + "name": "StatusType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!StatusType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "StatusType: " + }, + { + "kind": "Content", + "text": "{\n readonly ok: \"ok\";\n readonly debug: \"debug\";\n readonly info: \"info\";\n readonly notice: \"notice\";\n readonly warn: \"warn\";\n readonly error: \"error\";\n readonly critical: \"critical\";\n readonly alert: \"alert\";\n readonly emerg: \"emerg\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "StatusType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json new file mode 100644 index 0000000000..4a4c131f61 --- /dev/null +++ b/etc/browser-rum-react.api.json @@ -0,0 +1,625 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-react!", + "docComment": "", + "name": "@datadog/browser-rum-react", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-react!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function addReactError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", info: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/addReactError.d.ts", + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "info", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "name": "addReactError" + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ErrorBoundary extends " + }, + { + "kind": "Reference", + "text": "React.Component", + "canonicalReference": "@types/react!React.Component:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/errorBoundary.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "ErrorBoundary", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `ErrorBoundary` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(props: " + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "props", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#componentDidCatch:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentDidCatch(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", errorInfo: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "errorInfo", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "componentDidCatch" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary.getDerivedStateFromError:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "static getDerivedStateFromError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "getDerivedStateFromError" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#render:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "render(): " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "render" + }, + { + "kind": "Property", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#resetError:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "resetError: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "resetError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 7 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function reactPlugin(configuration?: " + }, + { + "kind": "Reference", + "text": "ReactPluginConfiguration", + "canonicalReference": "@datadog/browser-rum-react!~ReactPluginConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "{\n name: string;\n onInit({ publicApi, initConfiguration }: {\n initConfiguration: import(\"@datadog/browser-rum-core\")." + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n publicApi: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n onRumStart({ strategy }: {\n strategy: " + }, + { + "kind": "Reference", + "text": "Strategy", + "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n getConfigurationTelemetry(): {\n router: boolean;\n };\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/reactPlugin.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": true + } + ], + "name": "reactPlugin" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UNSTABLE_ReactComponentTracker: " + }, + { + "kind": "Content", + "text": "({ " + }, + { + "kind": "Reference", + "text": "name", + "canonicalReference": "@datadog/browser-rum-react!~__type#name" + }, + { + "kind": "Content", + "text": ": componentName, children, }: {\n name: string;\n children?: " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";\n}) => " + }, + { + "kind": "Reference", + "text": "React.JSX.Element", + "canonicalReference": "@types/react!React.JSX.Element:interface" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/performance/reactComponentTracker.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "UNSTABLE_ReactComponentTracker", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-slim.api.json b/etc/browser-rum-slim.api.json new file mode 100644 index 0000000000..0789ce2570 --- /dev/null +++ b/etc/browser-rum-slim.api.json @@ -0,0 +1,202 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-slim!", + "docComment": "", + "name": "@datadog/browser-rum-slim", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-slim!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + } + ], + "fileUrlPath": "packages/rum-slim/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json new file mode 100644 index 0000000000..dc3519f0d5 --- /dev/null +++ b/etc/browser-rum.api.json @@ -0,0 +1,202 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum!", + "docComment": "", + "name": "@datadog/browser-rum", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + } + ], + "fileUrlPath": "packages/rum/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/package.json b/package.json index 310043a42f..c95c1ff0b9 100644 --- a/package.json +++ b/package.json @@ -34,11 +34,19 @@ "test:compat:ssr": "scripts/cli check_server_side_rendering_compatibility", "rum-events-format:sync": "scripts/cli update_submodule && scripts/cli build_json2type && node scripts/generate-schema-types.js", "size": "node scripts/show-bundle-size.js", - "woke": "scripts/cli woke" + "woke": "scripts/cli woke", + "build:types": "lerna run build:esm --stream", + "docs:api:rum": "api-extractor run --local --config packages/rum/api-extractor.json", + "docs:api:logs": "api-extractor run --local --config packages/logs/api-extractor.json", + "docs:api:rum-slim": "api-extractor run --local --config packages/rum-slim/api-extractor.json", + "docs:api:rum-react": "api-extractor run --local --config packages/rum-react/api-extractor.json", + "docs:api": "yarn build:types && yarn docs:api:rum && yarn docs:api:logs && yarn docs:api:rum-slim && yarn docs:api:rum-react" }, "devDependencies": { "@eslint/js": "9.26.0", "@jsdevtools/coverage-istanbul-loader": "3.0.5", + "@microsoft/api-documenter": "7.25.9", + "@microsoft/api-extractor": "7.38.0", "@playwright/test": "1.52.0", "@swc/core": "1.11.24", "@types/chrome": "0.0.321", diff --git a/packages/logs/api-extractor.json b/packages/logs/api-extractor.json new file mode 100644 index 0000000000..5465924218 --- /dev/null +++ b/packages/logs/api-extractor.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "./esm/entries/main.d.ts", + "compiler": { + "tsconfigFilePath": "./tsconfig.esm.json" + }, + "dtsRollup": { + "enabled": false + }, + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/etc/.api.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning", + "addToApiReportFile": false + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/packages/rum-react/api-extractor.json b/packages/rum-react/api-extractor.json new file mode 100644 index 0000000000..5465924218 --- /dev/null +++ b/packages/rum-react/api-extractor.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "./esm/entries/main.d.ts", + "compiler": { + "tsconfigFilePath": "./tsconfig.esm.json" + }, + "dtsRollup": { + "enabled": false + }, + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/etc/.api.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning", + "addToApiReportFile": false + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/packages/rum-slim/api-extractor.json b/packages/rum-slim/api-extractor.json new file mode 100644 index 0000000000..5465924218 --- /dev/null +++ b/packages/rum-slim/api-extractor.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "./esm/entries/main.d.ts", + "compiler": { + "tsconfigFilePath": "./tsconfig.esm.json" + }, + "dtsRollup": { + "enabled": false + }, + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/etc/.api.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning", + "addToApiReportFile": false + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/packages/rum/api-extractor.json b/packages/rum/api-extractor.json new file mode 100644 index 0000000000..5465924218 --- /dev/null +++ b/packages/rum/api-extractor.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "./esm/entries/main.d.ts", + "compiler": { + "tsconfigFilePath": "./tsconfig.esm.json" + }, + "dtsRollup": { + "enabled": false + }, + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/etc/.api.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning", + "addToApiReportFile": false + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/yarn.lock b/yarn.lock index d0c49f7d65..8d58388299 100644 --- a/yarn.lock +++ b/yarn.lock @@ -831,6 +831,105 @@ __metadata: languageName: node linkType: hard +"@microsoft/api-documenter@npm:7.25.9": + version: 7.25.9 + resolution: "@microsoft/api-documenter@npm:7.25.9" + dependencies: + "@microsoft/api-extractor-model": "npm:7.29.4" + "@microsoft/tsdoc": "npm:~0.15.0" + "@rushstack/node-core-library": "npm:5.5.1" + "@rushstack/terminal": "npm:0.13.3" + "@rushstack/ts-command-line": "npm:4.22.3" + js-yaml: "npm:~3.13.1" + resolve: "npm:~1.22.1" + bin: + api-documenter: bin/api-documenter + checksum: 10c0/b5c7efa3af0dda152d99f24114e2218a5c7daed6c155585cc51817bcf19e51e28297867981ec2cd44d5e59479e1c6946e45fb440a2d227d423bd2eef70491360 + languageName: node + linkType: hard + +"@microsoft/api-extractor-model@npm:7.28.2": + version: 7.28.2 + resolution: "@microsoft/api-extractor-model@npm:7.28.2" + dependencies: + "@microsoft/tsdoc": "npm:0.14.2" + "@microsoft/tsdoc-config": "npm:~0.16.1" + "@rushstack/node-core-library": "npm:3.61.0" + checksum: 10c0/b97cfd8b8968143ef2deea25cfefab84d6d064b9378a04270e2a6f7e00ea4a781876264ddc51835ffda9eedb6962403afbe01b4447ffe42388a065cd42532a31 + languageName: node + linkType: hard + +"@microsoft/api-extractor-model@npm:7.29.4": + version: 7.29.4 + resolution: "@microsoft/api-extractor-model@npm:7.29.4" + dependencies: + "@microsoft/tsdoc": "npm:~0.15.0" + "@microsoft/tsdoc-config": "npm:~0.17.0" + "@rushstack/node-core-library": "npm:5.5.1" + checksum: 10c0/daa657d2b6ab7cdf711a7b59306a8bd29d637ac8460795a177f186ef9691bfc3d9d1a2f0300a2dc28b37e80cc04e35d810dd0e24a92d8b3968ac51689e532ab5 + languageName: node + linkType: hard + +"@microsoft/api-extractor@npm:7.38.0": + version: 7.38.0 + resolution: "@microsoft/api-extractor@npm:7.38.0" + dependencies: + "@microsoft/api-extractor-model": "npm:7.28.2" + "@microsoft/tsdoc": "npm:0.14.2" + "@microsoft/tsdoc-config": "npm:~0.16.1" + "@rushstack/node-core-library": "npm:3.61.0" + "@rushstack/rig-package": "npm:0.5.1" + "@rushstack/ts-command-line": "npm:4.16.1" + colors: "npm:~1.2.1" + lodash: "npm:~4.17.15" + resolve: "npm:~1.22.1" + semver: "npm:~7.5.4" + source-map: "npm:~0.6.1" + typescript: "npm:~5.0.4" + bin: + api-extractor: bin/api-extractor + checksum: 10c0/3bb4336efdbcad1d0c789dbdd9d85a3d3142a733c66b7cf3136d7a3404bb3ba440bb9e077fa927c981447ca5f8bc76d0fb790b2385b7b66a01c05fe41e2fb59c + languageName: node + linkType: hard + +"@microsoft/tsdoc-config@npm:~0.16.1": + version: 0.16.2 + resolution: "@microsoft/tsdoc-config@npm:0.16.2" + dependencies: + "@microsoft/tsdoc": "npm:0.14.2" + ajv: "npm:~6.12.6" + jju: "npm:~1.4.0" + resolve: "npm:~1.19.0" + checksum: 10c0/9e8c176b68f01c8bb38e6365d5b543e471bba59fced6070d9bd35b32461fbd650c2e1a6f686e8dca0cf22bc5e7d796e4213e66bce4426c8cb9864c1f6ca6836c + languageName: node + linkType: hard + +"@microsoft/tsdoc-config@npm:~0.17.0": + version: 0.17.1 + resolution: "@microsoft/tsdoc-config@npm:0.17.1" + dependencies: + "@microsoft/tsdoc": "npm:0.15.1" + ajv: "npm:~8.12.0" + jju: "npm:~1.4.0" + resolve: "npm:~1.22.2" + checksum: 10c0/a686355796f492f27af17e2a17d615221309caf4d9f9047a5a8f17f8625c467c4c81e2a7923ddafd71b892631d5e5013c4b8cc49c5867d3cc1d260fd90c1413d + languageName: node + linkType: hard + +"@microsoft/tsdoc@npm:0.14.2": + version: 0.14.2 + resolution: "@microsoft/tsdoc@npm:0.14.2" + checksum: 10c0/c018857ad439144559ce34a397a29ace7cf5b24b999b8e3c1b88d878338088b3a453eaac4435beaf2c7eae13c4c0aac81e42f96f0f1d48e8d4eeb438eb3bb82f + languageName: node + linkType: hard + +"@microsoft/tsdoc@npm:0.15.1, @microsoft/tsdoc@npm:~0.15.0": + version: 0.15.1 + resolution: "@microsoft/tsdoc@npm:0.15.1" + checksum: 10c0/09948691fac56c45a0d1920de478d66a30371a325bd81addc92eea5654d95106ce173c440fea1a1bd5bb95b3a544b6d4def7bb0b5a846c05d043575d8369a20c + languageName: node + linkType: hard + "@modelcontextprotocol/sdk@npm:^1.8.0": version: 1.11.2 resolution: "@modelcontextprotocol/sdk@npm:1.11.2" @@ -1382,6 +1481,96 @@ __metadata: languageName: node linkType: hard +"@rushstack/node-core-library@npm:3.61.0": + version: 3.61.0 + resolution: "@rushstack/node-core-library@npm:3.61.0" + dependencies: + colors: "npm:~1.2.1" + fs-extra: "npm:~7.0.1" + import-lazy: "npm:~4.0.0" + jju: "npm:~1.4.0" + resolve: "npm:~1.22.1" + semver: "npm:~7.5.4" + z-schema: "npm:~5.0.2" + peerDependencies: + "@types/node": "*" + peerDependenciesMeta: + "@types/node": + optional: true + checksum: 10c0/6ae8205e57b13b2898fcc07754a70d2c716ecd5c853310a7a75c6321c1f1be79695eb7571d975243f2f83df1ba5d15342c0fa50715b8f146f7ae544f94d89eb6 + languageName: node + linkType: hard + +"@rushstack/node-core-library@npm:5.5.1": + version: 5.5.1 + resolution: "@rushstack/node-core-library@npm:5.5.1" + dependencies: + ajv: "npm:~8.13.0" + ajv-draft-04: "npm:~1.0.0" + ajv-formats: "npm:~3.0.1" + fs-extra: "npm:~7.0.1" + import-lazy: "npm:~4.0.0" + jju: "npm:~1.4.0" + resolve: "npm:~1.22.1" + semver: "npm:~7.5.4" + peerDependencies: + "@types/node": "*" + peerDependenciesMeta: + "@types/node": + optional: true + checksum: 10c0/cd433fe0857f1a827910ffa97670df161bc2dc25255252a1cb23f2e7796b8000ac3c39df6723b1d31cf9629ad348291ba1591da3a200a9ff754ca266b785f010 + languageName: node + linkType: hard + +"@rushstack/rig-package@npm:0.5.1": + version: 0.5.1 + resolution: "@rushstack/rig-package@npm:0.5.1" + dependencies: + resolve: "npm:~1.22.1" + strip-json-comments: "npm:~3.1.1" + checksum: 10c0/a296125a5170dd11c37c3d679eb6e61db4d0c0741b3947902d9eab34e9ff34d5d8e94fbf6b45757141ea077029490198b7eb35d311ba46eaac5e1d4145e9780c + languageName: node + linkType: hard + +"@rushstack/terminal@npm:0.13.3": + version: 0.13.3 + resolution: "@rushstack/terminal@npm:0.13.3" + dependencies: + "@rushstack/node-core-library": "npm:5.5.1" + supports-color: "npm:~8.1.1" + peerDependencies: + "@types/node": "*" + peerDependenciesMeta: + "@types/node": + optional: true + checksum: 10c0/dced0c935672c73787e277dacc2b8b826496c6f85d4f4ff24cce73ebbfd3ad1c0bb7e6dda46a918527da3024779ffd61aa35c5b91ad06b0044b0b51dbec7d726 + languageName: node + linkType: hard + +"@rushstack/ts-command-line@npm:4.16.1": + version: 4.16.1 + resolution: "@rushstack/ts-command-line@npm:4.16.1" + dependencies: + "@types/argparse": "npm:1.0.38" + argparse: "npm:~1.0.9" + colors: "npm:~1.2.1" + string-argv: "npm:~0.3.1" + checksum: 10c0/aa77950c72085f0571ffa9bbe18649f86a8d0da7918ee6cbce67de073aad5a7e2643c80aea485b852e474d08de12c0aeaece6efd942b8045d66733dca88d3108 + languageName: node + linkType: hard + +"@rushstack/ts-command-line@npm:4.22.3": + version: 4.22.3 + resolution: "@rushstack/ts-command-line@npm:4.22.3" + dependencies: + "@rushstack/terminal": "npm:0.13.3" + "@types/argparse": "npm:1.0.38" + argparse: "npm:~1.0.9" + string-argv: "npm:~0.3.1" + checksum: 10c0/02b318832d80829b749e7123511f3828945bca4cd07e59d4afbfc07c5140acbf9cab28b1f36c1023f14c16280fdb992198b132a679e4d240710fc02138a0ba3a + languageName: node + linkType: hard + "@sigstore/bundle@npm:^2.3.2": version: 2.3.2 resolution: "@sigstore/bundle@npm:2.3.2" @@ -1665,6 +1854,13 @@ __metadata: languageName: node linkType: hard +"@types/argparse@npm:1.0.38": + version: 1.0.38 + resolution: "@types/argparse@npm:1.0.38" + checksum: 10c0/4fc892da5df16923f48180da2d1f4562fa8b0507cf636b24780444fa0a1d7321d4dc0c0ecbee6152968823f5a2ae0d321b4f8c705a489bf1ae1245bdeb0868fd + languageName: node + linkType: hard + "@types/body-parser@npm:*": version: 1.19.5 resolution: "@types/body-parser@npm:1.19.5" @@ -2461,6 +2657,18 @@ __metadata: languageName: node linkType: hard +"ajv-draft-04@npm:~1.0.0": + version: 1.0.0 + resolution: "ajv-draft-04@npm:1.0.0" + peerDependencies: + ajv: ^8.5.0 + peerDependenciesMeta: + ajv: + optional: true + checksum: 10c0/6044310bd38c17d77549fd326bd40ce1506fa10b0794540aa130180808bf94117fac8c9b448c621512bea60e4a947278f6a978e87f10d342950c15b33ddd9271 + languageName: node + linkType: hard + "ajv-formats@npm:^2.1.1": version: 2.1.1 resolution: "ajv-formats@npm:2.1.1" @@ -2475,6 +2683,20 @@ __metadata: languageName: node linkType: hard +"ajv-formats@npm:~3.0.1": + version: 3.0.1 + resolution: "ajv-formats@npm:3.0.1" + dependencies: + ajv: "npm:^8.0.0" + peerDependencies: + ajv: ^8.0.0 + peerDependenciesMeta: + ajv: + optional: true + checksum: 10c0/168d6bca1ea9f163b41c8147bae537e67bd963357a5488a1eaf3abe8baa8eec806d4e45f15b10767e6020679315c7e1e5e6803088dfb84efa2b4e9353b83dd0a + languageName: node + linkType: hard + "ajv-keywords@npm:^3.5.2": version: 3.5.2 resolution: "ajv-keywords@npm:3.5.2" @@ -2507,7 +2729,7 @@ __metadata: languageName: node linkType: hard -"ajv@npm:^6.12.4, ajv@npm:^6.12.6": +"ajv@npm:^6.12.4, ajv@npm:^6.12.6, ajv@npm:~6.12.6": version: 6.12.6 resolution: "ajv@npm:6.12.6" dependencies: @@ -2519,6 +2741,30 @@ __metadata: languageName: node linkType: hard +"ajv@npm:~8.12.0": + version: 8.12.0 + resolution: "ajv@npm:8.12.0" + dependencies: + fast-deep-equal: "npm:^3.1.1" + json-schema-traverse: "npm:^1.0.0" + require-from-string: "npm:^2.0.2" + uri-js: "npm:^4.2.2" + checksum: 10c0/ac4f72adf727ee425e049bc9d8b31d4a57e1c90da8d28bcd23d60781b12fcd6fc3d68db5df16994c57b78b94eed7988f5a6b482fd376dc5b084125e20a0a622e + languageName: node + linkType: hard + +"ajv@npm:~8.13.0": + version: 8.13.0 + resolution: "ajv@npm:8.13.0" + dependencies: + fast-deep-equal: "npm:^3.1.3" + json-schema-traverse: "npm:^1.0.0" + require-from-string: "npm:^2.0.2" + uri-js: "npm:^4.4.1" + checksum: 10c0/14c6497b6f72843986d7344175a1aa0e2c35b1e7f7475e55bc582cddb765fca7e6bf950f465dc7846f817776d9541b706f4b5b3fbedd8dfdeb5fce6f22864264 + languageName: node + linkType: hard + "ansi-colors@npm:^4.1.1": version: 4.1.3 resolution: "ansi-colors@npm:4.1.3" @@ -2619,7 +2865,7 @@ __metadata: languageName: node linkType: hard -"argparse@npm:^1.0.7": +"argparse@npm:^1.0.7, argparse@npm:~1.0.9": version: 1.0.10 resolution: "argparse@npm:1.0.10" dependencies: @@ -3011,6 +3257,8 @@ __metadata: dependencies: "@eslint/js": "npm:9.26.0" "@jsdevtools/coverage-istanbul-loader": "npm:3.0.5" + "@microsoft/api-documenter": "npm:7.25.9" + "@microsoft/api-extractor": "npm:7.38.0" "@playwright/test": "npm:1.52.0" "@swc/core": "npm:1.11.24" "@types/chrome": "npm:0.0.321" @@ -3563,6 +3811,13 @@ __metadata: languageName: node linkType: hard +"colors@npm:~1.2.1": + version: 1.2.5 + resolution: "colors@npm:1.2.5" + checksum: 10c0/f4acebf2d2da9b4f8afb770361d14c01034bcb43add4cae493e7d186dcd7e0c5e2b440520fbfdf636e872606a0eb86b1f69fcf2f087df2876a4e222612539ee0 + languageName: node + linkType: hard + "columnify@npm:1.6.0": version: 1.6.0 resolution: "columnify@npm:1.6.0" @@ -3603,6 +3858,13 @@ __metadata: languageName: node linkType: hard +"commander@npm:^9.4.1": + version: 9.5.0 + resolution: "commander@npm:9.5.0" + checksum: 10c0/5f7784fbda2aaec39e89eb46f06a999e00224b3763dc65976e05929ec486e174fe9aac2655f03ba6a5e83875bd173be5283dc19309b7c65954701c02025b3c1d + languageName: node + linkType: hard + "comment-parser@npm:1.4.1": version: 1.4.1 resolution: "comment-parser@npm:1.4.1" @@ -5552,6 +5814,17 @@ __metadata: languageName: node linkType: hard +"fs-extra@npm:~7.0.1": + version: 7.0.1 + resolution: "fs-extra@npm:7.0.1" + dependencies: + graceful-fs: "npm:^4.1.2" + jsonfile: "npm:^4.0.0" + universalify: "npm:^0.1.0" + checksum: 10c0/1943bb2150007e3739921b8d13d4109abdc3cc481e53b97b7ea7f77eda1c3c642e27ae49eac3af074e3496ea02fde30f411ef410c760c70a38b92e656e5da784 + languageName: node + linkType: hard + "fs-minipass@npm:^2.0.0": version: 2.1.0 resolution: "fs-minipass@npm:2.1.0" @@ -6320,6 +6593,13 @@ __metadata: languageName: node linkType: hard +"import-lazy@npm:~4.0.0": + version: 4.0.0 + resolution: "import-lazy@npm:4.0.0" + checksum: 10c0/a3520313e2c31f25c0b06aa66d167f329832b68a4f957d7c9daf6e0fa41822b6e84948191648b9b9d8ca82f94740cdf15eecf2401a5b42cd1c33fd84f2225cca + languageName: node + linkType: hard + "import-local@npm:3.1.0": version: 3.1.0 resolution: "import-local@npm:3.1.0" @@ -6555,7 +6835,7 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.13.0, is-core-module@npm:^2.15.1, is-core-module@npm:^2.16.0, is-core-module@npm:^2.5.0": +"is-core-module@npm:^2.1.0, is-core-module@npm:^2.13.0, is-core-module@npm:^2.15.1, is-core-module@npm:^2.16.0, is-core-module@npm:^2.5.0": version: 2.16.1 resolution: "is-core-module@npm:2.16.1" dependencies: @@ -7027,6 +7307,13 @@ __metadata: languageName: node linkType: hard +"jju@npm:~1.4.0": + version: 1.4.0 + resolution: "jju@npm:1.4.0" + checksum: 10c0/f3f444557e4364cfc06b1abf8331bf3778b26c0c8552ca54429bc0092652172fdea26cbffe33e1017b303d5aa506f7ede8571857400efe459cb7439180e2acad + languageName: node + linkType: hard + "js-tokens@npm:^4.0.0": version: 4.0.0 resolution: "js-tokens@npm:4.0.0" @@ -7057,6 +7344,18 @@ __metadata: languageName: node linkType: hard +"js-yaml@npm:~3.13.1": + version: 3.13.1 + resolution: "js-yaml@npm:3.13.1" + dependencies: + argparse: "npm:^1.0.7" + esprima: "npm:^4.0.0" + bin: + js-yaml: bin/js-yaml.js + checksum: 10c0/6a4f78b998d2eb58964cc5e051c031865bf292dc3c156a8057cf468d9e60a8739f4e8f607a267e97f09eb8d08263b8262df57eddb16b920ec5a04a259c3b4960 + languageName: node + linkType: hard + "jsbn@npm:1.1.0": version: 1.1.0 resolution: "jsbn@npm:1.1.0" @@ -7600,6 +7899,20 @@ __metadata: languageName: node linkType: hard +"lodash.get@npm:^4.4.2": + version: 4.4.2 + resolution: "lodash.get@npm:4.4.2" + checksum: 10c0/48f40d471a1654397ed41685495acb31498d5ed696185ac8973daef424a749ca0c7871bf7b665d5c14f5cc479394479e0307e781f61d5573831769593411be6e + languageName: node + linkType: hard + +"lodash.isequal@npm:^4.5.0": + version: 4.5.0 + resolution: "lodash.isequal@npm:4.5.0" + checksum: 10c0/dfdb2356db19631a4b445d5f37868a095e2402292d59539a987f134a8778c62a2810c2452d11ae9e6dcac71fc9de40a6fedcb20e2952a15b431ad8b29e50e28f + languageName: node + linkType: hard + "lodash.ismatch@npm:^4.4.0": version: 4.4.0 resolution: "lodash.ismatch@npm:4.4.0" @@ -7614,7 +7927,7 @@ __metadata: languageName: node linkType: hard -"lodash@npm:^4.17.15, lodash@npm:^4.17.20, lodash@npm:^4.17.21": +"lodash@npm:^4.17.15, lodash@npm:^4.17.20, lodash@npm:^4.17.21, lodash@npm:~4.17.15": version: 4.17.21 resolution: "lodash@npm:4.17.21" checksum: 10c0/d8cbea072bb08655bb4c989da418994b073a608dffa608b09ac04b43a791b12aeae7cd7ad919aa4c925f33b48490b5cfe6c1f71d827956071dae2e7bb3a6b74c @@ -9207,7 +9520,7 @@ __metadata: languageName: node linkType: hard -"path-parse@npm:^1.0.7": +"path-parse@npm:^1.0.6, path-parse@npm:^1.0.7": version: 1.0.7 resolution: "path-parse@npm:1.0.7" checksum: 10c0/11ce261f9d294cc7a58d6a574b7f1b935842355ec66fba3c3fd79e0f036462eaf07d0aa95bb74ff432f9afef97ce1926c720988c6a7451d8a584930ae7de86e1 @@ -10187,7 +10500,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.10.0, resolve@npm:^1.20.0, resolve@npm:^1.22.4": +"resolve@npm:^1.10.0, resolve@npm:^1.20.0, resolve@npm:^1.22.4, resolve@npm:~1.22.1, resolve@npm:~1.22.2": version: 1.22.10 resolution: "resolve@npm:1.22.10" dependencies: @@ -10200,7 +10513,17 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@npm%3A^1.10.0#optional!builtin, resolve@patch:resolve@npm%3A^1.20.0#optional!builtin, resolve@patch:resolve@npm%3A^1.22.4#optional!builtin": +"resolve@npm:~1.19.0": + version: 1.19.0 + resolution: "resolve@npm:1.19.0" + dependencies: + is-core-module: "npm:^2.1.0" + path-parse: "npm:^1.0.6" + checksum: 10c0/1c8afdfb88c9adab0a19b6f16756d47f5917f64047bf5a38c17aa543aae5ccca2a0631671b19ce8460a7a3e65ead98ee70e046d3056ec173d3377a27487848a8 + languageName: node + linkType: hard + +"resolve@patch:resolve@npm%3A^1.10.0#optional!builtin, resolve@patch:resolve@npm%3A^1.20.0#optional!builtin, resolve@patch:resolve@npm%3A^1.22.4#optional!builtin, resolve@patch:resolve@npm%3A~1.22.1#optional!builtin, resolve@patch:resolve@npm%3A~1.22.2#optional!builtin": version: 1.22.10 resolution: "resolve@patch:resolve@npm%3A1.22.10#optional!builtin::version=1.22.10&hash=c3c19d" dependencies: @@ -10213,6 +10536,16 @@ __metadata: languageName: node linkType: hard +"resolve@patch:resolve@npm%3A~1.19.0#optional!builtin": + version: 1.19.0 + resolution: "resolve@patch:resolve@npm%3A1.19.0#optional!builtin::version=1.19.0&hash=c3c19d" + dependencies: + is-core-module: "npm:^2.1.0" + path-parse: "npm:^1.0.6" + checksum: 10c0/254980f60dd9fdb28b34a511e70df6e3027d9627efce86a40757eea9b87252d172829c84517554560c4541ebfe207868270c19a0f086997b41209367aa8ef74f + languageName: node + linkType: hard + "restore-cursor@npm:^3.1.0": version: 3.1.0 resolution: "restore-cursor@npm:3.1.0" @@ -10438,6 +10771,17 @@ __metadata: languageName: node linkType: hard +"semver@npm:~7.5.4": + version: 7.5.4 + resolution: "semver@npm:7.5.4" + dependencies: + lru-cache: "npm:^6.0.0" + bin: + semver: bin/semver.js + checksum: 10c0/5160b06975a38b11c1ab55950cb5b8a23db78df88275d3d8a42ccf1f29e55112ac995b3a26a522c36e3b5f76b0445f1eef70d696b8c7862a2b4303d7b0e7609e + languageName: node + linkType: hard + "send@npm:^1.1.0, send@npm:^1.2.0": version: 1.2.0 resolution: "send@npm:1.2.0" @@ -10928,6 +11272,13 @@ __metadata: languageName: node linkType: hard +"string-argv@npm:~0.3.1": + version: 0.3.2 + resolution: "string-argv@npm:0.3.2" + checksum: 10c0/75c02a83759ad1722e040b86823909d9a2fc75d15dd71ec4b537c3560746e33b5f5a07f7332d1e3f88319909f82190843aa2f0a0d8c8d591ec08e93d5b8dec82 + languageName: node + linkType: hard + "string-width-cjs@npm:string-width@^4.2.0, string-width@npm:^1.0.2 || 2 || 3 || 4, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.3": version: 4.2.3 resolution: "string-width@npm:4.2.3" @@ -11075,7 +11426,7 @@ __metadata: languageName: node linkType: hard -"strip-json-comments@npm:^3.1.1": +"strip-json-comments@npm:^3.1.1, strip-json-comments@npm:~3.1.1": version: 3.1.1 resolution: "strip-json-comments@npm:3.1.1" checksum: 10c0/9681a6257b925a7fa0f285851c0e613cc934a50661fa7bb41ca9cbbff89686bb4a0ee366e6ecedc4daafd01e83eee0720111ab294366fe7c185e935475ebcecd @@ -11122,7 +11473,7 @@ __metadata: languageName: node linkType: hard -"supports-color@npm:^8.0.0": +"supports-color@npm:^8.0.0, supports-color@npm:~8.1.1": version: 8.1.1 resolution: "supports-color@npm:8.1.1" dependencies: @@ -11713,6 +12064,16 @@ __metadata: languageName: node linkType: hard +"typescript@npm:~5.0.4": + version: 5.0.4 + resolution: "typescript@npm:5.0.4" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 10c0/2f5bd1cead194905957cb34e220b1d6ff1662399adef8ec1864f74620922d860ee35b6e50eafb3b636ea6fd437195e454e1146cb630a4236b5095ed7617395c2 + languageName: node + linkType: hard + "typescript@patch:typescript@npm%3A5.8.3#optional!builtin, typescript@patch:typescript@npm%3A>=3 < 6#optional!builtin": version: 5.8.3 resolution: "typescript@patch:typescript@npm%3A5.8.3#optional!builtin::version=5.8.3&hash=5786d5" @@ -11723,6 +12084,16 @@ __metadata: languageName: node linkType: hard +"typescript@patch:typescript@npm%3A~5.0.4#optional!builtin": + version: 5.0.4 + resolution: "typescript@patch:typescript@npm%3A5.0.4#optional!builtin::version=5.0.4&hash=b5f058" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 10c0/c3f7b80577bddf6fab202a7925131ac733bfc414aec298c2404afcddc7a6f242cfa8395cf2d48192265052e11a7577c27f6e5fac8d8fe6a6602023c83d6b3292 + languageName: node + linkType: hard + "ua-parser-js@npm:^0.7.30": version: 0.7.40 resolution: "ua-parser-js@npm:0.7.40" @@ -11845,7 +12216,7 @@ __metadata: languageName: node linkType: hard -"uri-js@npm:^4.2.2": +"uri-js@npm:^4.2.2, uri-js@npm:^4.4.1": version: 4.4.1 resolution: "uri-js@npm:4.4.1" dependencies: @@ -11977,6 +12348,13 @@ __metadata: languageName: node linkType: hard +"validator@npm:^13.7.0": + version: 13.15.0 + resolution: "validator@npm:13.15.0" + checksum: 10c0/0f13fd7031ac575e8d7828431da8ef5859bac6a38ee65e1d7fdd367dbf1c3d94d95182aecc3183f7fa7a30ff4474bf864d1aff54707620227a2cdbfd36d894c2 + languageName: node + linkType: hard + "vary@npm:^1, vary@npm:^1.1.2": version: 1.1.2 resolution: "vary@npm:1.1.2" @@ -12517,6 +12895,23 @@ __metadata: languageName: node linkType: hard +"z-schema@npm:~5.0.2": + version: 5.0.5 + resolution: "z-schema@npm:5.0.5" + dependencies: + commander: "npm:^9.4.1" + lodash.get: "npm:^4.4.2" + lodash.isequal: "npm:^4.5.0" + validator: "npm:^13.7.0" + dependenciesMeta: + commander: + optional: true + bin: + z-schema: bin/z-schema + checksum: 10c0/e4c812cfe6468c19b2a21d07d4ff8fb70359062d33400b45f89017eaa3efe9d51e85963f2b115eaaa99a16b451782249bf9b1fa8b31d35cc473e7becb3e44264 + languageName: node + linkType: hard + "zod-to-json-schema@npm:^3.24.1": version: 3.24.5 resolution: "zod-to-json-schema@npm:3.24.5" From f6f14d386ce5207d1934a183cc22a2baacb1318c Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Mon, 26 May 2025 15:00:17 +0200 Subject: [PATCH 02/21] api --- .../rum/browser-rum-core.actiontype.md | 59 + .../rum/browser-rum-core.censored_img_mark.md | 11 + .../browser-rum-core.censored_string_mark.md | 11 + .../rum/browser-rum-core.censortext.md | 13 + .../browser-rum-core.commonproperties._dd.md | 27 + ...owser-rum-core.commonproperties.account.md | 17 + ...r-rum-core.commonproperties.application.md | 16 + ...wser-rum-core.commonproperties.build_id.md | 13 + ...rum-core.commonproperties.build_version.md | 13 + ...owser-rum-core.commonproperties.ci_test.md | 16 + ...-rum-core.commonproperties.connectivity.md | 23 + ...owser-rum-core.commonproperties.context.md | 15 + .../browser-rum-core.commonproperties.date.md | 13 + ...rowser-rum-core.commonproperties.device.md | 20 + ...owser-rum-core.commonproperties.display.md | 20 + .../rum/browser-rum-core.commonproperties.md | 423 + .../browser-rum-core.commonproperties.os.md | 19 + ...owser-rum-core.commonproperties.service.md | 13 + ...owser-rum-core.commonproperties.session.md | 18 + ...rowser-rum-core.commonproperties.source.md | 13 + ...er-rum-core.commonproperties.synthetics.md | 18 + .../browser-rum-core.commonproperties.usr.md | 19 + ...owser-rum-core.commonproperties.version.md | 13 + .../browser-rum-core.commonproperties.view.md | 19 + ...ault_programmatic_action_name_attribute.md | 13 + .../rum/browser-rum-core.foreachchildnodes.md | 63 + ...browser-rum-core.form_private_tag_names.md | 13 + .../rum/browser-rum-core.frustrationtype.md | 73 + ...rum-core.getmutationobserverconstructor.md | 15 + .../browser-rum-core.getnodeprivacylevel.md | 83 + ...rowser-rum-core.getnodeselfprivacylevel.md | 51 + .../rum/browser-rum-core.getparentnode.md | 51 + .../browser-rum-core.getprivacyselector.md | 49 + .../rum/browser-rum-core.getscrollx.md | 15 + .../rum/browser-rum-core.getscrolly.md | 15 + .../browser-rum-core.getsessionreplayurl.md | 67 + .../rum/browser-rum-core.gettextcontent.md | 77 + .../browser-rum-core.getviewportdimension.md | 15 + .../rum/browser-rum-core.haschildnodes.md | 49 + ...browser-rum-core.initviewportobservable.md | 49 + .../rum/browser-rum-core.iscommentnode.md | 49 + .../rum/browser-rum-core.iselementnode.md | 49 + .../rum/browser-rum-core.islongdataurl.md | 49 + .../rum/browser-rum-core.isnodeshadowhost.md | 51 + .../rum/browser-rum-core.isnodeshadowroot.md | 49 + .../rum/browser-rum-core.istextnode.md | 49 + .../rum/browser-rum-core.lifecycle.md | 13 + .../browser-rum-core.lifecycleeventtype.md | 241 + .../rum/browser-rum-core.makerumpublicapi.md | 93 + ...um-core.max_attribute_value_char_length.md | 11 + docs/api-reference/rum/browser-rum-core.md | 905 ++ .../browser-rum-core.mouseeventonelement.md | 11 + .../rum/browser-rum-core.nodeprivacylevel.md | 17 + .../browser-rum-core.nodeprivacylevelcache.md | 13 + .../rum/browser-rum-core.privacy_attr_name.md | 11 + ...owser-rum-core.privacy_attr_value_allow.md | 11 + ...wser-rum-core.privacy_attr_value_hidden.md | 11 + ...rowser-rum-core.privacy_attr_value_mask.md | 11 + ...core.privacy_attr_value_mask_user_input.md | 11 + .../browser-rum-core.privacy_class_prefix.md | 11 + .../rum/browser-rum-core.profilerapi.md | 70 + ...browser-rum-core.profilerapi.onrumstart.md | 11 + .../rum/browser-rum-core.profilerapi.stop.md | 11 + .../browser-rum-core.rawrumactionevent._dd.md | 25 + ...owser-rum-core.rawrumactionevent.action.md | 24 + ...browser-rum-core.rawrumactionevent.date.md | 11 + .../rum/browser-rum-core.rawrumactionevent.md | 125 + ...browser-rum-core.rawrumactionevent.type.md | 11 + ...browser-rum-core.rawrumactionevent.view.md | 13 + .../rum/browser-rum-core.rawrumevent.md | 13 + ...awrumeventcollecteddata.customercontext.md | 11 + ....rawrumeventcollecteddata.domaincontext.md | 11 + ...-core.rawrumeventcollecteddata.duration.md | 11 + ...owser-rum-core.rawrumeventcollecteddata.md | 125 + ...re.rawrumeventcollecteddata.rawrumevent.md | 11 + ...core.rawrumeventcollecteddata.starttime.md | 11 + ...ser-rum-core.recorderapi.getreplaystats.md | 11 + ...m-core.recorderapi.getsessionreplaylink.md | 11 + ...rowser-rum-core.recorderapi.isrecording.md | 11 + .../rum/browser-rum-core.recorderapi.md | 138 + ...browser-rum-core.recorderapi.onrumstart.md | 11 + .../rum/browser-rum-core.recorderapi.start.md | 11 + .../rum/browser-rum-core.recorderapi.stop.md | 11 + .../browser-rum-core.reduceprivacylevel.md | 65 + .../rum/browser-rum-core.replaystats.md | 87 + ...wser-rum-core.replaystats.records_count.md | 11 + ...ser-rum-core.replaystats.segments_count.md | 11 + ...ore.replaystats.segments_total_raw_size.md | 11 + .../rum/browser-rum-core.rumactionevent.md | 70 + ...core.rumactioneventdomaincontext.events.md | 11 + ...mactioneventdomaincontext.handlingstack.md | 11 + ...er-rum-core.rumactioneventdomaincontext.md | 74 + ...re.rumconfiguration.actionnameattribute.md | 11 + ...ore.rumconfiguration.allowedtracingurls.md | 11 + ...rum-core.rumconfiguration.applicationid.md | 11 + ...rumconfiguration.compressintakerequests.md | 11 + ...uration.customerdatatelemetrysamplerate.md | 11 + ...re.rumconfiguration.defaultprivacylevel.md | 11 + ...onfiguration.enableprivacyforactionname.md | 11 + ...e.rumconfiguration.excludedactivityurls.md | 11 + .../rum/browser-rum-core.rumconfiguration.md | 449 + ...owser-rum-core.rumconfiguration.plugins.md | 11 + ...re.rumconfiguration.profilingsamplerate.md | 11 + ....rumconfiguration.propagatetracebaggage.md | 11 + ...owser-rum-core.rumconfiguration.rulepsr.md | 11 + ...umconfiguration.sessionreplaysamplerate.md | 11 + ...ion.startsessionreplayrecordingmanually.md | 11 + ...ser-rum-core.rumconfiguration.subdomain.md | 11 + ....rumconfiguration.tracecontextinjection.md | 11 + ...m-core.rumconfiguration.tracesamplerate.md | 11 + ...onfiguration.trackfeatureflagsforevents.md | 11 + ...um-core.rumconfiguration.tracklongtasks.md | 11 + ...um-core.rumconfiguration.trackresources.md | 11 + ....rumconfiguration.trackuserinteractions.md | 11 + ...ore.rumconfiguration.trackviewsmanually.md | 11 + ...owser-rum-core.rumconfiguration.version.md | 11 + ...ser-rum-core.rumconfiguration.workerurl.md | 11 + .../rum/browser-rum-core.rumerrorevent.md | 94 + ...m-core.rumerroreventdomaincontext.error.md | 11 + ...umerroreventdomaincontext.handlingstack.md | 11 + ...ser-rum-core.rumerroreventdomaincontext.md | 72 + .../rum/browser-rum-core.rumevent.md | 15 + .../browser-rum-core.rumeventdomaincontext.md | 13 + .../rum/browser-rum-core.rumeventtype.md | 115 + ...umfetchresourceeventdomaincontext.error.md | 11 + ...esourceeventdomaincontext.handlingstack.md | 11 + ...tchresourceeventdomaincontext.isaborted.md | 11 + ...core.rumfetchresourceeventdomaincontext.md | 165 + ...urceeventdomaincontext.performanceentry.md | 11 + ...hresourceeventdomaincontext.requestinit.md | 11 + ...resourceeventdomaincontext.requestinput.md | 11 + ...etchresourceeventdomaincontext.response.md | 11 + ...uminitconfiguration.actionnameattribute.md | 13 + ...ruminitconfiguration.allowedtracingurls.md | 13 + ...core.ruminitconfiguration.applicationid.md | 13 + ...um-core.ruminitconfiguration.beforesend.md | 15 + ...nitconfiguration.compressintakerequests.md | 13 + ...uminitconfiguration.defaultprivacylevel.md | 13 + ...onfiguration.enableprivacyforactionname.md | 13 + ...minitconfiguration.excludedactivityurls.md | 13 + .../browser-rum-core.ruminitconfiguration.md | 476 + ...r-rum-core.ruminitconfiguration.plugins.md | 13 + ...uminitconfiguration.profilingsamplerate.md | 13 + ...initconfiguration.propagatetracebaggage.md | 13 + ...initconfiguration.remoteconfigurationid.md | 11 + ...itconfiguration.sessionreplaysamplerate.md | 13 + ...ion.startsessionreplayrecordingmanually.md | 13 + ...rum-core.ruminitconfiguration.subdomain.md | 13 + ...initconfiguration.tracecontextinjection.md | 13 + ...re.ruminitconfiguration.tracesamplerate.md | 13 + ...onfiguration.trackfeatureflagsforevents.md | 13 + ...ore.ruminitconfiguration.tracklongtasks.md | 13 + ...ore.ruminitconfiguration.trackresources.md | 13 + ...initconfiguration.trackuserinteractions.md | 13 + ...ruminitconfiguration.trackviewsmanually.md | 13 + ...rum-core.ruminitconfiguration.workerurl.md | 13 + .../rum/browser-rum-core.rumlongtaskevent.md | 48 + ...-rum-core.rumlongtaskeventdomaincontext.md | 53 + ...taskeventdomaincontext.performanceentry.md | 11 + ...core.rumotherresourceeventdomaincontext.md | 53 + ...urceeventdomaincontext.performanceentry.md | 11 + ...rowser-rum-core.rumperformanceentrytype.md | 171 + ...ore.rumplugin.getconfigurationtelemetry.md | 15 + .../rum/browser-rum-core.rumplugin.md | 101 + .../rum/browser-rum-core.rumplugin.name.md | 11 + .../rum/browser-rum-core.rumplugin.oninit.md | 52 + .../browser-rum-core.rumplugin.onrumstart.md | 51 + ...browser-rum-core.rumpublicapi.addaction.md | 13 + ...-rum-core.rumpublicapi.adddurationvital.md | 18 + .../browser-rum-core.rumpublicapi.adderror.md | 13 + ...e.rumpublicapi.addfeatureflagevaluation.md | 13 + ...browser-rum-core.rumpublicapi.addtiming.md | 13 + ...wser-rum-core.rumpublicapi.clearaccount.md | 13 + ...um-core.rumpublicapi.clearglobalcontext.md | 15 + ...browser-rum-core.rumpublicapi.clearuser.md | 15 + ...rowser-rum-core.rumpublicapi.getaccount.md | 13 + ...-rum-core.rumpublicapi.getglobalcontext.md | 15 + ...-core.rumpublicapi.getinitconfiguration.md | 13 + ...um-core.rumpublicapi.getinternalcontext.md | 13 + ...-core.rumpublicapi.getsessionreplaylink.md | 15 + .../browser-rum-core.rumpublicapi.getuser.md | 15 + ...er-rum-core.rumpublicapi.getviewcontext.md | 13 + .../rum/browser-rum-core.rumpublicapi.init.md | 13 + .../rum/browser-rum-core.rumpublicapi.md | 748 ++ ...core.rumpublicapi.removeaccountproperty.md | 13 + ...umpublicapi.removeglobalcontextproperty.md | 15 + ...um-core.rumpublicapi.removeuserproperty.md | 15 + ...rowser-rum-core.rumpublicapi.setaccount.md | 13 + ...um-core.rumpublicapi.setaccountproperty.md | 13 + ...-rum-core.rumpublicapi.setglobalcontext.md | 13 + ...e.rumpublicapi.setglobalcontextproperty.md | 13 + ...um-core.rumpublicapi.settrackingconsent.md | 13 + .../browser-rum-core.rumpublicapi.setuser.md | 55 + ...browser-rum-core.rumpublicapi.setuser_1.md | 56 + ...r-rum-core.rumpublicapi.setuserproperty.md | 13 + ...er-rum-core.rumpublicapi.setviewcontext.md | 15 + ...ore.rumpublicapi.setviewcontextproperty.md | 15 + ...owser-rum-core.rumpublicapi.setviewname.md | 15 + ...um-core.rumpublicapi.startdurationvital.md | 18 + ...umpublicapi.startsessionreplayrecording.md | 15 + ...browser-rum-core.rumpublicapi.startview.md | 16 + ...rum-core.rumpublicapi.stopdurationvital.md | 16 + ...owser-rum-core.rumpublicapi.stopsession.md | 13 + ...rumpublicapi.stopsessionreplayrecording.md | 15 + .../rum/browser-rum-core.rumresourceevent.md | 89 + .../rum/browser-rum-core.rumsession.md | 17 + ...owser-rum-core.rumsessionmanager.expire.md | 11 + ...core.rumsessionmanager.expireobservable.md | 11 + ...re.rumsessionmanager.findtrackedsession.md | 11 + .../rum/browser-rum-core.rumsessionmanager.md | 104 + ...-core.rumsessionmanager.setforcedreplay.md | 11 + .../rum/browser-rum-core.rumviewevent.md | 143 + ...core.rumvieweventdomaincontext.location.md | 11 + ...wser-rum-core.rumvieweventdomaincontext.md | 53 + .../rum/browser-rum-core.rumvitalevent.md | 36 + ...esourceeventdomaincontext.handlingstack.md | 11 + ...xhrresourceeventdomaincontext.isaborted.md | 11 + ...m-core.rumxhrresourceeventdomaincontext.md | 108 + ...urceeventdomaincontext.performanceentry.md | 11 + ...re.rumxhrresourceeventdomaincontext.xhr.md | 11 + .../rum/browser-rum-core.sanitizedataurl.md | 49 + .../browser-rum-core.sessionreplaystate.md | 73 + .../browser-rum-core.shouldignoreelement.md | 51 + .../rum/browser-rum-core.shouldmasknode.md | 71 + .../rum/browser-rum-core.stable_attributes.md | 13 + ...er-rum-core.startrecordingoptions.force.md | 11 + .../browser-rum-core.startrecordingoptions.md | 53 + .../rum/browser-rum-core.startrum.md | 11 + .../rum/browser-rum-core.startviewhistory.md | 49 + ...rowser-rum-core.strategy.accountcontext.md | 11 + .../browser-rum-core.strategy.addaction.md | 11 + ...wser-rum-core.strategy.adddurationvital.md | 11 + .../rum/browser-rum-core.strategy.adderror.md | 11 + ...-core.strategy.addfeatureflagevaluation.md | 11 + .../browser-rum-core.strategy.addtiming.md | 11 + ...er-rum-core.strategy.getinternalcontext.md | 11 + ...rowser-rum-core.strategy.getviewcontext.md | 11 + ...browser-rum-core.strategy.globalcontext.md | 11 + .../rum/browser-rum-core.strategy.init.md | 11 + ...ser-rum-core.strategy.initconfiguration.md | 11 + .../rum/browser-rum-core.strategy.md | 359 + ...rowser-rum-core.strategy.setviewcontext.md | 11 + ...um-core.strategy.setviewcontextproperty.md | 11 + .../browser-rum-core.strategy.setviewname.md | 11 + ...er-rum-core.strategy.startdurationvital.md | 11 + .../browser-rum-core.strategy.startview.md | 11 + ...ser-rum-core.strategy.stopdurationvital.md | 11 + .../browser-rum-core.strategy.stopsession.md | 11 + .../browser-rum-core.strategy.usercontext.md | 11 + ...-rum-core.supportperformancetimingevent.md | 49 + ...owser-rum-core.viewcreatedevent.context.md | 11 + .../browser-rum-core.viewcreatedevent.id.md | 11 + .../rum/browser-rum-core.viewcreatedevent.md | 146 + .../browser-rum-core.viewcreatedevent.name.md | 11 + ...owser-rum-core.viewcreatedevent.service.md | 11 + ...r-rum-core.viewcreatedevent.startclocks.md | 11 + ...owser-rum-core.viewcreatedevent.version.md | 11 + .../browser-rum-core.viewhistory.findview.md | 11 + .../rum/browser-rum-core.viewhistory.md | 70 + .../rum/browser-rum-core.viewhistory.stop.md | 11 + ...owser-rum-core.viewhistoryentry.context.md | 11 + .../browser-rum-core.viewhistoryentry.id.md | 11 + .../rum/browser-rum-core.viewhistoryentry.md | 165 + .../browser-rum-core.viewhistoryentry.name.md | 11 + ...owser-rum-core.viewhistoryentry.service.md | 11 + ...m-core.viewhistoryentry.sessionisactive.md | 11 + ...r-rum-core.viewhistoryentry.startclocks.md | 11 + ...owser-rum-core.viewhistoryentry.version.md | 11 + ...owser-rum-core.viewportdimension.height.md | 11 + .../rum/browser-rum-core.viewportdimension.md | 70 + ...rowser-rum-core.viewportdimension.width.md | 11 + .../rum/browser-rum-react.reactplugin.md | 2 +- docs/api-reference/rum/index.md | 9 + etc/browser-rum-core.api.json | 10481 ++++++++++++++++ package.json | 3 +- packages/rum-core/api-extractor.json | 35 + 276 files changed, 21047 insertions(+), 2 deletions(-) create mode 100644 docs/api-reference/rum/browser-rum-core.actiontype.md create mode 100644 docs/api-reference/rum/browser-rum-core.censored_img_mark.md create mode 100644 docs/api-reference/rum/browser-rum-core.censored_string_mark.md create mode 100644 docs/api-reference/rum/browser-rum-core.censortext.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties._dd.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.account.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.application.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.context.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.date.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.device.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.display.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.os.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.service.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.session.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.source.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.usr.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.version.md create mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.view.md create mode 100644 docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md create mode 100644 docs/api-reference/rum/browser-rum-core.foreachchildnodes.md create mode 100644 docs/api-reference/rum/browser-rum-core.form_private_tag_names.md create mode 100644 docs/api-reference/rum/browser-rum-core.frustrationtype.md create mode 100644 docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md create mode 100644 docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.getparentnode.md create mode 100644 docs/api-reference/rum/browser-rum-core.getprivacyselector.md create mode 100644 docs/api-reference/rum/browser-rum-core.getscrollx.md create mode 100644 docs/api-reference/rum/browser-rum-core.getscrolly.md create mode 100644 docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md create mode 100644 docs/api-reference/rum/browser-rum-core.gettextcontent.md create mode 100644 docs/api-reference/rum/browser-rum-core.getviewportdimension.md create mode 100644 docs/api-reference/rum/browser-rum-core.haschildnodes.md create mode 100644 docs/api-reference/rum/browser-rum-core.initviewportobservable.md create mode 100644 docs/api-reference/rum/browser-rum-core.iscommentnode.md create mode 100644 docs/api-reference/rum/browser-rum-core.iselementnode.md create mode 100644 docs/api-reference/rum/browser-rum-core.islongdataurl.md create mode 100644 docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md create mode 100644 docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md create mode 100644 docs/api-reference/rum/browser-rum-core.istextnode.md create mode 100644 docs/api-reference/rum/browser-rum-core.lifecycle.md create mode 100644 docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md create mode 100644 docs/api-reference/rum/browser-rum-core.makerumpublicapi.md create mode 100644 docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md create mode 100644 docs/api-reference/rum/browser-rum-core.md create mode 100644 docs/api-reference/rum/browser-rum-core.mouseeventonelement.md create mode 100644 docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_name.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md create mode 100644 docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md create mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.md create mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md create mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.stop.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.start.md create mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.stop.md create mode 100644 docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.md create mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.records_count.md create mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md create mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumactionevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumerrorevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumeventtype.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md create mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.name.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumresourceevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsession.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumviewevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumvitalevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md create mode 100644 docs/api-reference/rum/browser-rum-core.sanitizedataurl.md create mode 100644 docs/api-reference/rum/browser-rum-core.sessionreplaystate.md create mode 100644 docs/api-reference/rum/browser-rum-core.shouldignoreelement.md create mode 100644 docs/api-reference/rum/browser-rum-core.shouldmasknode.md create mode 100644 docs/api-reference/rum/browser-rum-core.stable_attributes.md create mode 100644 docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md create mode 100644 docs/api-reference/rum/browser-rum-core.startrecordingoptions.md create mode 100644 docs/api-reference/rum/browser-rum-core.startrum.md create mode 100644 docs/api-reference/rum/browser-rum-core.startviewhistory.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addaction.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.adderror.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addtiming.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.init.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewname.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.startview.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.stopsession.md create mode 100644 docs/api-reference/rum/browser-rum-core.strategy.usercontext.md create mode 100644 docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.findview.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.stop.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.height.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.md create mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.width.md create mode 100644 etc/browser-rum-core.api.json create mode 100644 packages/rum-core/api-extractor.json diff --git a/docs/api-reference/rum/browser-rum-core.actiontype.md b/docs/api-reference/rum/browser-rum-core.actiontype.md new file mode 100644 index 0000000000..ed5792175a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.actiontype.md @@ -0,0 +1,59 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ActionType](./browser-rum-core.actiontype.md) + +## ActionType enum + +**Signature:** + +```typescript +export declare const enum ActionType +``` + +## Enumeration Members + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +CLICK + + + + +`"click"` + + + + + +
+ +CUSTOM + + + + +`"custom"` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.censored_img_mark.md b/docs/api-reference/rum/browser-rum-core.censored_img_mark.md new file mode 100644 index 0000000000..93979ea541 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.censored_img_mark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CENSORED\_IMG\_MARK](./browser-rum-core.censored_img_mark.md) + +## CENSORED\_IMG\_MARK variable + +**Signature:** + +```typescript +CENSORED_IMG_MARK = "data:image/gif;base64,R0lGODlhAQABAIAAAMLCwgAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" +``` diff --git a/docs/api-reference/rum/browser-rum-core.censored_string_mark.md b/docs/api-reference/rum/browser-rum-core.censored_string_mark.md new file mode 100644 index 0000000000..e6da7ef5da --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.censored_string_mark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CENSORED\_STRING\_MARK](./browser-rum-core.censored_string_mark.md) + +## CENSORED\_STRING\_MARK variable + +**Signature:** + +```typescript +CENSORED_STRING_MARK = "***" +``` diff --git a/docs/api-reference/rum/browser-rum-core.censortext.md b/docs/api-reference/rum/browser-rum-core.censortext.md new file mode 100644 index 0000000000..43eb80dc24 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.censortext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [censorText](./browser-rum-core.censortext.md) + +## censorText variable + +Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay. + +**Signature:** + +```typescript +censorText: (text: string) => string +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties._dd.md b/docs/api-reference/rum/browser-rum-core.commonproperties._dd.md new file mode 100644 index 0000000000..db25b545fc --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties._dd.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [\_dd](./browser-rum-core.commonproperties._dd.md) + +## CommonProperties.\_dd property + +Internal properties + +**Signature:** + +```typescript +readonly _dd: { + readonly format_version: 2; + session?: { + plan?: 1 | 2; + readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; + [k: string]: unknown; + }; + readonly configuration?: { + readonly session_sample_rate: number; + readonly session_replay_sample_rate?: number; + [k: string]: unknown; + }; + readonly browser_sdk_version?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.account.md b/docs/api-reference/rum/browser-rum-core.commonproperties.account.md new file mode 100644 index 0000000000..ddc8c60fa7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.account.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [account](./browser-rum-core.commonproperties.account.md) + +## CommonProperties.account property + +Account properties + +**Signature:** + +```typescript +readonly account?: { + readonly id: string; + readonly name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.application.md b/docs/api-reference/rum/browser-rum-core.commonproperties.application.md new file mode 100644 index 0000000000..92bb87c321 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.application.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [application](./browser-rum-core.commonproperties.application.md) + +## CommonProperties.application property + +Application properties + +**Signature:** + +```typescript +readonly application: { + readonly id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md b/docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md new file mode 100644 index 0000000000..3e205fc861 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [build\_id](./browser-rum-core.commonproperties.build_id.md) + +## CommonProperties.build\_id property + +Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + +**Signature:** + +```typescript +readonly build_id?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md b/docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md new file mode 100644 index 0000000000..5a88e2289a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [build\_version](./browser-rum-core.commonproperties.build_version.md) + +## CommonProperties.build\_version property + +The build version for this application + +**Signature:** + +```typescript +readonly build_version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md b/docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md new file mode 100644 index 0000000000..634db42391 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [ci\_test](./browser-rum-core.commonproperties.ci_test.md) + +## CommonProperties.ci\_test property + +CI Visibility properties + +**Signature:** + +```typescript +readonly ci_test?: { + readonly test_execution_id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md b/docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md new file mode 100644 index 0000000000..2a631c1683 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [connectivity](./browser-rum-core.commonproperties.connectivity.md) + +## CommonProperties.connectivity property + +Device connectivity properties + +**Signature:** + +```typescript +connectivity?: { + readonly status: 'connected' | 'not_connected' | 'maybe'; + readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; + readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; + readonly cellular?: { + readonly technology?: string; + readonly carrier_name?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.context.md b/docs/api-reference/rum/browser-rum-core.commonproperties.context.md new file mode 100644 index 0000000000..770e808832 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.context.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [context](./browser-rum-core.commonproperties.context.md) + +## CommonProperties.context property + +User provided context + +**Signature:** + +```typescript +context?: { + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.date.md b/docs/api-reference/rum/browser-rum-core.commonproperties.date.md new file mode 100644 index 0000000000..f5aebf2540 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [date](./browser-rum-core.commonproperties.date.md) + +## CommonProperties.date property + +Start of the event in ms from epoch + +**Signature:** + +```typescript +readonly date: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.device.md b/docs/api-reference/rum/browser-rum-core.commonproperties.device.md new file mode 100644 index 0000000000..27f04acb3c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.device.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [device](./browser-rum-core.commonproperties.device.md) + +## CommonProperties.device property + +Device properties + +**Signature:** + +```typescript +device?: { + readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; + readonly name?: string; + readonly model?: string; + readonly brand?: string; + readonly architecture?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.display.md b/docs/api-reference/rum/browser-rum-core.commonproperties.display.md new file mode 100644 index 0000000000..9a319fe7b0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.display.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [display](./browser-rum-core.commonproperties.display.md) + +## CommonProperties.display property + +Display properties + +**Signature:** + +```typescript +display?: { + readonly viewport?: { + readonly width: number; + readonly height: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.md b/docs/api-reference/rum/browser-rum-core.commonproperties.md new file mode 100644 index 0000000000..acd5e5aea2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.md @@ -0,0 +1,423 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) + +## CommonProperties interface + +Schema of common properties of RUM events + +**Signature:** + +```typescript +export interface CommonProperties +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[\_dd](./browser-rum-core.commonproperties._dd.md) + + + + +`readonly` + + + + +{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } + + + + +Internal properties + + +
+ +[account?](./browser-rum-core.commonproperties.account.md) + + + + +`readonly` + + + + +{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Account properties + + +
+ +[application](./browser-rum-core.commonproperties.application.md) + + + + +`readonly` + + + + +{ readonly id: string; \[k: string\]: unknown; } + + + + +Application properties + + +
+ +[build\_id?](./browser-rum-core.commonproperties.build_id.md) + + + + +`readonly` + + + + +string + + + + +_(Optional)_ Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + + +
+ +[build\_version?](./browser-rum-core.commonproperties.build_version.md) + + + + +`readonly` + + + + +string + + + + +_(Optional)_ The build version for this application + + +
+ +[ci\_test?](./browser-rum-core.commonproperties.ci_test.md) + + + + +`readonly` + + + + +{ readonly test\_execution\_id: string; \[k: string\]: unknown; } + + + + +_(Optional)_ CI Visibility properties + + +
+ +[connectivity?](./browser-rum-core.commonproperties.connectivity.md) + + + + + + + +{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + + +_(Optional)_ Device connectivity properties + + +
+ +[context?](./browser-rum-core.commonproperties.context.md) + + + + + + + +{ \[k: string\]: unknown; } + + + + +_(Optional)_ User provided context + + +
+ +[date](./browser-rum-core.commonproperties.date.md) + + + + +`readonly` + + + + +number + + + + +Start of the event in ms from epoch + + +
+ +[device?](./browser-rum-core.commonproperties.device.md) + + + + + + + +{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Device properties + + +
+ +[display?](./browser-rum-core.commonproperties.display.md) + + + + + + + +{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + + +_(Optional)_ Display properties + + +
+ +[os?](./browser-rum-core.commonproperties.os.md) + + + + + + + +{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Operating system properties + + +
+ +[service?](./browser-rum-core.commonproperties.service.md) + + + + + + + +string + + + + +_(Optional)_ The service name for this application + + +
+ +[session](./browser-rum-core.commonproperties.session.md) + + + + +`readonly` + + + + +{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } + + + + +Session properties + + +
+ +[source?](./browser-rum-core.commonproperties.source.md) + + + + +`readonly` + + + + +'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' + + + + +_(Optional)_ The source of this event + + +
+ +[synthetics?](./browser-rum-core.commonproperties.synthetics.md) + + + + +`readonly` + + + + +{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } + + + + +_(Optional)_ Synthetics properties + + +
+ +[usr?](./browser-rum-core.commonproperties.usr.md) + + + + +`readonly` + + + + +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ User properties + + +
+ +[version?](./browser-rum-core.commonproperties.version.md) + + + + + + + +string + + + + +_(Optional)_ The version for this application + + +
+ +[view](./browser-rum-core.commonproperties.view.md) + + + + +`readonly` + + + + +{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } + + + + +View properties + + +
diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.os.md b/docs/api-reference/rum/browser-rum-core.commonproperties.os.md new file mode 100644 index 0000000000..23631540c9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.os.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [os](./browser-rum-core.commonproperties.os.md) + +## CommonProperties.os property + +Operating system properties + +**Signature:** + +```typescript +os?: { + readonly name: string; + readonly version: string; + readonly build?: string; + readonly version_major: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.service.md b/docs/api-reference/rum/browser-rum-core.commonproperties.service.md new file mode 100644 index 0000000000..c94b7337cf --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.service.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [service](./browser-rum-core.commonproperties.service.md) + +## CommonProperties.service property + +The service name for this application + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.session.md b/docs/api-reference/rum/browser-rum-core.commonproperties.session.md new file mode 100644 index 0000000000..4a3a9ed3b3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.session.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [session](./browser-rum-core.commonproperties.session.md) + +## CommonProperties.session property + +Session properties + +**Signature:** + +```typescript +readonly session: { + readonly id: string; + readonly type: 'user' | 'synthetics' | 'ci_test'; + readonly has_replay?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.source.md b/docs/api-reference/rum/browser-rum-core.commonproperties.source.md new file mode 100644 index 0000000000..a4615148d5 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.source.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [source](./browser-rum-core.commonproperties.source.md) + +## CommonProperties.source property + +The source of this event + +**Signature:** + +```typescript +readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md b/docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md new file mode 100644 index 0000000000..42c396f1d6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [synthetics](./browser-rum-core.commonproperties.synthetics.md) + +## CommonProperties.synthetics property + +Synthetics properties + +**Signature:** + +```typescript +readonly synthetics?: { + readonly test_id: string; + readonly result_id: string; + readonly injected?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.usr.md b/docs/api-reference/rum/browser-rum-core.commonproperties.usr.md new file mode 100644 index 0000000000..90855a51fe --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.usr.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [usr](./browser-rum-core.commonproperties.usr.md) + +## CommonProperties.usr property + +User properties + +**Signature:** + +```typescript +readonly usr?: { + readonly id?: string; + readonly name?: string; + readonly email?: string; + readonly anonymous_id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.version.md b/docs/api-reference/rum/browser-rum-core.commonproperties.version.md new file mode 100644 index 0000000000..92d4a79663 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.version.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [version](./browser-rum-core.commonproperties.version.md) + +## CommonProperties.version property + +The version for this application + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.view.md b/docs/api-reference/rum/browser-rum-core.commonproperties.view.md new file mode 100644 index 0000000000..ab9a214e39 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.commonproperties.view.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [view](./browser-rum-core.commonproperties.view.md) + +## CommonProperties.view property + +View properties + +**Signature:** + +```typescript +readonly view: { + readonly id: string; + referrer?: string; + url: string; + name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md b/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md new file mode 100644 index 0000000000..8c611e7bdb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE](./browser-rum-core.default_programmatic_action_name_attribute.md) + +## DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE variable + +Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute. + +**Signature:** + +```typescript +DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE = "data-dd-action-name" +``` diff --git a/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md b/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md new file mode 100644 index 0000000000..7a2fc81e49 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [forEachChildNodes](./browser-rum-core.foreachchildnodes.md) + +## forEachChildNodes() function + +**Signature:** + +```typescript +export declare function forEachChildNodes(node: Node, callback: (child: Node) => void): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+ +callback + + + + +(child: Node) => void + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md b/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md new file mode 100644 index 0000000000..fc38cf2337 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [FORM\_PRIVATE\_TAG\_NAMES](./browser-rum-core.form_private_tag_names.md) + +## FORM\_PRIVATE\_TAG\_NAMES variable + +**Signature:** + +```typescript +FORM_PRIVATE_TAG_NAMES: { + [tagName: string]: true; +} +``` diff --git a/docs/api-reference/rum/browser-rum-core.frustrationtype.md b/docs/api-reference/rum/browser-rum-core.frustrationtype.md new file mode 100644 index 0000000000..a2311dd543 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.frustrationtype.md @@ -0,0 +1,73 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [FrustrationType](./browser-rum-core.frustrationtype.md) + +## FrustrationType enum + +**Signature:** + +```typescript +export declare const enum FrustrationType +``` + +## Enumeration Members + + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +DEAD\_CLICK + + + + +`"dead_click"` + + + + + +
+ +ERROR\_CLICK + + + + +`"error_click"` + + + + + +
+ +RAGE\_CLICK + + + + +`"rage_click"` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md b/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md new file mode 100644 index 0000000000..b1d1f9b80a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getMutationObserverConstructor](./browser-rum-core.getmutationobserverconstructor.md) + +## getMutationObserverConstructor() function + +**Signature:** + +```typescript +export declare function getMutationObserverConstructor(): MutationObserverConstructor | undefined; +``` +**Returns:** + +MutationObserverConstructor \| undefined + diff --git a/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md b/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md new file mode 100644 index 0000000000..65e28696a7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md @@ -0,0 +1,83 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getNodePrivacyLevel](./browser-rum-core.getnodeprivacylevel.md) + +## getNodePrivacyLevel() function + +Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like: + +derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel) + +**Signature:** + +```typescript +export declare function getNodePrivacyLevel(node: Node, defaultPrivacyLevel: NodePrivacyLevel, cache?: NodePrivacyLevelCache): NodePrivacyLevel; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+ +defaultPrivacyLevel + + + + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+ +cache + + + + +[NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) + + + + +_(Optional)_ + + +
+**Returns:** + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + diff --git a/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md b/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md new file mode 100644 index 0000000000..ee6971a8ad --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getNodeSelfPrivacyLevel](./browser-rum-core.getnodeselfprivacylevel.md) + +## getNodeSelfPrivacyLevel() function + +Determines the node's own privacy level without checking for ancestors. + +**Signature:** + +```typescript +export declare function getNodeSelfPrivacyLevel(node: Node): NodePrivacyLevel | undefined; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) \| undefined + diff --git a/docs/api-reference/rum/browser-rum-core.getparentnode.md b/docs/api-reference/rum/browser-rum-core.getparentnode.md new file mode 100644 index 0000000000..8800c30ede --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getparentnode.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getParentNode](./browser-rum-core.getparentnode.md) + +## getParentNode() function + +Return `host` in case if the current node is a shadow root otherwise will return the `parentNode` + +**Signature:** + +```typescript +export declare function getParentNode(node: Node): Node | null; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +Node \| null + diff --git a/docs/api-reference/rum/browser-rum-core.getprivacyselector.md b/docs/api-reference/rum/browser-rum-core.getprivacyselector.md new file mode 100644 index 0000000000..df69f4035c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getprivacyselector.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getPrivacySelector](./browser-rum-core.getprivacyselector.md) + +## getPrivacySelector() function + +**Signature:** + +```typescript +export declare function getPrivacySelector(privacyLevel: string): string; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +privacyLevel + + + + +string + + + + + +
+**Returns:** + +string + diff --git a/docs/api-reference/rum/browser-rum-core.getscrollx.md b/docs/api-reference/rum/browser-rum-core.getscrollx.md new file mode 100644 index 0000000000..62782c0a62 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getscrollx.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getScrollX](./browser-rum-core.getscrollx.md) + +## getScrollX() function + +**Signature:** + +```typescript +export declare function getScrollX(): number; +``` +**Returns:** + +number + diff --git a/docs/api-reference/rum/browser-rum-core.getscrolly.md b/docs/api-reference/rum/browser-rum-core.getscrolly.md new file mode 100644 index 0000000000..90fe5b6d2b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getscrolly.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getScrollY](./browser-rum-core.getscrolly.md) + +## getScrollY() function + +**Signature:** + +```typescript +export declare function getScrollY(): number; +``` +**Returns:** + +number + diff --git a/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md b/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md new file mode 100644 index 0000000000..5a9f0f5b40 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md @@ -0,0 +1,67 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getSessionReplayUrl](./browser-rum-core.getsessionreplayurl.md) + +## getSessionReplayUrl() function + +**Signature:** + +```typescript +export declare function getSessionReplayUrl(configuration: RumConfiguration, { session, viewContext, errorType, }: { + session?: RumSession; + viewContext?: ViewHistoryEntry; + errorType?: string; +}): string; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +configuration + + + + +[RumConfiguration](./browser-rum-core.rumconfiguration.md) + + + + + +
+ +{ session, viewContext, errorType, } + + + + +{ session?: [RumSession](./browser-rum-core.rumsession.md); viewContext?: [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md); errorType?: string; } + + + + + +
+**Returns:** + +string + diff --git a/docs/api-reference/rum/browser-rum-core.gettextcontent.md b/docs/api-reference/rum/browser-rum-core.gettextcontent.md new file mode 100644 index 0000000000..673ae1c4c7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.gettextcontent.md @@ -0,0 +1,77 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getTextContent](./browser-rum-core.gettextcontent.md) + +## getTextContent() function + +**Signature:** + +```typescript +export declare function getTextContent(textNode: Node, ignoreWhiteSpace: boolean, parentNodePrivacyLevel: NodePrivacyLevel): string | undefined; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +textNode + + + + +Node + + + + + +
+ +ignoreWhiteSpace + + + + +boolean + + + + + +
+ +parentNodePrivacyLevel + + + + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+**Returns:** + +string \| undefined + diff --git a/docs/api-reference/rum/browser-rum-core.getviewportdimension.md b/docs/api-reference/rum/browser-rum-core.getviewportdimension.md new file mode 100644 index 0000000000..c2539d8cb4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.getviewportdimension.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getViewportDimension](./browser-rum-core.getviewportdimension.md) + +## getViewportDimension() function + +**Signature:** + +```typescript +export declare function getViewportDimension(): ViewportDimension; +``` +**Returns:** + +[ViewportDimension](./browser-rum-core.viewportdimension.md) + diff --git a/docs/api-reference/rum/browser-rum-core.haschildnodes.md b/docs/api-reference/rum/browser-rum-core.haschildnodes.md new file mode 100644 index 0000000000..51d4ad16c0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.haschildnodes.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [hasChildNodes](./browser-rum-core.haschildnodes.md) + +## hasChildNodes() function + +**Signature:** + +```typescript +export declare function hasChildNodes(node: Node): boolean; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +boolean + diff --git a/docs/api-reference/rum/browser-rum-core.initviewportobservable.md b/docs/api-reference/rum/browser-rum-core.initviewportobservable.md new file mode 100644 index 0000000000..4287b90a43 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.initviewportobservable.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [initViewportObservable](./browser-rum-core.initviewportobservable.md) + +## initViewportObservable() function + +**Signature:** + +```typescript +export declare function initViewportObservable(configuration: RumConfiguration): Observable; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +configuration + + + + +[RumConfiguration](./browser-rum-core.rumconfiguration.md) + + + + + +
+**Returns:** + +Observable<[ViewportDimension](./browser-rum-core.viewportdimension.md)> + diff --git a/docs/api-reference/rum/browser-rum-core.iscommentnode.md b/docs/api-reference/rum/browser-rum-core.iscommentnode.md new file mode 100644 index 0000000000..75ede411d3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.iscommentnode.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isCommentNode](./browser-rum-core.iscommentnode.md) + +## isCommentNode() function + +**Signature:** + +```typescript +export declare function isCommentNode(node: Node): node is Comment; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +node is Comment + diff --git a/docs/api-reference/rum/browser-rum-core.iselementnode.md b/docs/api-reference/rum/browser-rum-core.iselementnode.md new file mode 100644 index 0000000000..6a544cc3a0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.iselementnode.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isElementNode](./browser-rum-core.iselementnode.md) + +## isElementNode() function + +**Signature:** + +```typescript +export declare function isElementNode(node: Node): node is Element; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +node is Element + diff --git a/docs/api-reference/rum/browser-rum-core.islongdataurl.md b/docs/api-reference/rum/browser-rum-core.islongdataurl.md new file mode 100644 index 0000000000..b8cd5f3319 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.islongdataurl.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isLongDataUrl](./browser-rum-core.islongdataurl.md) + +## isLongDataUrl() function + +**Signature:** + +```typescript +export declare function isLongDataUrl(url: string): boolean; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + + +
+**Returns:** + +boolean + diff --git a/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md b/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md new file mode 100644 index 0000000000..d817219900 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isNodeShadowHost](./browser-rum-core.isnodeshadowhost.md) + +## isNodeShadowHost() function + +**Signature:** + +```typescript +export declare function isNodeShadowHost(node: Node): node is Element & { + shadowRoot: ShadowRoot; +}; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +node is Element & { shadowRoot: ShadowRoot; } + diff --git a/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md b/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md new file mode 100644 index 0000000000..7126b5e861 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isNodeShadowRoot](./browser-rum-core.isnodeshadowroot.md) + +## isNodeShadowRoot() function + +**Signature:** + +```typescript +export declare function isNodeShadowRoot(node: Node): node is ShadowRoot; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +node is ShadowRoot + diff --git a/docs/api-reference/rum/browser-rum-core.istextnode.md b/docs/api-reference/rum/browser-rum-core.istextnode.md new file mode 100644 index 0000000000..412a1d7f1b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.istextnode.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isTextNode](./browser-rum-core.istextnode.md) + +## isTextNode() function + +**Signature:** + +```typescript +export declare function isTextNode(node: Node): node is Text; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+**Returns:** + +node is Text + diff --git a/docs/api-reference/rum/browser-rum-core.lifecycle.md b/docs/api-reference/rum/browser-rum-core.lifecycle.md new file mode 100644 index 0000000000..df6556da24 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.lifecycle.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [LifeCycle](./browser-rum-core.lifecycle.md) + +## LifeCycle variable + +**Signature:** + +```typescript +LifeCycle: { + new (): AbstractLifeCycle; +} +``` diff --git a/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md b/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md new file mode 100644 index 0000000000..7a7dae6941 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md @@ -0,0 +1,241 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [LifeCycleEventType](./browser-rum-core.lifecycleeventtype.md) + +## LifeCycleEventType enum + +**Signature:** + +```typescript +export declare const enum LifeCycleEventType +``` + +## Enumeration Members + + + + + + + + + + + + + + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +AFTER\_VIEW\_ENDED + + + + +`6` + + + + + +
+ +AUTO\_ACTION\_COMPLETED + + + + +`0` + + + + + +
+ +BEFORE\_VIEW\_CREATED + + + + +`1` + + + + + +
+ +BEFORE\_VIEW\_UPDATED + + + + +`3` + + + + + +
+ +PAGE\_MAY\_EXIT + + + + +`11` + + + + + +
+ +RAW\_ERROR\_COLLECTED + + + + +`14` + + + + + +
+ +RAW\_RUM\_EVENT\_COLLECTED + + + + +`12` + + + + + +
+ +REQUEST\_COMPLETED + + + + +`8` + + + + + +
+ +REQUEST\_STARTED + + + + +`7` + + + + + +
+ +RUM\_EVENT\_COLLECTED + + + + +`13` + + + + + +
+ +SESSION\_EXPIRED + + + + +`9` + + + + + +
+ +SESSION\_RENEWED + + + + +`10` + + + + + +
+ +VIEW\_CREATED + + + + +`2` + + + + + +
+ +VIEW\_ENDED + + + + +`5` + + + + + +
+ +VIEW\_UPDATED + + + + +`4` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md b/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md new file mode 100644 index 0000000000..f7bde104be --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md @@ -0,0 +1,93 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [makeRumPublicApi](./browser-rum-core.makerumpublicapi.md) + +## makeRumPublicApi() function + +**Signature:** + +```typescript +export declare function makeRumPublicApi(startRumImpl: StartRum, recorderApi: RecorderApi, profilerApi: ProfilerApi, options?: RumPublicApiOptions): RumPublicApi; +``` + +## Parameters + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startRumImpl + + + + +[StartRum](./browser-rum-core.startrum.md) + + + + + +
+ +recorderApi + + + + +[RecorderApi](./browser-rum-core.recorderapi.md) + + + + + +
+ +profilerApi + + + + +[ProfilerApi](./browser-rum-core.profilerapi.md) + + + + + +
+ +options + + + + +RumPublicApiOptions + + + + +_(Optional)_ + + +
+**Returns:** + +[RumPublicApi](./browser-rum-core.rumpublicapi.md) + diff --git a/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md b/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md new file mode 100644 index 0000000000..f72d2e65b0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH](./browser-rum-core.max_attribute_value_char_length.md) + +## MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH variable + +**Signature:** + +```typescript +MAX_ATTRIBUTE_VALUE_CHAR_LENGTH = 24000 +``` diff --git a/docs/api-reference/rum/browser-rum-core.md b/docs/api-reference/rum/browser-rum-core.md new file mode 100644 index 0000000000..f7076ae486 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.md @@ -0,0 +1,905 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) + +## browser-rum-core package + +## Enumerations + + + + + + + + +
+ +Enumeration + + + + +Description + + +
+ +[ActionType](./browser-rum-core.actiontype.md) + + + + + +
+ +[FrustrationType](./browser-rum-core.frustrationtype.md) + + + + + +
+ +[LifeCycleEventType](./browser-rum-core.lifecycleeventtype.md) + + + + + +
+ +[RumEventType](./browser-rum-core.rumeventtype.md) + + + + + +
+ +[RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) + + + + + +
+ +[SessionReplayState](./browser-rum-core.sessionreplaystate.md) + + + + + +
+ +## Functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Function + + + + +Description + + +
+ +[forEachChildNodes(node, callback)](./browser-rum-core.foreachchildnodes.md) + + + + + +
+ +[getMutationObserverConstructor()](./browser-rum-core.getmutationobserverconstructor.md) + + + + + +
+ +[getNodePrivacyLevel(node, defaultPrivacyLevel, cache)](./browser-rum-core.getnodeprivacylevel.md) + + + + +Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like: + +derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel) + + +
+ +[getNodeSelfPrivacyLevel(node)](./browser-rum-core.getnodeselfprivacylevel.md) + + + + +Determines the node's own privacy level without checking for ancestors. + + +
+ +[getParentNode(node)](./browser-rum-core.getparentnode.md) + + + + +Return `host` in case if the current node is a shadow root otherwise will return the `parentNode` + + +
+ +[getPrivacySelector(privacyLevel)](./browser-rum-core.getprivacyselector.md) + + + + + +
+ +[getScrollX()](./browser-rum-core.getscrollx.md) + + + + + +
+ +[getScrollY()](./browser-rum-core.getscrolly.md) + + + + + +
+ +[getSessionReplayUrl(configuration, { session, viewContext, errorType, })](./browser-rum-core.getsessionreplayurl.md) + + + + + +
+ +[getTextContent(textNode, ignoreWhiteSpace, parentNodePrivacyLevel)](./browser-rum-core.gettextcontent.md) + + + + + +
+ +[getViewportDimension()](./browser-rum-core.getviewportdimension.md) + + + + + +
+ +[hasChildNodes(node)](./browser-rum-core.haschildnodes.md) + + + + + +
+ +[initViewportObservable(configuration)](./browser-rum-core.initviewportobservable.md) + + + + + +
+ +[isCommentNode(node)](./browser-rum-core.iscommentnode.md) + + + + + +
+ +[isElementNode(node)](./browser-rum-core.iselementnode.md) + + + + + +
+ +[isLongDataUrl(url)](./browser-rum-core.islongdataurl.md) + + + + + +
+ +[isNodeShadowHost(node)](./browser-rum-core.isnodeshadowhost.md) + + + + + +
+ +[isNodeShadowRoot(node)](./browser-rum-core.isnodeshadowroot.md) + + + + + +
+ +[isTextNode(node)](./browser-rum-core.istextnode.md) + + + + + +
+ +[makeRumPublicApi(startRumImpl, recorderApi, profilerApi, options)](./browser-rum-core.makerumpublicapi.md) + + + + + +
+ +[reducePrivacyLevel(childPrivacyLevel, parentNodePrivacyLevel)](./browser-rum-core.reduceprivacylevel.md) + + + + +Reduces the next privacy level based on self + parent privacy levels + + +
+ +[sanitizeDataUrl(url)](./browser-rum-core.sanitizedataurl.md) + + + + + +
+ +[shouldIgnoreElement(element)](./browser-rum-core.shouldignoreelement.md) + + + + +TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag. + + +
+ +[shouldMaskNode(node, privacyLevel)](./browser-rum-core.shouldmasknode.md) + + + + +Helper aiming to unify `mask` and `mask-user-input` privacy levels: + +In the `mask` case, it is trivial: we should mask the element. + +In the `mask-user-input` case, we should mask the element only if it is a "form" element or the direct parent is a form element for text nodes). + +Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized). + + +
+ +[startRum(configuration, recorderApi, profilerApi, initialViewOptions, createEncoder, trackingConsentState, customVitalsState)](./browser-rum-core.startrum.md) + + + + + +
+ +[startViewHistory(lifeCycle)](./browser-rum-core.startviewhistory.md) + + + + + +
+ +[supportPerformanceTimingEvent(entryType)](./browser-rum-core.supportperformancetimingevent.md) + + + + + +
+ +## Interfaces + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[CommonProperties](./browser-rum-core.commonproperties.md) + + + + +Schema of common properties of RUM events + + +
+ +[ProfilerApi](./browser-rum-core.profilerapi.md) + + + + + +
+ +[RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) + + + + + +
+ +[RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) + + + + + +
+ +[RecorderApi](./browser-rum-core.recorderapi.md) + + + + + +
+ +[ReplayStats](./browser-rum-core.replaystats.md) + + + + + +
+ +[RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) + + + + + +
+ +[RumConfiguration](./browser-rum-core.rumconfiguration.md) + + + + + +
+ +[RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) + + + + + +
+ +[RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) + + + + + +
+ +[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) + + + + + +
+ +[RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) + + + + + +
+ +[RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) + + + + + +
+ +[RumPlugin](./browser-rum-core.rumplugin.md) + + + + + +
+ +[RumPublicApi](./browser-rum-core.rumpublicapi.md) + + + + + +
+ +[RumSessionManager](./browser-rum-core.rumsessionmanager.md) + + + + + +
+ +[RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) + + + + + +
+ +[RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) + + + + + +
+ +[StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) + + + + + +
+ +[Strategy](./browser-rum-core.strategy.md) + + + + + +
+ +[ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) + + + + + +
+ +[ViewHistory](./browser-rum-core.viewhistory.md) + + + + + +
+ +[ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) + + + + + +
+ +[ViewportDimension](./browser-rum-core.viewportdimension.md) + + + + + +
+ +## Variables + + + + + + + + + + + + + + + + + +
+ +Variable + + + + +Description + + +
+ +[CENSORED\_IMG\_MARK](./browser-rum-core.censored_img_mark.md) + + + + + +
+ +[CENSORED\_STRING\_MARK](./browser-rum-core.censored_string_mark.md) + + + + + +
+ +[censorText](./browser-rum-core.censortext.md) + + + + +Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay. + + +
+ +[DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE](./browser-rum-core.default_programmatic_action_name_attribute.md) + + + + +Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute. + + +
+ +[FORM\_PRIVATE\_TAG\_NAMES](./browser-rum-core.form_private_tag_names.md) + + + + + +
+ +[LifeCycle](./browser-rum-core.lifecycle.md) + + + + + +
+ +[MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH](./browser-rum-core.max_attribute_value_char_length.md) + + + + + +
+ +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+ +[PRIVACY\_ATTR\_NAME](./browser-rum-core.privacy_attr_name.md) + + + + + +
+ +[PRIVACY\_ATTR\_VALUE\_ALLOW](./browser-rum-core.privacy_attr_value_allow.md) + + + + + +
+ +[PRIVACY\_ATTR\_VALUE\_HIDDEN](./browser-rum-core.privacy_attr_value_hidden.md) + + + + + +
+ +[PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT](./browser-rum-core.privacy_attr_value_mask_user_input.md) + + + + + +
+ +[PRIVACY\_ATTR\_VALUE\_MASK](./browser-rum-core.privacy_attr_value_mask.md) + + + + + +
+ +[PRIVACY\_CLASS\_PREFIX](./browser-rum-core.privacy_class_prefix.md) + + + + + +
+ +[STABLE\_ATTRIBUTES](./browser-rum-core.stable_attributes.md) + + + + +Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document. + + +
+ +## Type Aliases + + + + + + + + + + + + + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[LifeCycle](./browser-rum-core.lifecycle.md) + + + + + +
+ +[MouseEventOnElement](./browser-rum-core.mouseeventonelement.md) + + + + + +
+ +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+ +[NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) + + + + + +
+ +[RawRumEvent](./browser-rum-core.rawrumevent.md) + + + + + +
+ +[RumActionEvent](./browser-rum-core.rumactionevent.md) + + + + +Schema of all properties of an Action event + + +
+ +[RumErrorEvent](./browser-rum-core.rumerrorevent.md) + + + + +Schema of all properties of an Error event + + +
+ +[RumEvent](./browser-rum-core.rumevent.md) + + + + +Schema of all properties of a RUM event + + +
+ +[RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md) + + + + + +
+ +[RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md) + + + + +Schema of all properties of a Long Task event + + +
+ +[RumResourceEvent](./browser-rum-core.rumresourceevent.md) + + + + +Schema of all properties of a Resource event + + +
+ +[RumSession](./browser-rum-core.rumsession.md) + + + + + +
+ +[RumViewEvent](./browser-rum-core.rumviewevent.md) + + + + +Schema of all properties of a View event + + +
+ +[RumVitalEvent](./browser-rum-core.rumvitalevent.md) + + + + +Schema of all properties of a Vital event + + +
+ +[StartRum](./browser-rum-core.startrum.md) + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md b/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md new file mode 100644 index 0000000000..21dcc03b9e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [MouseEventOnElement](./browser-rum-core.mouseeventonelement.md) + +## MouseEventOnElement type + +**Signature:** + +```typescript +export type MouseEventOnElement = PointerEvent & ExtraPointerEventFields; +``` diff --git a/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md b/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md new file mode 100644 index 0000000000..3d031b0156 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + +## NodePrivacyLevel variable + +**Signature:** + +```typescript +NodePrivacyLevel: { + readonly IGNORE: "ignore"; + readonly HIDDEN: "hidden"; + readonly ALLOW: "allow"; + readonly MASK: "mask"; + readonly MASK_USER_INPUT: "mask-user-input"; +} +``` diff --git a/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md b/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md new file mode 100644 index 0000000000..d3b364c383 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) + +## NodePrivacyLevelCache type + +**Signature:** + +```typescript +export type NodePrivacyLevelCache = Map; +``` +**References:** [NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md new file mode 100644 index 0000000000..ddf32522f0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_NAME](./browser-rum-core.privacy_attr_name.md) + +## PRIVACY\_ATTR\_NAME variable + +**Signature:** + +```typescript +PRIVACY_ATTR_NAME = "data-dd-privacy" +``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md new file mode 100644 index 0000000000..db1a668944 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_ALLOW](./browser-rum-core.privacy_attr_value_allow.md) + +## PRIVACY\_ATTR\_VALUE\_ALLOW variable + +**Signature:** + +```typescript +PRIVACY_ATTR_VALUE_ALLOW = "allow" +``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md new file mode 100644 index 0000000000..ee0c968d24 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_HIDDEN](./browser-rum-core.privacy_attr_value_hidden.md) + +## PRIVACY\_ATTR\_VALUE\_HIDDEN variable + +**Signature:** + +```typescript +PRIVACY_ATTR_VALUE_HIDDEN = "hidden" +``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md new file mode 100644 index 0000000000..895367370f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_MASK](./browser-rum-core.privacy_attr_value_mask.md) + +## PRIVACY\_ATTR\_VALUE\_MASK variable + +**Signature:** + +```typescript +PRIVACY_ATTR_VALUE_MASK = "mask" +``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md new file mode 100644 index 0000000000..7bdc9d0621 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT](./browser-rum-core.privacy_attr_value_mask_user_input.md) + +## PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT variable + +**Signature:** + +```typescript +PRIVACY_ATTR_VALUE_MASK_USER_INPUT = "mask-user-input" +``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md b/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md new file mode 100644 index 0000000000..cbc0ae2584 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_CLASS\_PREFIX](./browser-rum-core.privacy_class_prefix.md) + +## PRIVACY\_CLASS\_PREFIX variable + +**Signature:** + +```typescript +PRIVACY_CLASS_PREFIX = "dd-privacy-" +``` diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.md b/docs/api-reference/rum/browser-rum-core.profilerapi.md new file mode 100644 index 0000000000..ac5a61f639 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.profilerapi.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) + +## ProfilerApi interface + +**Signature:** + +```typescript +export interface ProfilerApi +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[onRumStart](./browser-rum-core.profilerapi.onrumstart.md) + + + + + + + +(lifeCycle: [LifeCycle](./browser-rum-core.lifecycle.md), configuration: [RumConfiguration](./browser-rum-core.rumconfiguration.md), sessionManager: [RumSessionManager](./browser-rum-core.rumsessionmanager.md), viewHistory: [ViewHistory](./browser-rum-core.viewhistory.md)) => void + + + + + +
+ +[stop](./browser-rum-core.profilerapi.stop.md) + + + + + + + +() => void + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md b/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md new file mode 100644 index 0000000000..c55c32d36c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) > [onRumStart](./browser-rum-core.profilerapi.onrumstart.md) + +## ProfilerApi.onRumStart property + +**Signature:** + +```typescript +onRumStart: (lifeCycle: LifeCycle, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md b/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md new file mode 100644 index 0000000000..819dcd1d0c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) > [stop](./browser-rum-core.profilerapi.stop.md) + +## ProfilerApi.stop property + +**Signature:** + +```typescript +stop: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md new file mode 100644 index 0000000000..f842e9c8f6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [\_dd](./browser-rum-core.rawrumactionevent._dd.md) + +## RawRumActionEvent.\_dd property + +**Signature:** + +```typescript +_dd?: { + action?: { + target?: { + selector?: string; + width?: number; + height?: number; + }; + name_source?: string; + position?: { + x: number; + y: number; + }; + pointer_up_delay?: Duration; + }; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md new file mode 100644 index 0000000000..6e7e926ce8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [action](./browser-rum-core.rawrumactionevent.action.md) + +## RawRumActionEvent.action property + +**Signature:** + +```typescript +action: { + id: string; + type: ActionType; + loading_time?: ServerDuration; + frustration?: { + type: FrustrationType[]; + }; + error?: Count; + long_task?: Count; + resource?: Count; + target: { + name: string; + }; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md new file mode 100644 index 0000000000..e60abd0055 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [date](./browser-rum-core.rawrumactionevent.date.md) + +## RawRumActionEvent.date property + +**Signature:** + +```typescript +date: TimeStamp; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md new file mode 100644 index 0000000000..ce47035543 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md @@ -0,0 +1,125 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) + +## RawRumActionEvent interface + +**Signature:** + +```typescript +export interface RawRumActionEvent +``` + +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[\_dd?](./browser-rum-core.rawrumactionevent._dd.md) + + + + + + + +{ action?: { target?: { selector?: string; width?: number; height?: number; }; name\_source?: string; position?: { x: number; y: number; }; pointer\_up\_delay?: Duration; }; } + + + + +_(Optional)_ + + +
+ +[action](./browser-rum-core.rawrumactionevent.action.md) + + + + + + + +{ id: string; type: [ActionType](./browser-rum-core.actiontype.md); loading\_time?: ServerDuration; frustration?: { type: [FrustrationType](./browser-rum-core.frustrationtype.md)\[\]; }; error?: Count; long\_task?: Count; resource?: Count; target: { name: string; }; } + + + + + +
+ +[date](./browser-rum-core.rawrumactionevent.date.md) + + + + + + + +TimeStamp + + + + + +
+ +[type](./browser-rum-core.rawrumactionevent.type.md) + + + + + + + +[RumEventType.ACTION](./browser-rum-core.rumeventtype.md) + + + + + +
+ +[view?](./browser-rum-core.rawrumactionevent.view.md) + + + + + + + +{ in\_foreground: boolean; } + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md new file mode 100644 index 0000000000..cdb94b33d3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [type](./browser-rum-core.rawrumactionevent.type.md) + +## RawRumActionEvent.type property + +**Signature:** + +```typescript +type: RumEventType.ACTION; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md new file mode 100644 index 0000000000..ff7ec01314 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [view](./browser-rum-core.rawrumactionevent.view.md) + +## RawRumActionEvent.view property + +**Signature:** + +```typescript +view?: { + in_foreground: boolean; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumevent.md b/docs/api-reference/rum/browser-rum-core.rawrumevent.md new file mode 100644 index 0000000000..dd2c1f5dbd --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumevent.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEvent](./browser-rum-core.rawrumevent.md) + +## RawRumEvent type + +**Signature:** + +```typescript +export type RawRumEvent = RawRumErrorEvent | RawRumResourceEvent | RawRumViewEvent | RawRumLongTaskEvent | RawRumLongAnimationFrameEvent | RawRumActionEvent | RawRumVitalEvent; +``` +**References:** [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md new file mode 100644 index 0000000000..0a07e2c02c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [customerContext](./browser-rum-core.rawrumeventcollecteddata.customercontext.md) + +## RawRumEventCollectedData.customerContext property + +**Signature:** + +```typescript +customerContext?: Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md new file mode 100644 index 0000000000..0bb722f431 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [domainContext](./browser-rum-core.rawrumeventcollecteddata.domaincontext.md) + +## RawRumEventCollectedData.domainContext property + +**Signature:** + +```typescript +domainContext: RumEventDomainContext; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md new file mode 100644 index 0000000000..9f941cbf81 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [duration](./browser-rum-core.rawrumeventcollecteddata.duration.md) + +## RawRumEventCollectedData.duration property + +**Signature:** + +```typescript +duration?: Duration; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md new file mode 100644 index 0000000000..0d7d6bef35 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md @@ -0,0 +1,125 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) + +## RawRumEventCollectedData interface + +**Signature:** + +```typescript +export interface RawRumEventCollectedData +``` + +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[customerContext?](./browser-rum-core.rawrumeventcollecteddata.customercontext.md) + + + + + + + +Context + + + + +_(Optional)_ + + +
+ +[domainContext](./browser-rum-core.rawrumeventcollecteddata.domaincontext.md) + + + + + + + +[RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md)<E\['type'\]> + + + + + +
+ +[duration?](./browser-rum-core.rawrumeventcollecteddata.duration.md) + + + + + + + +Duration + + + + +_(Optional)_ + + +
+ +[rawRumEvent](./browser-rum-core.rawrumeventcollecteddata.rawrumevent.md) + + + + + + + +E + + + + + +
+ +[startTime](./browser-rum-core.rawrumeventcollecteddata.starttime.md) + + + + + + + +RelativeTime + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md new file mode 100644 index 0000000000..9ee713b619 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [rawRumEvent](./browser-rum-core.rawrumeventcollecteddata.rawrumevent.md) + +## RawRumEventCollectedData.rawRumEvent property + +**Signature:** + +```typescript +rawRumEvent: E; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md new file mode 100644 index 0000000000..2831a41380 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [startTime](./browser-rum-core.rawrumeventcollecteddata.starttime.md) + +## RawRumEventCollectedData.startTime property + +**Signature:** + +```typescript +startTime: RelativeTime; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md b/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md new file mode 100644 index 0000000000..a26f7231ff --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [getReplayStats](./browser-rum-core.recorderapi.getreplaystats.md) + +## RecorderApi.getReplayStats property + +**Signature:** + +```typescript +getReplayStats: (viewId: string) => ReplayStats | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md b/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md new file mode 100644 index 0000000000..3dacf34a09 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [getSessionReplayLink](./browser-rum-core.recorderapi.getsessionreplaylink.md) + +## RecorderApi.getSessionReplayLink property + +**Signature:** + +```typescript +getSessionReplayLink: () => string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md b/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md new file mode 100644 index 0000000000..76bfeed391 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [isRecording](./browser-rum-core.recorderapi.isrecording.md) + +## RecorderApi.isRecording property + +**Signature:** + +```typescript +isRecording: () => boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.md b/docs/api-reference/rum/browser-rum-core.recorderapi.md new file mode 100644 index 0000000000..166d8c2f2a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.md @@ -0,0 +1,138 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) + +## RecorderApi interface + +**Signature:** + +```typescript +export interface RecorderApi +``` + +## Properties + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[getReplayStats](./browser-rum-core.recorderapi.getreplaystats.md) + + + + + + + +(viewId: string) => [ReplayStats](./browser-rum-core.replaystats.md) \| undefined + + + + + +
+ +[getSessionReplayLink](./browser-rum-core.recorderapi.getsessionreplaylink.md) + + + + + + + +() => string \| undefined + + + + + +
+ +[isRecording](./browser-rum-core.recorderapi.isrecording.md) + + + + + + + +() => boolean + + + + + +
+ +[onRumStart](./browser-rum-core.recorderapi.onrumstart.md) + + + + + + + +(lifeCycle: [LifeCycle](./browser-rum-core.lifecycle.md), configuration: [RumConfiguration](./browser-rum-core.rumconfiguration.md), sessionManager: [RumSessionManager](./browser-rum-core.rumsessionmanager.md), viewHistory: [ViewHistory](./browser-rum-core.viewhistory.md), deflateWorker: DeflateWorker \| undefined) => void + + + + + +
+ +[start](./browser-rum-core.recorderapi.start.md) + + + + + + + +(options?: [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md)) => void + + + + + +
+ +[stop](./browser-rum-core.recorderapi.stop.md) + + + + + + + +() => void + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md b/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md new file mode 100644 index 0000000000..b7be2048e5 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [onRumStart](./browser-rum-core.recorderapi.onrumstart.md) + +## RecorderApi.onRumStart property + +**Signature:** + +```typescript +onRumStart: (lifeCycle: LifeCycle, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory, deflateWorker: DeflateWorker | undefined) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.start.md b/docs/api-reference/rum/browser-rum-core.recorderapi.start.md new file mode 100644 index 0000000000..b86b7b4239 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.start.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [start](./browser-rum-core.recorderapi.start.md) + +## RecorderApi.start property + +**Signature:** + +```typescript +start: (options?: StartRecordingOptions) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md b/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md new file mode 100644 index 0000000000..de65e25972 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [stop](./browser-rum-core.recorderapi.stop.md) + +## RecorderApi.stop property + +**Signature:** + +```typescript +stop: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md b/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md new file mode 100644 index 0000000000..fdf01def9a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md @@ -0,0 +1,65 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [reducePrivacyLevel](./browser-rum-core.reduceprivacylevel.md) + +## reducePrivacyLevel() function + +Reduces the next privacy level based on self + parent privacy levels + +**Signature:** + +```typescript +export declare function reducePrivacyLevel(childPrivacyLevel: NodePrivacyLevel | undefined, parentNodePrivacyLevel: NodePrivacyLevel): NodePrivacyLevel; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +childPrivacyLevel + + + + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) \| undefined + + + + + +
+ +parentNodePrivacyLevel + + + + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+**Returns:** + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.md b/docs/api-reference/rum/browser-rum-core.replaystats.md new file mode 100644 index 0000000000..c6cae2fe68 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.replaystats.md @@ -0,0 +1,87 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) + +## ReplayStats interface + +**Signature:** + +```typescript +export interface ReplayStats +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[records\_count](./browser-rum-core.replaystats.records_count.md) + + + + + + + +number + + + + + +
+ +[segments\_count](./browser-rum-core.replaystats.segments_count.md) + + + + + + + +number + + + + + +
+ +[segments\_total\_raw\_size](./browser-rum-core.replaystats.segments_total_raw_size.md) + + + + + + + +number + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md b/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md new file mode 100644 index 0000000000..fe3f25060f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [records\_count](./browser-rum-core.replaystats.records_count.md) + +## ReplayStats.records\_count property + +**Signature:** + +```typescript +records_count: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md b/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md new file mode 100644 index 0000000000..7f113d2543 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [segments\_count](./browser-rum-core.replaystats.segments_count.md) + +## ReplayStats.segments\_count property + +**Signature:** + +```typescript +segments_count: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md b/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md new file mode 100644 index 0000000000..254f0c36db --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [segments\_total\_raw\_size](./browser-rum-core.replaystats.segments_total_raw_size.md) + +## ReplayStats.segments\_total\_raw\_size property + +**Signature:** + +```typescript +segments_total_raw_size: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactionevent.md b/docs/api-reference/rum/browser-rum-core.rumactionevent.md new file mode 100644 index 0000000000..d9d68f095c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumactionevent.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEvent](./browser-rum-core.rumactionevent.md) + +## RumActionEvent type + +Schema of all properties of an Action event + +**Signature:** + +```typescript +export type RumActionEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'action'; + readonly action: { + readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; + readonly id?: string; + readonly loading_time?: number; + readonly target?: { + name: string; + [k: string]: unknown; + }; + readonly frustration?: { + readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; + [k: string]: unknown; + }; + readonly error?: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly resource?: { + readonly count: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + _dd?: { + readonly action?: { + readonly position?: { + readonly x: number; + readonly y: number; + [k: string]: unknown; + }; + target?: { + readonly selector?: string; + readonly width?: number; + readonly height?: number; + [k: string]: unknown; + }; + name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md new file mode 100644 index 0000000000..5afe16fd8f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) > [events](./browser-rum-core.rumactioneventdomaincontext.events.md) + +## RumActionEventDomainContext.events property + +**Signature:** + +```typescript +events?: Event[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..80eddb8ef7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) > [handlingStack](./browser-rum-core.rumactioneventdomaincontext.handlingstack.md) + +## RumActionEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md new file mode 100644 index 0000000000..5b8264dd76 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md @@ -0,0 +1,74 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) + +## RumActionEventDomainContext interface + +**Signature:** + +```typescript +export interface RumActionEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[events?](./browser-rum-core.rumactioneventdomaincontext.events.md) + + + + + + + +Event\[\] + + + + +_(Optional)_ + + +
+ +[handlingStack?](./browser-rum-core.rumactioneventdomaincontext.handlingstack.md) + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md new file mode 100644 index 0000000000..f30cdb8773 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [actionNameAttribute](./browser-rum-core.rumconfiguration.actionnameattribute.md) + +## RumConfiguration.actionNameAttribute property + +**Signature:** + +```typescript +actionNameAttribute: string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md new file mode 100644 index 0000000000..1cbc936bb0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [allowedTracingUrls](./browser-rum-core.rumconfiguration.allowedtracingurls.md) + +## RumConfiguration.allowedTracingUrls property + +**Signature:** + +```typescript +allowedTracingUrls: TracingOption[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md new file mode 100644 index 0000000000..c109ac8ad7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [applicationId](./browser-rum-core.rumconfiguration.applicationid.md) + +## RumConfiguration.applicationId property + +**Signature:** + +```typescript +applicationId: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md new file mode 100644 index 0000000000..8a4f347bed --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [compressIntakeRequests](./browser-rum-core.rumconfiguration.compressintakerequests.md) + +## RumConfiguration.compressIntakeRequests property + +**Signature:** + +```typescript +compressIntakeRequests: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md new file mode 100644 index 0000000000..3bf9898308 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [customerDataTelemetrySampleRate](./browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md) + +## RumConfiguration.customerDataTelemetrySampleRate property + +**Signature:** + +```typescript +customerDataTelemetrySampleRate: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md new file mode 100644 index 0000000000..5123733626 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [defaultPrivacyLevel](./browser-rum-core.rumconfiguration.defaultprivacylevel.md) + +## RumConfiguration.defaultPrivacyLevel property + +**Signature:** + +```typescript +defaultPrivacyLevel: DefaultPrivacyLevel; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md new file mode 100644 index 0000000000..6f7772117c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [enablePrivacyForActionName](./browser-rum-core.rumconfiguration.enableprivacyforactionname.md) + +## RumConfiguration.enablePrivacyForActionName property + +**Signature:** + +```typescript +enablePrivacyForActionName: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md new file mode 100644 index 0000000000..bd6ae03925 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [excludedActivityUrls](./browser-rum-core.rumconfiguration.excludedactivityurls.md) + +## RumConfiguration.excludedActivityUrls property + +**Signature:** + +```typescript +excludedActivityUrls: MatchOption[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.md new file mode 100644 index 0000000000..4e5c1682f5 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.md @@ -0,0 +1,449 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) + +## RumConfiguration interface + +**Signature:** + +```typescript +export interface RumConfiguration extends Configuration +``` +**Extends:** Configuration + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[actionNameAttribute](./browser-rum-core.rumconfiguration.actionnameattribute.md) + + + + + + + +string \| undefined + + + + + +
+ +[allowedTracingUrls](./browser-rum-core.rumconfiguration.allowedtracingurls.md) + + + + + + + +TracingOption\[\] + + + + + +
+ +[applicationId](./browser-rum-core.rumconfiguration.applicationid.md) + + + + + + + +string + + + + + +
+ +[compressIntakeRequests](./browser-rum-core.rumconfiguration.compressintakerequests.md) + + + + + + + +boolean + + + + + +
+ +[customerDataTelemetrySampleRate](./browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md) + + + + + + + +number + + + + + +
+ +[defaultPrivacyLevel](./browser-rum-core.rumconfiguration.defaultprivacylevel.md) + + + + + + + +DefaultPrivacyLevel + + + + + +
+ +[enablePrivacyForActionName](./browser-rum-core.rumconfiguration.enableprivacyforactionname.md) + + + + + + + +boolean + + + + + +
+ +[excludedActivityUrls](./browser-rum-core.rumconfiguration.excludedactivityurls.md) + + + + + + + +MatchOption\[\] + + + + + +
+ +[plugins](./browser-rum-core.rumconfiguration.plugins.md) + + + + + + + +[RumPlugin](./browser-rum-core.rumplugin.md)\[\] + + + + + +
+ +[profilingSampleRate](./browser-rum-core.rumconfiguration.profilingsamplerate.md) + + + + + + + +number + + + + + +
+ +[propagateTraceBaggage](./browser-rum-core.rumconfiguration.propagatetracebaggage.md) + + + + + + + +boolean + + + + + +
+ +[rulePsr](./browser-rum-core.rumconfiguration.rulepsr.md) + + + + + + + +number \| undefined + + + + + +
+ +[sessionReplaySampleRate](./browser-rum-core.rumconfiguration.sessionreplaysamplerate.md) + + + + + + + +number + + + + + +
+ +[startSessionReplayRecordingManually](./browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md) + + + + + + + +boolean + + + + + +
+ +[subdomain?](./browser-rum-core.rumconfiguration.subdomain.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[traceContextInjection](./browser-rum-core.rumconfiguration.tracecontextinjection.md) + + + + + + + +TraceContextInjection + + + + + +
+ +[traceSampleRate](./browser-rum-core.rumconfiguration.tracesamplerate.md) + + + + + + + +number + + + + + +
+ +[trackFeatureFlagsForEvents](./browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md) + + + + + + + +FeatureFlagsForEvents\[\] + + + + + +
+ +[trackLongTasks](./browser-rum-core.rumconfiguration.tracklongtasks.md) + + + + + + + +boolean + + + + + +
+ +[trackResources](./browser-rum-core.rumconfiguration.trackresources.md) + + + + + + + +boolean + + + + + +
+ +[trackUserInteractions](./browser-rum-core.rumconfiguration.trackuserinteractions.md) + + + + + + + +boolean + + + + + +
+ +[trackViewsManually](./browser-rum-core.rumconfiguration.trackviewsmanually.md) + + + + + + + +boolean + + + + + +
+ +[version?](./browser-rum-core.rumconfiguration.version.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[workerUrl](./browser-rum-core.rumconfiguration.workerurl.md) + + + + + + + +string \| undefined + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md new file mode 100644 index 0000000000..d1450b4f84 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [plugins](./browser-rum-core.rumconfiguration.plugins.md) + +## RumConfiguration.plugins property + +**Signature:** + +```typescript +plugins: RumPlugin[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md new file mode 100644 index 0000000000..9f9e6f779c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [profilingSampleRate](./browser-rum-core.rumconfiguration.profilingsamplerate.md) + +## RumConfiguration.profilingSampleRate property + +**Signature:** + +```typescript +profilingSampleRate: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md new file mode 100644 index 0000000000..2a165facf6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [propagateTraceBaggage](./browser-rum-core.rumconfiguration.propagatetracebaggage.md) + +## RumConfiguration.propagateTraceBaggage property + +**Signature:** + +```typescript +propagateTraceBaggage: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md new file mode 100644 index 0000000000..ffeb4b7419 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [rulePsr](./browser-rum-core.rumconfiguration.rulepsr.md) + +## RumConfiguration.rulePsr property + +**Signature:** + +```typescript +rulePsr: number | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md new file mode 100644 index 0000000000..3c8843f275 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [sessionReplaySampleRate](./browser-rum-core.rumconfiguration.sessionreplaysamplerate.md) + +## RumConfiguration.sessionReplaySampleRate property + +**Signature:** + +```typescript +sessionReplaySampleRate: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md new file mode 100644 index 0000000000..8f5619cc90 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md) + +## RumConfiguration.startSessionReplayRecordingManually property + +**Signature:** + +```typescript +startSessionReplayRecordingManually: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md new file mode 100644 index 0000000000..42c354ba26 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [subdomain](./browser-rum-core.rumconfiguration.subdomain.md) + +## RumConfiguration.subdomain property + +**Signature:** + +```typescript +subdomain?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md new file mode 100644 index 0000000000..b382c60347 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [traceContextInjection](./browser-rum-core.rumconfiguration.tracecontextinjection.md) + +## RumConfiguration.traceContextInjection property + +**Signature:** + +```typescript +traceContextInjection: TraceContextInjection; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md new file mode 100644 index 0000000000..9a587b9297 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [traceSampleRate](./browser-rum-core.rumconfiguration.tracesamplerate.md) + +## RumConfiguration.traceSampleRate property + +**Signature:** + +```typescript +traceSampleRate: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md new file mode 100644 index 0000000000..6fcab40447 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md) + +## RumConfiguration.trackFeatureFlagsForEvents property + +**Signature:** + +```typescript +trackFeatureFlagsForEvents: FeatureFlagsForEvents[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md new file mode 100644 index 0000000000..68ca55fbe2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackLongTasks](./browser-rum-core.rumconfiguration.tracklongtasks.md) + +## RumConfiguration.trackLongTasks property + +**Signature:** + +```typescript +trackLongTasks: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md new file mode 100644 index 0000000000..7f8140fc9c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackResources](./browser-rum-core.rumconfiguration.trackresources.md) + +## RumConfiguration.trackResources property + +**Signature:** + +```typescript +trackResources: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md new file mode 100644 index 0000000000..b6b11dd237 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackUserInteractions](./browser-rum-core.rumconfiguration.trackuserinteractions.md) + +## RumConfiguration.trackUserInteractions property + +**Signature:** + +```typescript +trackUserInteractions: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md new file mode 100644 index 0000000000..6c3ff1029a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackViewsManually](./browser-rum-core.rumconfiguration.trackviewsmanually.md) + +## RumConfiguration.trackViewsManually property + +**Signature:** + +```typescript +trackViewsManually: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md new file mode 100644 index 0000000000..e67ac7d030 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [version](./browser-rum-core.rumconfiguration.version.md) + +## RumConfiguration.version property + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md new file mode 100644 index 0000000000..a43a16ab25 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [workerUrl](./browser-rum-core.rumconfiguration.workerurl.md) + +## RumConfiguration.workerUrl property + +**Signature:** + +```typescript +workerUrl: string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerrorevent.md b/docs/api-reference/rum/browser-rum-core.rumerrorevent.md new file mode 100644 index 0000000000..11206c4ae8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumerrorevent.md @@ -0,0 +1,94 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEvent](./browser-rum-core.rumerrorevent.md) + +## RumErrorEvent type + +Schema of all properties of an Error event + +**Signature:** + +```typescript +export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'error'; + readonly error: { + readonly id?: string; + message: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + stack?: string; + causes?: { + message: string; + readonly type?: string; + stack?: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + [k: string]: unknown; + }[]; + readonly is_crash?: boolean; + fingerprint?: string; + readonly type?: string; + readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; + readonly handling?: 'handled' | 'unhandled'; + readonly handling_stack?: string; + readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; + readonly resource?: { + readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + readonly status_code: number; + url: string; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + threads?: { + readonly name: string; + readonly crashed: boolean; + readonly stack: string; + readonly state?: string; + [k: string]: unknown; + }[]; + readonly binary_images?: { + readonly uuid: string; + readonly name: string; + readonly is_system: boolean; + readonly load_address?: string; + readonly max_address?: string; + readonly arch?: string; + [k: string]: unknown; + }[]; + readonly was_truncated?: boolean; + readonly meta?: { + readonly code_type?: string; + readonly parent_process?: string; + readonly incident_identifier?: string; + readonly process?: string; + readonly exception_type?: string; + readonly exception_codes?: string; + readonly path?: string; + [k: string]: unknown; + }; + readonly csp?: { + readonly disposition?: 'enforce' | 'report'; + [k: string]: unknown; + }; + readonly time_since_app_start?: number; + [k: string]: unknown; + }; + readonly freeze?: { + readonly duration: number; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md new file mode 100644 index 0000000000..867f19bdb7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) > [error](./browser-rum-core.rumerroreventdomaincontext.error.md) + +## RumErrorEventDomainContext.error property + +**Signature:** + +```typescript +error: unknown; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..2ac3038d73 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) > [handlingStack](./browser-rum-core.rumerroreventdomaincontext.handlingstack.md) + +## RumErrorEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md new file mode 100644 index 0000000000..ef2ea5b2cf --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md @@ -0,0 +1,72 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) + +## RumErrorEventDomainContext interface + +**Signature:** + +```typescript +export interface RumErrorEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[error](./browser-rum-core.rumerroreventdomaincontext.error.md) + + + + + + + +unknown + + + + + +
+ +[handlingStack?](./browser-rum-core.rumerroreventdomaincontext.handlingstack.md) + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumevent.md b/docs/api-reference/rum/browser-rum-core.rumevent.md new file mode 100644 index 0000000000..79e8ad1fd9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumevent.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEvent](./browser-rum-core.rumevent.md) + +## RumEvent type + +Schema of all properties of a RUM event + +**Signature:** + +```typescript +export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; +``` +**References:** [RumActionEvent](./browser-rum-core.rumactionevent.md), [RumErrorEvent](./browser-rum-core.rumerrorevent.md), [RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md), [RumResourceEvent](./browser-rum-core.rumresourceevent.md), [RumViewEvent](./browser-rum-core.rumviewevent.md), [RumVitalEvent](./browser-rum-core.rumvitalevent.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md new file mode 100644 index 0000000000..e526ec1b2f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md) + +## RumEventDomainContext type + +**Signature:** + +```typescript +export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; +``` +**References:** [RumEventType](./browser-rum-core.rumeventtype.md), [RumEventType.VIEW](./browser-rum-core.rumeventtype.md), [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md), [RumEventType.ACTION](./browser-rum-core.rumeventtype.md), [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md), [RumEventType.RESOURCE](./browser-rum-core.rumeventtype.md), [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md), [RumEventType.ERROR](./browser-rum-core.rumeventtype.md), [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md), [RumEventType.LONG\_TASK](./browser-rum-core.rumeventtype.md), [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md), [RumEventType.VITAL](./browser-rum-core.rumeventtype.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumeventtype.md b/docs/api-reference/rum/browser-rum-core.rumeventtype.md new file mode 100644 index 0000000000..b2b61d6661 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumeventtype.md @@ -0,0 +1,115 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEventType](./browser-rum-core.rumeventtype.md) + +## RumEventType enum + +**Signature:** + +```typescript +export declare const enum RumEventType +``` + +## Enumeration Members + + + + + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +ACTION + + + + +`"action"` + + + + + +
+ +ERROR + + + + +`"error"` + + + + + +
+ +LONG\_TASK + + + + +`"long_task"` + + + + + +
+ +RESOURCE + + + + +`"resource"` + + + + + +
+ +VIEW + + + + +`"view"` + + + + + +
+ +VITAL + + + + +`"vital"` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md new file mode 100644 index 0000000000..5fd4f2a05a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [error](./browser-rum-core.rumfetchresourceeventdomaincontext.error.md) + +## RumFetchResourceEventDomainContext.error property + +**Signature:** + +```typescript +error?: Error; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..8ed1ebe68f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [handlingStack](./browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md) + +## RumFetchResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md new file mode 100644 index 0000000000..3826406053 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [isAborted](./browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md) + +## RumFetchResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md new file mode 100644 index 0000000000..1bae30737f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md @@ -0,0 +1,165 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) + +## RumFetchResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumFetchResourceEventDomainContext +``` + +## Properties + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[error?](./browser-rum-core.rumfetchresourceeventdomaincontext.error.md) + + + + + + + +Error + + + + +_(Optional)_ + + +
+ +[handlingStack?](./browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[isAborted](./browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md) + + + + + + + +boolean + + + + + +
+ +[performanceEntry?](./browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md) + + + + + + + +PerformanceEntry + + + + +_(Optional)_ + + +
+ +[requestInit?](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md) + + + + + + + +RequestInit + + + + +_(Optional)_ + + +
+ +[requestInput](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md) + + + + + + + +RequestInfo + + + + + +
+ +[response?](./browser-rum-core.rumfetchresourceeventdomaincontext.response.md) + + + + + + + +Response + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..3f6ad497ca --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md) + +## RumFetchResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md new file mode 100644 index 0000000000..3fb2720966 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [requestInit](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md) + +## RumFetchResourceEventDomainContext.requestInit property + +**Signature:** + +```typescript +requestInit?: RequestInit; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md new file mode 100644 index 0000000000..cadf54b2b4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [requestInput](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md) + +## RumFetchResourceEventDomainContext.requestInput property + +**Signature:** + +```typescript +requestInput: RequestInfo; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md new file mode 100644 index 0000000000..798c0dceec --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [response](./browser-rum-core.rumfetchresourceeventdomaincontext.response.md) + +## RumFetchResourceEventDomainContext.response property + +**Signature:** + +```typescript +response?: Response; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md new file mode 100644 index 0000000000..1b9e7621a3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [actionNameAttribute](./browser-rum-core.ruminitconfiguration.actionnameattribute.md) + +## RumInitConfiguration.actionNameAttribute property + +Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. + +**Signature:** + +```typescript +actionNameAttribute?: string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md new file mode 100644 index 0000000000..d4225adcea --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [allowedTracingUrls](./browser-rum-core.ruminitconfiguration.allowedtracingurls.md) + +## RumInitConfiguration.allowedTracingUrls property + +A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +allowedTracingUrls?: Array | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md new file mode 100644 index 0000000000..27ed1d8648 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [applicationId](./browser-rum-core.ruminitconfiguration.applicationid.md) + +## RumInitConfiguration.applicationId property + +The RUM application ID. + +**Signature:** + +```typescript +applicationId: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md new file mode 100644 index 0000000000..2e44d39f6f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [beforeSend](./browser-rum-core.ruminitconfiguration.beforesend.md) + +## RumInitConfiguration.beforeSend property + +Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. + +**Signature:** + +```typescript +beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md new file mode 100644 index 0000000000..2d81d5cbbd --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [compressIntakeRequests](./browser-rum-core.ruminitconfiguration.compressintakerequests.md) + +## RumInitConfiguration.compressIntakeRequests property + +Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + +**Signature:** + +```typescript +compressIntakeRequests?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md new file mode 100644 index 0000000000..0dd344b1e1 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [defaultPrivacyLevel](./browser-rum-core.ruminitconfiguration.defaultprivacylevel.md) + +## RumInitConfiguration.defaultPrivacyLevel property + +Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. + +**Signature:** + +```typescript +defaultPrivacyLevel?: DefaultPrivacyLevel | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md new file mode 100644 index 0000000000..f32823dfdd --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [enablePrivacyForActionName](./browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md) + +## RumInitConfiguration.enablePrivacyForActionName property + +Enables privacy control for action names. + +**Signature:** + +```typescript +enablePrivacyForActionName?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md new file mode 100644 index 0000000000..9c8991258d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [excludedActivityUrls](./browser-rum-core.ruminitconfiguration.excludedactivityurls.md) + +## RumInitConfiguration.excludedActivityUrls property + +A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. + +**Signature:** + +```typescript +excludedActivityUrls?: MatchOption[] | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md new file mode 100644 index 0000000000..86986bf71d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md @@ -0,0 +1,476 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) + +## RumInitConfiguration interface + +**Signature:** + +```typescript +export interface RumInitConfiguration extends InitConfiguration +``` +**Extends:** InitConfiguration + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[actionNameAttribute?](./browser-rum-core.ruminitconfiguration.actionnameattribute.md) + + + + + + + +string \| undefined + + + + +_(Optional)_ Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. + + +
+ +[allowedTracingUrls?](./browser-rum-core.ruminitconfiguration.allowedtracingurls.md) + + + + + + + +Array<MatchOption \| TracingOption> \| undefined + + + + +_(Optional)_ A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + + +
+ +[applicationId](./browser-rum-core.ruminitconfiguration.applicationid.md) + + + + + + + +string + + + + +The RUM application ID. + + +
+ +[beforeSend?](./browser-rum-core.ruminitconfiguration.beforesend.md) + + + + + + + +((event: [RumEvent](./browser-rum-core.rumevent.md), context: [RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md)) => boolean) \| undefined + + + + +_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. + + +
+ +[compressIntakeRequests?](./browser-rum-core.ruminitconfiguration.compressintakerequests.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + + +
+ +[defaultPrivacyLevel?](./browser-rum-core.ruminitconfiguration.defaultprivacylevel.md) + + + + + + + +DefaultPrivacyLevel \| undefined + + + + +_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. + + +
+ +[enablePrivacyForActionName?](./browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables privacy control for action names. + + +
+ +[excludedActivityUrls?](./browser-rum-core.ruminitconfiguration.excludedactivityurls.md) + + + + + + + +MatchOption\[\] \| undefined + + + + +_(Optional)_ A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. + + +
+ +[plugins?](./browser-rum-core.ruminitconfiguration.plugins.md) + + + + + + + +[RumPlugin](./browser-rum-core.rumplugin.md)\[\] \| undefined + + + + +_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + + +
+ +[profilingSampleRate?](./browser-rum-core.ruminitconfiguration.profilingsamplerate.md) + + + + + + + +number \| undefined + + + + +_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + + +
+ +[propagateTraceBaggage?](./browser-rum-core.ruminitconfiguration.propagatetracebaggage.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false + + +
+ +[remoteConfigurationId?](./browser-rum-core.ruminitconfiguration.remoteconfigurationid.md) + + + + + + + +string \| undefined + + + + +_(Optional)_ + + +
+ +[sessionReplaySampleRate?](./browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md) + + + + + + + +number \| undefined + + + + +_(Optional)_ The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. + + +
+ +[startSessionReplayRecordingManually?](./browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. + + +
+ +[subdomain?](./browser-rum-core.ruminitconfiguration.subdomain.md) + + + + + + + +string + + + + +_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + + +
+ +[traceContextInjection?](./browser-rum-core.ruminitconfiguration.tracecontextinjection.md) + + + + + + + +TraceContextInjection \| undefined + + + + +_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + + +
+ +[traceSampleRate?](./browser-rum-core.ruminitconfiguration.tracesamplerate.md) + + + + + + + +number \| undefined + + + + +_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + + +
+ +[trackFeatureFlagsForEvents?](./browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md) + + + + + + + +FeatureFlagsForEvents\[\] + + + + +_(Optional)_ Enables collection of features flags in chosen events. + + +
+ +[trackLongTasks?](./browser-rum-core.ruminitconfiguration.tracklongtasks.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables collection of long task events. true + + +
+ +[trackResources?](./browser-rum-core.ruminitconfiguration.trackresources.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables collection of resource events. true + + +
+ +[trackUserInteractions?](./browser-rum-core.ruminitconfiguration.trackuserinteractions.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true + + +
+ +[trackViewsManually?](./browser-rum-core.ruminitconfiguration.trackviewsmanually.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. + + +
+ +[workerUrl?](./browser-rum-core.ruminitconfiguration.workerurl.md) + + + + + + + +string + + + + +_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + + +
diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md new file mode 100644 index 0000000000..659dabd909 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [plugins](./browser-rum-core.ruminitconfiguration.plugins.md) + +## RumInitConfiguration.plugins property + +List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + +**Signature:** + +```typescript +plugins?: RumPlugin[] | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md new file mode 100644 index 0000000000..76ec1f5fe4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [profilingSampleRate](./browser-rum-core.ruminitconfiguration.profilingsamplerate.md) + +## RumInitConfiguration.profilingSampleRate property + +Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + +**Signature:** + +```typescript +profilingSampleRate?: number | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md new file mode 100644 index 0000000000..0fefbb7633 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [propagateTraceBaggage](./browser-rum-core.ruminitconfiguration.propagatetracebaggage.md) + +## RumInitConfiguration.propagateTraceBaggage property + +Whether to propagate user and account IDs in the baggage header of trace requests. false + +**Signature:** + +```typescript +propagateTraceBaggage?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md new file mode 100644 index 0000000000..3163fda2ab --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [remoteConfigurationId](./browser-rum-core.ruminitconfiguration.remoteconfigurationid.md) + +## RumInitConfiguration.remoteConfigurationId property + +**Signature:** + +```typescript +remoteConfigurationId?: string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md new file mode 100644 index 0000000000..5592157cbb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [sessionReplaySampleRate](./browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md) + +## RumInitConfiguration.sessionReplaySampleRate property + +The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. + +**Signature:** + +```typescript +sessionReplaySampleRate?: number | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md new file mode 100644 index 0000000000..820f78e546 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md) + +## RumInitConfiguration.startSessionReplayRecordingManually property + +If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. + +**Signature:** + +```typescript +startSessionReplayRecordingManually?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md new file mode 100644 index 0000000000..afbf85809b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [subdomain](./browser-rum-core.ruminitconfiguration.subdomain.md) + +## RumInitConfiguration.subdomain property + +If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + +**Signature:** + +```typescript +subdomain?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md new file mode 100644 index 0000000000..8c9c1f3dbf --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [traceContextInjection](./browser-rum-core.ruminitconfiguration.tracecontextinjection.md) + +## RumInitConfiguration.traceContextInjection property + +If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +traceContextInjection?: TraceContextInjection | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md new file mode 100644 index 0000000000..a9ae78693e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [traceSampleRate](./browser-rum-core.ruminitconfiguration.tracesamplerate.md) + +## RumInitConfiguration.traceSampleRate property + +The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +traceSampleRate?: number | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md new file mode 100644 index 0000000000..74ed0d60f6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md) + +## RumInitConfiguration.trackFeatureFlagsForEvents property + +Enables collection of features flags in chosen events. + +**Signature:** + +```typescript +trackFeatureFlagsForEvents?: FeatureFlagsForEvents[]; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md new file mode 100644 index 0000000000..32177ef664 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackLongTasks](./browser-rum-core.ruminitconfiguration.tracklongtasks.md) + +## RumInitConfiguration.trackLongTasks property + +Enables collection of long task events. true + +**Signature:** + +```typescript +trackLongTasks?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md new file mode 100644 index 0000000000..54d47a32be --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackResources](./browser-rum-core.ruminitconfiguration.trackresources.md) + +## RumInitConfiguration.trackResources property + +Enables collection of resource events. true + +**Signature:** + +```typescript +trackResources?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md new file mode 100644 index 0000000000..6f27947593 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackUserInteractions](./browser-rum-core.ruminitconfiguration.trackuserinteractions.md) + +## RumInitConfiguration.trackUserInteractions property + +Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true + +**Signature:** + +```typescript +trackUserInteractions?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md new file mode 100644 index 0000000000..2928e87950 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackViewsManually](./browser-rum-core.ruminitconfiguration.trackviewsmanually.md) + +## RumInitConfiguration.trackViewsManually property + +Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. + +**Signature:** + +```typescript +trackViewsManually?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md new file mode 100644 index 0000000000..d3b13b7211 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [workerUrl](./browser-rum-core.ruminitconfiguration.workerurl.md) + +## RumInitConfiguration.workerUrl property + +URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + +**Signature:** + +```typescript +workerUrl?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md b/docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md new file mode 100644 index 0000000000..a708f093dc --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md) + +## RumLongTaskEvent type + +Schema of all properties of a Long Task event + +**Signature:** + +```typescript +export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'long_task'; + readonly long_task: { + readonly id?: string; + readonly start_time?: number; + readonly entry_type?: 'long-task' | 'long-animation-frame'; + readonly duration: number; + readonly blocking_duration?: number; + readonly render_start?: number; + readonly style_and_layout_start?: number; + readonly first_ui_event_timestamp?: number; + readonly is_frozen_frame?: boolean; + readonly scripts?: { + readonly duration?: number; + readonly pause_duration?: number; + readonly forced_style_and_layout_duration?: number; + readonly start_time?: number; + readonly execution_start?: number; + source_url?: string; + readonly source_function_name?: string; + readonly source_char_position?: number; + invoker?: string; + readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; + readonly window_attribution?: string; + [k: string]: unknown; + }[]; + [k: string]: unknown; + }; + readonly _dd?: { + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md new file mode 100644 index 0000000000..a9aadfcd91 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) + +## RumLongTaskEventDomainContext interface + +**Signature:** + +```typescript +export interface RumLongTaskEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[performanceEntry](./browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md) + + + + + + + +PerformanceEntry + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..552af2a8dc --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md) + +## RumLongTaskEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md new file mode 100644 index 0000000000..028b90810d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) + +## RumOtherResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumOtherResourceEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[performanceEntry](./browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md) + + + + + + + +PerformanceEntry + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..11851ca297 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md) + +## RumOtherResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md b/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md new file mode 100644 index 0000000000..4bd8633391 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md @@ -0,0 +1,171 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) + +## RumPerformanceEntryType enum + +**Signature:** + +```typescript +export declare enum RumPerformanceEntryType +``` + +## Enumeration Members + + + + + + + + + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +EVENT + + + + +`"event"` + + + + + +
+ +FIRST\_INPUT + + + + +`"first-input"` + + + + + +
+ +LARGEST\_CONTENTFUL\_PAINT + + + + +`"largest-contentful-paint"` + + + + + +
+ +LAYOUT\_SHIFT + + + + +`"layout-shift"` + + + + + +
+ +LONG\_ANIMATION\_FRAME + + + + +`"long-animation-frame"` + + + + + +
+ +LONG\_TASK + + + + +`"longtask"` + + + + + +
+ +NAVIGATION + + + + +`"navigation"` + + + + + +
+ +PAINT + + + + +`"paint"` + + + + + +
+ +RESOURCE + + + + +`"resource"` + + + + + +
+ +VISIBILITY\_STATE + + + + +`"visibility-state"` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md b/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md new file mode 100644 index 0000000000..feacaddd87 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [getConfigurationTelemetry](./browser-rum-core.rumplugin.getconfigurationtelemetry.md) + +## RumPlugin.getConfigurationTelemetry() method + +**Signature:** + +```typescript +getConfigurationTelemetry?(): Record; +``` +**Returns:** + +Record<string, unknown> + diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.md b/docs/api-reference/rum/browser-rum-core.rumplugin.md new file mode 100644 index 0000000000..8dd9b789a2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumplugin.md @@ -0,0 +1,101 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) + +## RumPlugin interface + +**Signature:** + +```typescript +export interface RumPlugin +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[name](./browser-rum-core.rumplugin.name.md) + + + + + + + +string + + + + + +
+ +## Methods + + + + + +
+ +Method + + + + +Description + + +
+ +[getConfigurationTelemetry()?](./browser-rum-core.rumplugin.getconfigurationtelemetry.md) + + + + +_(Optional)_ + + +
+ +[onInit(options)?](./browser-rum-core.rumplugin.oninit.md) + + + + +_(Optional)_ + + +
+ +[onRumStart(options)?](./browser-rum-core.rumplugin.onrumstart.md) + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.name.md b/docs/api-reference/rum/browser-rum-core.rumplugin.name.md new file mode 100644 index 0000000000..253b58eb6b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumplugin.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [name](./browser-rum-core.rumplugin.name.md) + +## RumPlugin.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md b/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md new file mode 100644 index 0000000000..3d59169d1b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [onInit](./browser-rum-core.rumplugin.oninit.md) + +## RumPlugin.onInit() method + +**Signature:** + +```typescript +onInit?(options: { + initConfiguration: RumInitConfiguration; + publicApi: RumPublicApi; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +{ initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md); publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md); } + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md b/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md new file mode 100644 index 0000000000..ece83a6e33 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [onRumStart](./browser-rum-core.rumplugin.onrumstart.md) + +## RumPlugin.onRumStart() method + +**Signature:** + +```typescript +onRumStart?(options: { + strategy: Strategy; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +{ strategy: [Strategy](./browser-rum-core.strategy.md); } + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md new file mode 100644 index 0000000000..44278d08c0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addAction](./browser-rum-core.rumpublicapi.addaction.md) + +## RumPublicApi.addAction property + +Add a custom action, stored in `@action` + +**Signature:** + +```typescript +addAction: (name: string, context?: object) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md new file mode 100644 index 0000000000..b7e6f9c7f6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addDurationVital](./browser-rum-core.rumpublicapi.adddurationvital.md) + +## RumPublicApi.addDurationVital property + +Add a custom duration vital + +**Signature:** + +```typescript +addDurationVital: (name: string, options: { + startTime: number; + duration: number; + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md new file mode 100644 index 0000000000..698f7a3836 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addError](./browser-rum-core.rumpublicapi.adderror.md) + +## RumPublicApi.addError property + +Add a custom error, stored in `@error`. + +**Signature:** + +```typescript +addError: (error: unknown, context?: object) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md new file mode 100644 index 0000000000..6c941fcd25 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addFeatureFlagEvaluation](./browser-rum-core.rumpublicapi.addfeatureflagevaluation.md) + +## RumPublicApi.addFeatureFlagEvaluation property + +Add a feature flag evaluation, stored in `@feature_flags.` + +**Signature:** + +```typescript +addFeatureFlagEvaluation: (key: string, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md new file mode 100644 index 0000000000..293b8bee21 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addTiming](./browser-rum-core.rumpublicapi.addtiming.md) + +## RumPublicApi.addTiming property + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + +**Signature:** + +```typescript +addTiming: (name: string, time?: number) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md new file mode 100644 index 0000000000..79a28408c4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearAccount](./browser-rum-core.rumpublicapi.clearaccount.md) + +## RumPublicApi.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md new file mode 100644 index 0000000000..363c85699f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearGlobalContext](./browser-rum-core.rumpublicapi.clearglobalcontext.md) + +## RumPublicApi.clearGlobalContext property + +Clear the global context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md new file mode 100644 index 0000000000..630013563d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearUser](./browser-rum-core.rumpublicapi.clearuser.md) + +## RumPublicApi.clearUser property + +Clear all user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md new file mode 100644 index 0000000000..7e9d8beae8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getAccount](./browser-rum-core.rumpublicapi.getaccount.md) + +## RumPublicApi.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md new file mode 100644 index 0000000000..4e4bfa3520 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getGlobalContext](./browser-rum-core.rumpublicapi.getglobalcontext.md) + +## RumPublicApi.getGlobalContext property + +Get the global Context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md new file mode 100644 index 0000000000..15c3fd2db1 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getInitConfiguration](./browser-rum-core.rumpublicapi.getinitconfiguration.md) + +## RumPublicApi.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => RumInitConfiguration | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md new file mode 100644 index 0000000000..d9bc7fe5bb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getInternalContext](./browser-rum-core.rumpublicapi.getinternalcontext.md) + +## RumPublicApi.getInternalContext property + +\[Internal API\] Get the internal SDK context + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md new file mode 100644 index 0000000000..8fcdab0c34 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getSessionReplayLink](./browser-rum-core.rumpublicapi.getsessionreplaylink.md) + +## RumPublicApi.getSessionReplayLink property + +Get the Session Replay Link. + +See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + +**Signature:** + +```typescript +getSessionReplayLink: () => string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md new file mode 100644 index 0000000000..4e4cf21e87 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getUser](./browser-rum-core.rumpublicapi.getuser.md) + +## RumPublicApi.getUser property + +Get user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +getUser: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md new file mode 100644 index 0000000000..7ef7e6ed96 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getViewContext](./browser-rum-core.rumpublicapi.getviewcontext.md) + +## RumPublicApi.getViewContext property + +Get View Context. + +**Signature:** + +```typescript +getViewContext: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md new file mode 100644 index 0000000000..b46b91d029 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [init](./browser-rum-core.rumpublicapi.init.md) + +## RumPublicApi.init property + +Init the RUM browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: RumInitConfiguration) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.md new file mode 100644 index 0000000000..a09847e2a8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.md @@ -0,0 +1,748 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) + +## RumPublicApi interface + +**Signature:** + +```typescript +export interface RumPublicApi extends PublicApi +``` +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[addAction](./browser-rum-core.rumpublicapi.addaction.md) + + + + + + + +(name: string, context?: object) => void + + + + +Add a custom action, stored in `@action` + + +
+ +[addDurationVital](./browser-rum-core.rumpublicapi.adddurationvital.md) + + + + + + + +(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void + + + + +Add a custom duration vital + + +
+ +[addError](./browser-rum-core.rumpublicapi.adderror.md) + + + + + + + +(error: unknown, context?: object) => void + + + + +Add a custom error, stored in `@error`. + + +
+ +[addFeatureFlagEvaluation](./browser-rum-core.rumpublicapi.addfeatureflagevaluation.md) + + + + + + + +(key: string, value: any) => void + + + + +Add a feature flag evaluation, stored in `@feature_flags.` + + +
+ +[addTiming](./browser-rum-core.rumpublicapi.addtiming.md) + + + + + + + +(name: string, time?: number) => void + + + + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + + +
+ +[clearAccount](./browser-rum-core.rumpublicapi.clearaccount.md) + + + + + + + +() => void + + + + +Clear all account information + + +
+ +[clearGlobalContext](./browser-rum-core.rumpublicapi.clearglobalcontext.md) + + + + + + + +() => void + + + + +Clear the global context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + + +
+ +[clearUser](./browser-rum-core.rumpublicapi.clearuser.md) + + + + + + + +() => void + + + + +Clear all user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + + +
+ +[getAccount](./browser-rum-core.rumpublicapi.getaccount.md) + + + + + + + +() => Context + + + + +Get account information + + +
+ +[getGlobalContext](./browser-rum-core.rumpublicapi.getglobalcontext.md) + + + + + + + +() => Context + + + + +Get the global Context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + + +
+ +[getInitConfiguration](./browser-rum-core.rumpublicapi.getinitconfiguration.md) + + + + + + + +() => [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) \| undefined + + + + +Get the init configuration + + +
+ +[getInternalContext](./browser-rum-core.rumpublicapi.getinternalcontext.md) + + + + + + + +(startTime?: number) => InternalContext \| undefined + + + + +\[Internal API\] Get the internal SDK context + + +
+ +[getSessionReplayLink](./browser-rum-core.rumpublicapi.getsessionreplaylink.md) + + + + + + + +() => string \| undefined + + + + +Get the Session Replay Link. + +See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + + +
+ +[getUser](./browser-rum-core.rumpublicapi.getuser.md) + + + + + + + +() => Context + + + + +Get user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + + +
+ +[getViewContext](./browser-rum-core.rumpublicapi.getviewcontext.md) + + + + + + + +() => Context + + + + +Get View Context. + + +
+ +[init](./browser-rum-core.rumpublicapi.init.md) + + + + + + + +(initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md)) => void + + + + +Init the RUM browser SDK. + + +
+ +[removeAccountProperty](./browser-rum-core.rumpublicapi.removeaccountproperty.md) + + + + + + + +(key: string) => void + + + + +Remove an account property + + +
+ +[removeGlobalContextProperty](./browser-rum-core.rumpublicapi.removeglobalcontextproperty.md) + + + + + + + +(key: any) => void + + + + +Remove a global context property + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + + +
+ +[removeUserProperty](./browser-rum-core.rumpublicapi.removeuserproperty.md) + + + + + + + +(key: any) => void + + + + +Remove a user property + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + + +
+ +[setAccount](./browser-rum-core.rumpublicapi.setaccount.md) + + + + + + + +(newAccount: Account) => void + + + + +Set account information to all events, stored in `@account` + + +
+ +[setAccountProperty](./browser-rum-core.rumpublicapi.setaccountproperty.md) + + + + + + + +(key: string, property: any) => void + + + + +Set or update the account property, stored in `@account.` + + +
+ +[setGlobalContext](./browser-rum-core.rumpublicapi.setglobalcontext.md) + + + + + + + +(context: any) => void + + + + +Set the global context information to all events, stored in `@context` + + +
+ +[setGlobalContextProperty](./browser-rum-core.rumpublicapi.setglobalcontextproperty.md) + + + + + + + +(key: any, value: any) => void + + + + +Set or update a global context property, stored in `@context.` + + +
+ +[setTrackingConsent](./browser-rum-core.rumpublicapi.settrackingconsent.md) + + + + + + + +(trackingConsent: TrackingConsent) => void + + + + +Set the tracking consent of the current user. + + +
+ +[setUserProperty](./browser-rum-core.rumpublicapi.setuserproperty.md) + + + + + + + +(key: any, property: any) => void + + + + +Set or update the user property, stored in `@usr.` + + +
+ +[setViewContext](./browser-rum-core.rumpublicapi.setviewcontext.md) + + + + + + + +(context: Context) => void + + + + +Set View Context. + +Enable to manually set the context of the current view. + + +
+ +[setViewContextProperty](./browser-rum-core.rumpublicapi.setviewcontextproperty.md) + + + + + + + +(key: string, value: any) => void + + + + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + + +
+ +[setViewName](./browser-rum-core.rumpublicapi.setviewname.md) + + + + + + + +(name: string) => void + + + + +Set View Name. + +Enable to manually change the name of the current view. + + +
+ +[startDurationVital](./browser-rum-core.rumpublicapi.startdurationvital.md) + + + + + + + +(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference + + + + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + + +
+ +[startSessionReplayRecording](./browser-rum-core.rumpublicapi.startsessionreplayrecording.md) + + + + + + + +(options?: [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md)) => void + + + + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + + +
+ +[startView](./browser-rum-core.rumpublicapi.startview.md) + + + + + + + +{ (name?: string): void; (options: ViewOptions): void; } + + + + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + + +
+ +[stopDurationVital](./browser-rum-core.rumpublicapi.stopdurationvital.md) + + + + + + + +(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void + + + + +Stop a custom duration vital + + +
+ +[stopSession](./browser-rum-core.rumpublicapi.stopsession.md) + + + + + + + +() => void + + + + +Stop the session. A new session will start at the next user interaction with the page. + + +
+ +[stopSessionReplayRecording](./browser-rum-core.rumpublicapi.stopsessionreplayrecording.md) + + + + + + + +() => void + + + + +Stop Session Replay recording. + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + + +
+ +## Methods + + + + +
+ +Method + + + + +Description + + +
+ +[setUser(newUser)](./browser-rum-core.rumpublicapi.setuser.md) + + + + +Set user information to all events, stored in `@usr` + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + + +
+ +[setUser(newUser)](./browser-rum-core.rumpublicapi.setuser_1.md) + + + + +Set user information to all events, stored in `@usr` + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md new file mode 100644 index 0000000000..1e72715131 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeAccountProperty](./browser-rum-core.rumpublicapi.removeaccountproperty.md) + +## RumPublicApi.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md new file mode 100644 index 0000000000..487a3b190a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeGlobalContextProperty](./browser-rum-core.rumpublicapi.removeglobalcontextproperty.md) + +## RumPublicApi.removeGlobalContextProperty property + +Remove a global context property + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md new file mode 100644 index 0000000000..6d04db69d6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeUserProperty](./browser-rum-core.rumpublicapi.removeuserproperty.md) + +## RumPublicApi.removeUserProperty property + +Remove a user property + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md new file mode 100644 index 0000000000..f463c57dec --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setAccount](./browser-rum-core.rumpublicapi.setaccount.md) + +## RumPublicApi.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md new file mode 100644 index 0000000000..db6da70569 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setAccountProperty](./browser-rum-core.rumpublicapi.setaccountproperty.md) + +## RumPublicApi.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md new file mode 100644 index 0000000000..9e3af8164a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setGlobalContext](./browser-rum-core.rumpublicapi.setglobalcontext.md) + +## RumPublicApi.setGlobalContext property + +Set the global context information to all events, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md new file mode 100644 index 0000000000..d20aa6172d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setGlobalContextProperty](./browser-rum-core.rumpublicapi.setglobalcontextproperty.md) + +## RumPublicApi.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md new file mode 100644 index 0000000000..2f3e1eb1e7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setTrackingConsent](./browser-rum-core.rumpublicapi.settrackingconsent.md) + +## RumPublicApi.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md new file mode 100644 index 0000000000..4a1029dc43 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUser](./browser-rum-core.rumpublicapi.setuser.md) + +## RumPublicApi.setUser() method + +Set user information to all events, stored in `@usr` + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User & { id: string; } + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md new file mode 100644 index 0000000000..892eea7293 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUser](./browser-rum-core.rumpublicapi.setuser_1.md) + +## RumPublicApi.setUser() method + +> Warning: This API is now obsolete. +> +> You must specify a user id +> + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User + + + + + +
+**Returns:** + +void + diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md new file mode 100644 index 0000000000..a264114577 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUserProperty](./browser-rum-core.rumpublicapi.setuserproperty.md) + +## RumPublicApi.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md new file mode 100644 index 0000000000..16bf10583f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewContext](./browser-rum-core.rumpublicapi.setviewcontext.md) + +## RumPublicApi.setViewContext property + +Set View Context. + +Enable to manually set the context of the current view. + +**Signature:** + +```typescript +setViewContext: (context: Context) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md new file mode 100644 index 0000000000..a56ff6bdf3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewContextProperty](./browser-rum-core.rumpublicapi.setviewcontextproperty.md) + +## RumPublicApi.setViewContextProperty property + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + +**Signature:** + +```typescript +setViewContextProperty: (key: string, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md new file mode 100644 index 0000000000..e15dff70be --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewName](./browser-rum-core.rumpublicapi.setviewname.md) + +## RumPublicApi.setViewName property + +Set View Name. + +Enable to manually change the name of the current view. + +**Signature:** + +```typescript +setViewName: (name: string) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md new file mode 100644 index 0000000000..1c93445920 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startDurationVital](./browser-rum-core.rumpublicapi.startdurationvital.md) + +## RumPublicApi.startDurationVital property + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + +**Signature:** + +```typescript +startDurationVital: (name: string, options?: { + context?: object; + description?: string; + }) => DurationVitalReference; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md new file mode 100644 index 0000000000..209e9304c0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startSessionReplayRecording](./browser-rum-core.rumpublicapi.startsessionreplayrecording.md) + +## RumPublicApi.startSessionReplayRecording property + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + +**Signature:** + +```typescript +startSessionReplayRecording: (options?: StartRecordingOptions) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md new file mode 100644 index 0000000000..147d1ac594 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startView](./browser-rum-core.rumpublicapi.startview.md) + +## RumPublicApi.startView property + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + +**Signature:** + +```typescript +startView: { + (name?: string): void; + (options: ViewOptions): void; + }; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md new file mode 100644 index 0000000000..dcfebfb861 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopDurationVital](./browser-rum-core.rumpublicapi.stopdurationvital.md) + +## RumPublicApi.stopDurationVital property + +Stop a custom duration vital + +**Signature:** + +```typescript +stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md new file mode 100644 index 0000000000..eab79179bb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopSession](./browser-rum-core.rumpublicapi.stopsession.md) + +## RumPublicApi.stopSession property + +Stop the session. A new session will start at the next user interaction with the page. + +**Signature:** + +```typescript +stopSession: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md new file mode 100644 index 0000000000..740a2fc823 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopSessionReplayRecording](./browser-rum-core.rumpublicapi.stopsessionreplayrecording.md) + +## RumPublicApi.stopSessionReplayRecording property + +Stop Session Replay recording. + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + +**Signature:** + +```typescript +stopSessionReplayRecording: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumresourceevent.md b/docs/api-reference/rum/browser-rum-core.rumresourceevent.md new file mode 100644 index 0000000000..4407d7d8b2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumresourceevent.md @@ -0,0 +1,89 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumResourceEvent](./browser-rum-core.rumresourceevent.md) + +## RumResourceEvent type + +Schema of all properties of a Resource event + +**Signature:** + +```typescript +export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'resource'; + readonly resource: { + readonly id?: string; + readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; + readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + url: string; + readonly status_code?: number; + readonly duration?: number; + readonly size?: number; + readonly encoded_body_size?: number; + readonly decoded_body_size?: number; + readonly transfer_size?: number; + readonly render_blocking_status?: 'blocking' | 'non-blocking'; + readonly worker?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly redirect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly dns?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly connect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly ssl?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly first_byte?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly download?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly protocol?: string; + readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + readonly graphql?: { + readonly operationType: 'query' | 'mutation' | 'subscription'; + readonly operationName?: string; + payload?: string; + variables?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly span_id?: string; + readonly trace_id?: string; + readonly rule_psr?: number; + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumsession.md b/docs/api-reference/rum/browser-rum-core.rumsession.md new file mode 100644 index 0000000000..74683739e9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsession.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSession](./browser-rum-core.rumsession.md) + +## RumSession type + +**Signature:** + +```typescript +export type RumSession = { + id: string; + sessionReplay: SessionReplayState; + anonymousId?: string; +}; +``` +**References:** [SessionReplayState](./browser-rum-core.sessionreplaystate.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md new file mode 100644 index 0000000000..9b53fe5db7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [expire](./browser-rum-core.rumsessionmanager.expire.md) + +## RumSessionManager.expire property + +**Signature:** + +```typescript +expire: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md new file mode 100644 index 0000000000..e1ab0e3b46 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [expireObservable](./browser-rum-core.rumsessionmanager.expireobservable.md) + +## RumSessionManager.expireObservable property + +**Signature:** + +```typescript +expireObservable: Observable; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md new file mode 100644 index 0000000000..f2c6d12db4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [findTrackedSession](./browser-rum-core.rumsessionmanager.findtrackedsession.md) + +## RumSessionManager.findTrackedSession property + +**Signature:** + +```typescript +findTrackedSession: (startTime?: RelativeTime) => RumSession | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md new file mode 100644 index 0000000000..f5c62131a9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md @@ -0,0 +1,104 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) + +## RumSessionManager interface + +**Signature:** + +```typescript +export interface RumSessionManager +``` + +## Properties + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[expire](./browser-rum-core.rumsessionmanager.expire.md) + + + + + + + +() => void + + + + + +
+ +[expireObservable](./browser-rum-core.rumsessionmanager.expireobservable.md) + + + + + + + +Observable<void> + + + + + +
+ +[findTrackedSession](./browser-rum-core.rumsessionmanager.findtrackedsession.md) + + + + + + + +(startTime?: RelativeTime) => [RumSession](./browser-rum-core.rumsession.md) \| undefined + + + + + +
+ +[setForcedReplay](./browser-rum-core.rumsessionmanager.setforcedreplay.md) + + + + + + + +() => void + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md new file mode 100644 index 0000000000..e0a257b648 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [setForcedReplay](./browser-rum-core.rumsessionmanager.setforcedreplay.md) + +## RumSessionManager.setForcedReplay property + +**Signature:** + +```typescript +setForcedReplay: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumviewevent.md b/docs/api-reference/rum/browser-rum-core.rumviewevent.md new file mode 100644 index 0000000000..6374efce04 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumviewevent.md @@ -0,0 +1,143 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEvent](./browser-rum-core.rumviewevent.md) + +## RumViewEvent type + +Schema of all properties of a View event + +**Signature:** + +```typescript +export type RumViewEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'view'; + readonly view: { + readonly loading_time?: number; + readonly network_settled_time?: number; + readonly interaction_to_next_view_time?: number; + readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; + readonly time_spent: number; + readonly first_contentful_paint?: number; + readonly largest_contentful_paint?: number; + readonly largest_contentful_paint_target_selector?: string; + readonly first_input_delay?: number; + readonly first_input_time?: number; + readonly first_input_target_selector?: string; + readonly interaction_to_next_paint?: number; + readonly interaction_to_next_paint_time?: number; + readonly interaction_to_next_paint_target_selector?: string; + readonly cumulative_layout_shift?: number; + readonly cumulative_layout_shift_time?: number; + readonly cumulative_layout_shift_target_selector?: string; + readonly dom_complete?: number; + readonly dom_content_loaded?: number; + readonly dom_interactive?: number; + readonly load_event?: number; + readonly first_byte?: number; + readonly custom_timings?: { + [k: string]: number; + }; + readonly is_active?: boolean; + readonly is_slow_rendered?: boolean; + readonly action: { + readonly count: number; + [k: string]: unknown; + }; + readonly error: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly frozen_frame?: { + readonly count: number; + [k: string]: unknown; + }; + readonly slow_frames?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly resource: { + readonly count: number; + [k: string]: unknown; + }; + readonly frustration?: { + readonly count: number; + [k: string]: unknown; + }; + readonly in_foreground_periods?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly memory_average?: number; + readonly memory_max?: number; + readonly cpu_ticks_count?: number; + readonly cpu_ticks_per_second?: number; + readonly refresh_rate_average?: number; + readonly refresh_rate_min?: number; + readonly slow_frames_rate?: number; + readonly freeze_rate?: number; + flutter_build_time?: RumPerfMetric; + flutter_raster_time?: RumPerfMetric; + js_refresh_rate?: RumPerfMetric; + performance?: ViewPerformanceData; + [k: string]: unknown; + }; + readonly session?: { + readonly is_active?: boolean; + readonly sampled_for_replay?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + readonly privacy?: { + readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; + [k: string]: unknown; + }; + readonly _dd: { + readonly document_version: number; + readonly page_states?: { + readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; + readonly start: number; + [k: string]: unknown; + }[]; + replay_stats?: { + records_count?: number; + segments_count?: number; + segments_total_raw_size?: number; + [k: string]: unknown; + }; + readonly cls?: { + readonly device_pixel_ratio?: number; + [k: string]: unknown; + }; + readonly configuration?: { + readonly start_session_replay_recording_manually?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly display?: { + readonly scroll?: { + readonly max_depth: number; + readonly max_depth_scroll_top: number; + readonly max_scroll_height: number; + readonly max_scroll_height_time: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md b/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md new file mode 100644 index 0000000000..1f072ad8da --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) > [location](./browser-rum-core.rumvieweventdomaincontext.location.md) + +## RumViewEventDomainContext.location property + +**Signature:** + +```typescript +location: Readonly; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md new file mode 100644 index 0000000000..9cf75d7501 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) + +## RumViewEventDomainContext interface + +**Signature:** + +```typescript +export interface RumViewEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[location](./browser-rum-core.rumvieweventdomaincontext.location.md) + + + + + + + +Readonly<Location> + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumvitalevent.md b/docs/api-reference/rum/browser-rum-core.rumvitalevent.md new file mode 100644 index 0000000000..4b05a338ca --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumvitalevent.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumVitalEvent](./browser-rum-core.rumvitalevent.md) + +## RumVitalEvent type + +Schema of all properties of a Vital event + +**Signature:** + +```typescript +export type RumVitalEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'vital'; + readonly vital: { + readonly type: 'duration'; + readonly id: string; + readonly name?: string; + readonly description?: string; + readonly duration?: number; + readonly custom?: { + [k: string]: number; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly vital?: { + readonly computed_value?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** [CommonProperties](./browser-rum-core.commonproperties.md) + diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..50fc15352c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [handlingStack](./browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md) + +## RumXhrResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md new file mode 100644 index 0000000000..3df4817c78 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [isAborted](./browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md) + +## RumXhrResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md new file mode 100644 index 0000000000..072c0f9c92 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md @@ -0,0 +1,108 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) + +## RumXhrResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumXhrResourceEventDomainContext +``` + +## Properties + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[handlingStack?](./browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[isAborted](./browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md) + + + + + + + +boolean + + + + + +
+ +[performanceEntry?](./browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md) + + + + + + + +PerformanceEntry + + + + +_(Optional)_ + + +
+ +[xhr](./browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md) + + + + + + + +XMLHttpRequest + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..addf41c78c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md) + +## RumXhrResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md new file mode 100644 index 0000000000..a6efc70dd7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [xhr](./browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md) + +## RumXhrResourceEventDomainContext.xhr property + +**Signature:** + +```typescript +xhr: XMLHttpRequest; +``` diff --git a/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md b/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md new file mode 100644 index 0000000000..ddd7896f4a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [sanitizeDataUrl](./browser-rum-core.sanitizedataurl.md) + +## sanitizeDataUrl() function + +**Signature:** + +```typescript +export declare function sanitizeDataUrl(url: string): string; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + + +
+**Returns:** + +string + diff --git a/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md b/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md new file mode 100644 index 0000000000..e547ebb84a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md @@ -0,0 +1,73 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [SessionReplayState](./browser-rum-core.sessionreplaystate.md) + +## SessionReplayState enum + +**Signature:** + +```typescript +export declare const enum SessionReplayState +``` + +## Enumeration Members + + + + + +
+ +Member + + + + +Value + + + + +Description + + +
+ +FORCED + + + + +`2` + + + + + +
+ +OFF + + + + +`0` + + + + + +
+ +SAMPLED + + + + +`1` + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md b/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md new file mode 100644 index 0000000000..821eb502d8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [shouldIgnoreElement](./browser-rum-core.shouldignoreelement.md) + +## shouldIgnoreElement() function + +TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag. + +**Signature:** + +```typescript +export declare function shouldIgnoreElement(element: Element): boolean; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +element + + + + +Element + + + + + +
+**Returns:** + +boolean + diff --git a/docs/api-reference/rum/browser-rum-core.shouldmasknode.md b/docs/api-reference/rum/browser-rum-core.shouldmasknode.md new file mode 100644 index 0000000000..79a7994f5d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.shouldmasknode.md @@ -0,0 +1,71 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [shouldMaskNode](./browser-rum-core.shouldmasknode.md) + +## shouldMaskNode() function + +Helper aiming to unify `mask` and `mask-user-input` privacy levels: + +In the `mask` case, it is trivial: we should mask the element. + +In the `mask-user-input` case, we should mask the element only if it is a "form" element or the direct parent is a form element for text nodes). + +Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized). + +**Signature:** + +```typescript +export declare function shouldMaskNode(node: Node, privacyLevel: NodePrivacyLevel): boolean; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +Node + + + + + +
+ +privacyLevel + + + + +[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) + + + + + +
+**Returns:** + +boolean + diff --git a/docs/api-reference/rum/browser-rum-core.stable_attributes.md b/docs/api-reference/rum/browser-rum-core.stable_attributes.md new file mode 100644 index 0000000000..5380a11f09 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.stable_attributes.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [STABLE\_ATTRIBUTES](./browser-rum-core.stable_attributes.md) + +## STABLE\_ATTRIBUTES variable + +Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document. + +**Signature:** + +```typescript +STABLE_ATTRIBUTES: string[] +``` diff --git a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md new file mode 100644 index 0000000000..a8e8056406 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) > [force](./browser-rum-core.startrecordingoptions.force.md) + +## StartRecordingOptions.force property + +**Signature:** + +```typescript +force: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md new file mode 100644 index 0000000000..0d41cdf510 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) + +## StartRecordingOptions interface + +**Signature:** + +```typescript +export interface StartRecordingOptions +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[force](./browser-rum-core.startrecordingoptions.force.md) + + + + + + + +boolean + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.startrum.md b/docs/api-reference/rum/browser-rum-core.startrum.md new file mode 100644 index 0000000000..f4718de728 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.startrum.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRum](./browser-rum-core.startrum.md) + +## StartRum type + +**Signature:** + +```typescript +export type StartRum = typeof startRum; +``` diff --git a/docs/api-reference/rum/browser-rum-core.startviewhistory.md b/docs/api-reference/rum/browser-rum-core.startviewhistory.md new file mode 100644 index 0000000000..f938a1d7c0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.startviewhistory.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [startViewHistory](./browser-rum-core.startviewhistory.md) + +## startViewHistory() function + +**Signature:** + +```typescript +export declare function startViewHistory(lifeCycle: LifeCycle): ViewHistory; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +lifeCycle + + + + +[LifeCycle](./browser-rum-core.lifecycle.md) + + + + + +
+**Returns:** + +[ViewHistory](./browser-rum-core.viewhistory.md) + diff --git a/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md new file mode 100644 index 0000000000..82e7c4262c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [accountContext](./browser-rum-core.strategy.accountcontext.md) + +## Strategy.accountContext property + +**Signature:** + +```typescript +accountContext: ContextManager; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addaction.md b/docs/api-reference/rum/browser-rum-core.strategy.addaction.md new file mode 100644 index 0000000000..0b0e5cae3c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.addaction.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addAction](./browser-rum-core.strategy.addaction.md) + +## Strategy.addAction property + +**Signature:** + +```typescript +addAction: StartRumResult['addAction']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md new file mode 100644 index 0000000000..492ae4c22e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addDurationVital](./browser-rum-core.strategy.adddurationvital.md) + +## Strategy.addDurationVital property + +**Signature:** + +```typescript +addDurationVital: StartRumResult['addDurationVital']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.adderror.md b/docs/api-reference/rum/browser-rum-core.strategy.adderror.md new file mode 100644 index 0000000000..19d42b97fe --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.adderror.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addError](./browser-rum-core.strategy.adderror.md) + +## Strategy.addError property + +**Signature:** + +```typescript +addError: StartRumResult['addError']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md b/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md new file mode 100644 index 0000000000..8d573526a3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addFeatureFlagEvaluation](./browser-rum-core.strategy.addfeatureflagevaluation.md) + +## Strategy.addFeatureFlagEvaluation property + +**Signature:** + +```typescript +addFeatureFlagEvaluation: StartRumResult['addFeatureFlagEvaluation']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md b/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md new file mode 100644 index 0000000000..045f535c99 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addTiming](./browser-rum-core.strategy.addtiming.md) + +## Strategy.addTiming property + +**Signature:** + +```typescript +addTiming: StartRumResult['addTiming']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md new file mode 100644 index 0000000000..1b92853fa7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [getInternalContext](./browser-rum-core.strategy.getinternalcontext.md) + +## Strategy.getInternalContext property + +**Signature:** + +```typescript +getInternalContext: StartRumResult['getInternalContext']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md new file mode 100644 index 0000000000..9b7a783f1f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [getViewContext](./browser-rum-core.strategy.getviewcontext.md) + +## Strategy.getViewContext property + +**Signature:** + +```typescript +getViewContext: StartRumResult['getViewContext']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md new file mode 100644 index 0000000000..3a8adf6d6f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [globalContext](./browser-rum-core.strategy.globalcontext.md) + +## Strategy.globalContext property + +**Signature:** + +```typescript +globalContext: ContextManager; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.init.md b/docs/api-reference/rum/browser-rum-core.strategy.init.md new file mode 100644 index 0000000000..64ef69ae2b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.init.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [init](./browser-rum-core.strategy.init.md) + +## Strategy.init property + +**Signature:** + +```typescript +init: (initConfiguration: RumInitConfiguration, publicApi: RumPublicApi) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md b/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md new file mode 100644 index 0000000000..e945f0e18f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [initConfiguration](./browser-rum-core.strategy.initconfiguration.md) + +## Strategy.initConfiguration property + +**Signature:** + +```typescript +initConfiguration: RumInitConfiguration | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.md b/docs/api-reference/rum/browser-rum-core.strategy.md new file mode 100644 index 0000000000..2e6d935159 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.md @@ -0,0 +1,359 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) + +## Strategy interface + +**Signature:** + +```typescript +export interface Strategy +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[accountContext](./browser-rum-core.strategy.accountcontext.md) + + + + + + + +ContextManager + + + + + +
+ +[addAction](./browser-rum-core.strategy.addaction.md) + + + + + + + +StartRumResult\['addAction'\] + + + + + +
+ +[addDurationVital](./browser-rum-core.strategy.adddurationvital.md) + + + + + + + +StartRumResult\['addDurationVital'\] + + + + + +
+ +[addError](./browser-rum-core.strategy.adderror.md) + + + + + + + +StartRumResult\['addError'\] + + + + + +
+ +[addFeatureFlagEvaluation](./browser-rum-core.strategy.addfeatureflagevaluation.md) + + + + + + + +StartRumResult\['addFeatureFlagEvaluation'\] + + + + + +
+ +[addTiming](./browser-rum-core.strategy.addtiming.md) + + + + + + + +StartRumResult\['addTiming'\] + + + + + +
+ +[getInternalContext](./browser-rum-core.strategy.getinternalcontext.md) + + + + + + + +StartRumResult\['getInternalContext'\] + + + + + +
+ +[getViewContext](./browser-rum-core.strategy.getviewcontext.md) + + + + + + + +StartRumResult\['getViewContext'\] + + + + + +
+ +[globalContext](./browser-rum-core.strategy.globalcontext.md) + + + + + + + +ContextManager + + + + + +
+ +[init](./browser-rum-core.strategy.init.md) + + + + + + + +(initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md), publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md)) => void + + + + + +
+ +[initConfiguration](./browser-rum-core.strategy.initconfiguration.md) + + + + + + + +[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) \| undefined + + + + + +
+ +[setViewContext](./browser-rum-core.strategy.setviewcontext.md) + + + + + + + +StartRumResult\['setViewContext'\] + + + + + +
+ +[setViewContextProperty](./browser-rum-core.strategy.setviewcontextproperty.md) + + + + + + + +StartRumResult\['setViewContextProperty'\] + + + + + +
+ +[setViewName](./browser-rum-core.strategy.setviewname.md) + + + + + + + +StartRumResult\['setViewName'\] + + + + + +
+ +[startDurationVital](./browser-rum-core.strategy.startdurationvital.md) + + + + + + + +StartRumResult\['startDurationVital'\] + + + + + +
+ +[startView](./browser-rum-core.strategy.startview.md) + + + + + + + +StartRumResult\['startView'\] + + + + + +
+ +[stopDurationVital](./browser-rum-core.strategy.stopdurationvital.md) + + + + + + + +StartRumResult\['stopDurationVital'\] + + + + + +
+ +[stopSession](./browser-rum-core.strategy.stopsession.md) + + + + + + + +StartRumResult\['stopSession'\] + + + + + +
+ +[userContext](./browser-rum-core.strategy.usercontext.md) + + + + + + + +ContextManager + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md new file mode 100644 index 0000000000..3389137449 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewContext](./browser-rum-core.strategy.setviewcontext.md) + +## Strategy.setViewContext property + +**Signature:** + +```typescript +setViewContext: StartRumResult['setViewContext']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md new file mode 100644 index 0000000000..3a01f4be68 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewContextProperty](./browser-rum-core.strategy.setviewcontextproperty.md) + +## Strategy.setViewContextProperty property + +**Signature:** + +```typescript +setViewContextProperty: StartRumResult['setViewContextProperty']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md new file mode 100644 index 0000000000..ea91e72cbb --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewName](./browser-rum-core.strategy.setviewname.md) + +## Strategy.setViewName property + +**Signature:** + +```typescript +setViewName: StartRumResult['setViewName']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md new file mode 100644 index 0000000000..ab5c6f8082 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [startDurationVital](./browser-rum-core.strategy.startdurationvital.md) + +## Strategy.startDurationVital property + +**Signature:** + +```typescript +startDurationVital: StartRumResult['startDurationVital']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.startview.md b/docs/api-reference/rum/browser-rum-core.strategy.startview.md new file mode 100644 index 0000000000..f329810f4f --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.startview.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [startView](./browser-rum-core.strategy.startview.md) + +## Strategy.startView property + +**Signature:** + +```typescript +startView: StartRumResult['startView']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md new file mode 100644 index 0000000000..505f52321b --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [stopDurationVital](./browser-rum-core.strategy.stopdurationvital.md) + +## Strategy.stopDurationVital property + +**Signature:** + +```typescript +stopDurationVital: StartRumResult['stopDurationVital']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md b/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md new file mode 100644 index 0000000000..4f82c6e902 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [stopSession](./browser-rum-core.strategy.stopsession.md) + +## Strategy.stopSession property + +**Signature:** + +```typescript +stopSession: StartRumResult['stopSession']; +``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md b/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md new file mode 100644 index 0000000000..2cfbd23e99 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [userContext](./browser-rum-core.strategy.usercontext.md) + +## Strategy.userContext property + +**Signature:** + +```typescript +userContext: ContextManager; +``` diff --git a/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md b/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md new file mode 100644 index 0000000000..ff8427479d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [supportPerformanceTimingEvent](./browser-rum-core.supportperformancetimingevent.md) + +## supportPerformanceTimingEvent() function + +**Signature:** + +```typescript +export declare function supportPerformanceTimingEvent(entryType: RumPerformanceEntryType): boolean; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +entryType + + + + +[RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) + + + + + +
+**Returns:** + +boolean + diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md new file mode 100644 index 0000000000..dc979dfa8d --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [context](./browser-rum-core.viewcreatedevent.context.md) + +## ViewCreatedEvent.context property + +**Signature:** + +```typescript +context?: Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md new file mode 100644 index 0000000000..9737ab71ae --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [id](./browser-rum-core.viewcreatedevent.id.md) + +## ViewCreatedEvent.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md new file mode 100644 index 0000000000..6f6406f8ba --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md @@ -0,0 +1,146 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) + +## ViewCreatedEvent interface + +**Signature:** + +```typescript +export interface ViewCreatedEvent +``` + +## Properties + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[context?](./browser-rum-core.viewcreatedevent.context.md) + + + + + + + +Context + + + + +_(Optional)_ + + +
+ +[id](./browser-rum-core.viewcreatedevent.id.md) + + + + + + + +string + + + + + +
+ +[name?](./browser-rum-core.viewcreatedevent.name.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[service?](./browser-rum-core.viewcreatedevent.service.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[startClocks](./browser-rum-core.viewcreatedevent.startclocks.md) + + + + + + + +ClocksState + + + + + +
+ +[version?](./browser-rum-core.viewcreatedevent.version.md) + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md new file mode 100644 index 0000000000..68d639f5c9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [name](./browser-rum-core.viewcreatedevent.name.md) + +## ViewCreatedEvent.name property + +**Signature:** + +```typescript +name?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md new file mode 100644 index 0000000000..7e02fb7711 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [service](./browser-rum-core.viewcreatedevent.service.md) + +## ViewCreatedEvent.service property + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md new file mode 100644 index 0000000000..13a362c85e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [startClocks](./browser-rum-core.viewcreatedevent.startclocks.md) + +## ViewCreatedEvent.startClocks property + +**Signature:** + +```typescript +startClocks: ClocksState; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md new file mode 100644 index 0000000000..04918af655 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [version](./browser-rum-core.viewcreatedevent.version.md) + +## ViewCreatedEvent.version property + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md b/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md new file mode 100644 index 0000000000..304bc8077e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) > [findView](./browser-rum-core.viewhistory.findview.md) + +## ViewHistory.findView property + +**Signature:** + +```typescript +findView: (startTime?: RelativeTime) => ViewHistoryEntry | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.md b/docs/api-reference/rum/browser-rum-core.viewhistory.md new file mode 100644 index 0000000000..a9235c67b4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistory.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) + +## ViewHistory interface + +**Signature:** + +```typescript +export interface ViewHistory +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[findView](./browser-rum-core.viewhistory.findview.md) + + + + + + + +(startTime?: RelativeTime) => [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) \| undefined + + + + + +
+ +[stop](./browser-rum-core.viewhistory.stop.md) + + + + + + + +() => void + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md b/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md new file mode 100644 index 0000000000..4ea644985e --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) > [stop](./browser-rum-core.viewhistory.stop.md) + +## ViewHistory.stop property + +**Signature:** + +```typescript +stop: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md new file mode 100644 index 0000000000..3497d94212 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [context](./browser-rum-core.viewhistoryentry.context.md) + +## ViewHistoryEntry.context property + +**Signature:** + +```typescript +context?: Context | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md new file mode 100644 index 0000000000..819a21a1c4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [id](./browser-rum-core.viewhistoryentry.id.md) + +## ViewHistoryEntry.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md new file mode 100644 index 0000000000..03096486d4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md @@ -0,0 +1,165 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) + +## ViewHistoryEntry interface + +**Signature:** + +```typescript +export interface ViewHistoryEntry +``` + +## Properties + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[context?](./browser-rum-core.viewhistoryentry.context.md) + + + + + + + +Context \| undefined + + + + +_(Optional)_ + + +
+ +[id](./browser-rum-core.viewhistoryentry.id.md) + + + + + + + +string + + + + + +
+ +[name?](./browser-rum-core.viewhistoryentry.name.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[service?](./browser-rum-core.viewhistoryentry.service.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[sessionIsActive?](./browser-rum-core.viewhistoryentry.sessionisactive.md) + + + + + + + +boolean + + + + +_(Optional)_ + + +
+ +[startClocks](./browser-rum-core.viewhistoryentry.startclocks.md) + + + + + + + +ClocksState + + + + + +
+ +[version?](./browser-rum-core.viewhistoryentry.version.md) + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md new file mode 100644 index 0000000000..51383e7822 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [name](./browser-rum-core.viewhistoryentry.name.md) + +## ViewHistoryEntry.name property + +**Signature:** + +```typescript +name?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md new file mode 100644 index 0000000000..d82cefc957 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [service](./browser-rum-core.viewhistoryentry.service.md) + +## ViewHistoryEntry.service property + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md new file mode 100644 index 0000000000..78e1eb8a3a --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [sessionIsActive](./browser-rum-core.viewhistoryentry.sessionisactive.md) + +## ViewHistoryEntry.sessionIsActive property + +**Signature:** + +```typescript +sessionIsActive?: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md new file mode 100644 index 0000000000..ed3cc8f7cd --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [startClocks](./browser-rum-core.viewhistoryentry.startclocks.md) + +## ViewHistoryEntry.startClocks property + +**Signature:** + +```typescript +startClocks: ClocksState; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md new file mode 100644 index 0000000000..2b0a1788e9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [version](./browser-rum-core.viewhistoryentry.version.md) + +## ViewHistoryEntry.version property + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md new file mode 100644 index 0000000000..c7ca8f26c5 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) > [height](./browser-rum-core.viewportdimension.height.md) + +## ViewportDimension.height property + +**Signature:** + +```typescript +height: number; +``` diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.md new file mode 100644 index 0000000000..143b84e7c2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewportdimension.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) + +## ViewportDimension interface + +**Signature:** + +```typescript +export interface ViewportDimension +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[height](./browser-rum-core.viewportdimension.height.md) + + + + + + + +number + + + + + +
+ +[width](./browser-rum-core.viewportdimension.width.md) + + + + + + + +number + + + + + +
diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md new file mode 100644 index 0000000000..961607556c --- /dev/null +++ b/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) > [width](./browser-rum-core.viewportdimension.width.md) + +## ViewportDimension.width property + +**Signature:** + +```typescript +width: number; +``` diff --git a/docs/api-reference/rum/browser-rum-react.reactplugin.md b/docs/api-reference/rum/browser-rum-react.reactplugin.md index 14abf1f0ec..112b74f5e1 100644 --- a/docs/api-reference/rum/browser-rum-react.reactplugin.md +++ b/docs/api-reference/rum/browser-rum-react.reactplugin.md @@ -59,5 +59,5 @@ _(Optional)_ **Returns:** -{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } +{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md); publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md); }): void; onRumStart({ strategy }: { strategy: [Strategy](./browser-rum-core.strategy.md); }): void; getConfigurationTelemetry(): { router: boolean; }; } diff --git a/docs/api-reference/rum/index.md b/docs/api-reference/rum/index.md index 3b3651148c..58f50b67fc 100644 --- a/docs/api-reference/rum/index.md +++ b/docs/api-reference/rum/index.md @@ -34,6 +34,15 @@ Description + + + +[@datadog/browser-rum-core](./browser-rum-core.md) + + + + + diff --git a/etc/browser-rum-core.api.json b/etc/browser-rum-core.api.json new file mode 100644 index 0000000000..4727278894 --- /dev/null +++ b/etc/browser-rum-core.api.json @@ -0,0 +1,10481 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-core!", + "docComment": "", + "name": "@datadog/browser-rum-core", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-core!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!ActionType:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum ActionType " + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "ActionType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!ActionType.CLICK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CLICK = " + }, + { + "kind": "Content", + "text": "\"click\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CLICK" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!ActionType.CUSTOM:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CUSTOM = " + }, + { + "kind": "Content", + "text": "\"custom\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CUSTOM" + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!CENSORED_IMG_MARK:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CENSORED_IMG_MARK = " + }, + { + "kind": "Content", + "text": "\"data:image/gif;base64,R0lGODlhAQABAIAAAMLCwgAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "CENSORED_IMG_MARK", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!CENSORED_STRING_MARK:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CENSORED_STRING_MARK = " + }, + { + "kind": "Content", + "text": "\"***\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "CENSORED_STRING_MARK", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!censorText:var", + "docComment": "/**\n * Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "censorText: " + }, + { + "kind": "Content", + "text": "(text: string) => string" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "censorText", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface", + "docComment": "/**\n * Schema of common properties of RUM events\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CommonProperties " + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "CommonProperties", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#_dd:member", + "docComment": "/**\n * Internal properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly _dd: " + }, + { + "kind": "Content", + "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "_dd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#account:member", + "docComment": "/**\n * Account properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly account?: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "account", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#application:member", + "docComment": "/**\n * Application properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly application: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#build_id:member", + "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#build_version:member", + "docComment": "/**\n * The build version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#ci_test:member", + "docComment": "/**\n * CI Visibility properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly ci_test?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "ci_test", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#connectivity:member", + "docComment": "/**\n * Device connectivity properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "connectivity?: " + }, + { + "kind": "Content", + "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "connectivity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#context:member", + "docComment": "/**\n * User provided context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "{\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#date:member", + "docComment": "/**\n * Start of the event in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#device:member", + "docComment": "/**\n * Device properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "device?: " + }, + { + "kind": "Content", + "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "device", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#display:member", + "docComment": "/**\n * Display properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "display?: " + }, + { + "kind": "Content", + "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "display", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#os:member", + "docComment": "/**\n * Operating system properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "os?: " + }, + { + "kind": "Content", + "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "os", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#service:member", + "docComment": "/**\n * The service name for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly session: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#source:member", + "docComment": "/**\n * The source of this event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly source?: " + }, + { + "kind": "Content", + "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "source", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#synthetics:member", + "docComment": "/**\n * Synthetics properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly synthetics?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "synthetics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#usr:member", + "docComment": "/**\n * User properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly usr?: " + }, + { + "kind": "Content", + "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "usr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#version:member", + "docComment": "/**\n * The version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly view: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE:var", + "docComment": "/**\n * Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE = " + }, + { + "kind": "Content", + "text": "\"data-dd-action-name\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/action/getActionNameFromElement.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!forEachChildNodes:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function forEachChildNodes(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Content", + "text": "(child: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "isOptional": false + } + ], + "name": "forEachChildNodes" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!FORM_PRIVATE_TAG_NAMES:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FORM_PRIVATE_TAG_NAMES: " + }, + { + "kind": "Content", + "text": "{\n [tagName: string]: true;\n}" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "FORM_PRIVATE_TAG_NAMES", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!FrustrationType:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum FrustrationType " + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "FrustrationType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!FrustrationType.DEAD_CLICK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DEAD_CLICK = " + }, + { + "kind": "Content", + "text": "\"dead_click\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DEAD_CLICK" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!FrustrationType.ERROR_CLICK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ERROR_CLICK = " + }, + { + "kind": "Content", + "text": "\"error_click\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ERROR_CLICK" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!FrustrationType.RAGE_CLICK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RAGE_CLICK = " + }, + { + "kind": "Content", + "text": "\"rage_click\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RAGE_CLICK" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getMutationObserverConstructor:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getMutationObserverConstructor(): " + }, + { + "kind": "Reference", + "text": "MutationObserverConstructor", + "canonicalReference": "@datadog/browser-rum-core!~MutationObserverConstructor:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/domMutationObservable.d.ts", + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getMutationObserverConstructor" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getNodePrivacyLevel:function(1)", + "docComment": "/**\n * Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like:\n *\n * derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getNodePrivacyLevel(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ", defaultPrivacyLevel: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": ", cache?: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevelCache", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevelCache:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "defaultPrivacyLevel", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "cache", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "getNodePrivacyLevel" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getNodeSelfPrivacyLevel:function(1)", + "docComment": "/**\n * Determines the node's own privacy level without checking for ancestors.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getNodeSelfPrivacyLevel(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "getNodeSelfPrivacyLevel" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getParentNode:function(1)", + "docComment": "/**\n * Return `host` in case if the current node is a shadow root otherwise will return the `parentNode`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getParentNode(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "getParentNode" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getPrivacySelector:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getPrivacySelector(privacyLevel: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "privacyLevel", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "getPrivacySelector" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getScrollX:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getScrollX(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/scroll.d.ts", + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getScrollX" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getScrollY:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getScrollY(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/scroll.d.ts", + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getScrollY" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getSessionReplayUrl:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getSessionReplayUrl(configuration: " + }, + { + "kind": "Reference", + "text": "RumConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" + }, + { + "kind": "Content", + "text": ", { session, viewContext, errorType, }: " + }, + { + "kind": "Content", + "text": "{\n session?: " + }, + { + "kind": "Reference", + "text": "RumSession", + "canonicalReference": "@datadog/browser-rum-core!RumSession:type" + }, + { + "kind": "Content", + "text": ";\n viewContext?: " + }, + { + "kind": "Reference", + "text": "ViewHistoryEntry", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface" + }, + { + "kind": "Content", + "text": ";\n errorType?: string;\n}" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/getSessionReplayUrl.d.ts", + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "{ session, viewContext, errorType, }", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 8 + }, + "isOptional": false + } + ], + "name": "getSessionReplayUrl" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getTextContent:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getTextContent(textNode: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ", ignoreWhiteSpace: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ", parentNodePrivacyLevel: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "textNode", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "ignoreWhiteSpace", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "parentNodePrivacyLevel", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + } + ], + "name": "getTextContent" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!getViewportDimension:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function getViewportDimension(): " + }, + { + "kind": "Reference", + "text": "ViewportDimension", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getViewportDimension" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!hasChildNodes:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function hasChildNodes(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "hasChildNodes" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!initViewportObservable:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function initViewportObservable(configuration: " + }, + { + "kind": "Reference", + "text": "RumConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Observable", + "canonicalReference": "@datadog/browser-core!Observable:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ViewportDimension", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "initViewportObservable" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isCommentNode:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isCommentNode(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "node", + "canonicalReference": "@datadog/browser-rum-core!~node" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Comment", + "canonicalReference": "!Comment:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isCommentNode" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isElementNode:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isElementNode(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "node", + "canonicalReference": "@datadog/browser-rum-core!~node" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Element", + "canonicalReference": "!Element:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isElementNode" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isLongDataUrl:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isLongDataUrl(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isLongDataUrl" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isNodeShadowHost:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isNodeShadowHost(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "node", + "canonicalReference": "@datadog/browser-rum-core!~node" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Element", + "canonicalReference": "!Element:interface" + }, + { + "kind": "Content", + "text": " & {\n shadowRoot: " + }, + { + "kind": "Reference", + "text": "ShadowRoot", + "canonicalReference": "!ShadowRoot:interface" + }, + { + "kind": "Content", + "text": ";\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isNodeShadowHost" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isNodeShadowRoot:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isNodeShadowRoot(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "node", + "canonicalReference": "@datadog/browser-rum-core!~node" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "ShadowRoot", + "canonicalReference": "!ShadowRoot:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isNodeShadowRoot" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!isTextNode:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function isTextNode(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "node", + "canonicalReference": "@datadog/browser-rum-core!~node" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Text", + "canonicalReference": "!Text:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isTextNode" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type LifeCycle = " + }, + { + "kind": "Reference", + "text": "AbstractLifeCycle", + "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "LifeCycleEventMap", + "canonicalReference": "@datadog/browser-rum-core!~LifeCycleEventMap:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", + "releaseTag": "Public", + "name": "LifeCycle", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!LifeCycle:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LifeCycle: " + }, + { + "kind": "Content", + "text": "{\n new (): " + }, + { + "kind": "Reference", + "text": "AbstractLifeCycle", + "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "LifeCycleEventMap", + "canonicalReference": "@datadog/browser-rum-core!~LifeCycleEventMap:interface" + }, + { + "kind": "Content", + "text": ">;\n}" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "LifeCycle", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum LifeCycleEventType " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", + "releaseTag": "Public", + "name": "LifeCycleEventType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.AFTER_VIEW_ENDED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "AFTER_VIEW_ENDED = " + }, + { + "kind": "Content", + "text": "6" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "AFTER_VIEW_ENDED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.AUTO_ACTION_COMPLETED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "AUTO_ACTION_COMPLETED = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "AUTO_ACTION_COMPLETED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.BEFORE_VIEW_CREATED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "BEFORE_VIEW_CREATED = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "BEFORE_VIEW_CREATED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.BEFORE_VIEW_UPDATED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "BEFORE_VIEW_UPDATED = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "BEFORE_VIEW_UPDATED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.PAGE_MAY_EXIT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PAGE_MAY_EXIT = " + }, + { + "kind": "Content", + "text": "11" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PAGE_MAY_EXIT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RAW_ERROR_COLLECTED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RAW_ERROR_COLLECTED = " + }, + { + "kind": "Content", + "text": "14" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RAW_ERROR_COLLECTED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RAW_RUM_EVENT_COLLECTED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RAW_RUM_EVENT_COLLECTED = " + }, + { + "kind": "Content", + "text": "12" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RAW_RUM_EVENT_COLLECTED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.REQUEST_COMPLETED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "REQUEST_COMPLETED = " + }, + { + "kind": "Content", + "text": "8" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "REQUEST_COMPLETED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.REQUEST_STARTED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "REQUEST_STARTED = " + }, + { + "kind": "Content", + "text": "7" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "REQUEST_STARTED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RUM_EVENT_COLLECTED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RUM_EVENT_COLLECTED = " + }, + { + "kind": "Content", + "text": "13" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RUM_EVENT_COLLECTED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.SESSION_EXPIRED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "SESSION_EXPIRED = " + }, + { + "kind": "Content", + "text": "9" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "SESSION_EXPIRED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.SESSION_RENEWED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "SESSION_RENEWED = " + }, + { + "kind": "Content", + "text": "10" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "SESSION_RENEWED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_CREATED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VIEW_CREATED = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VIEW_CREATED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_ENDED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VIEW_ENDED = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VIEW_ENDED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_UPDATED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VIEW_UPDATED = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VIEW_UPDATED" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!makeRumPublicApi:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function makeRumPublicApi(startRumImpl: " + }, + { + "kind": "Reference", + "text": "StartRum", + "canonicalReference": "@datadog/browser-rum-core!StartRum:type" + }, + { + "kind": "Content", + "text": ", recorderApi: " + }, + { + "kind": "Reference", + "text": "RecorderApi", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface" + }, + { + "kind": "Content", + "text": ", profilerApi: " + }, + { + "kind": "Reference", + "text": "ProfilerApi", + "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "RumPublicApiOptions", + "canonicalReference": "@datadog/browser-rum-core!~RumPublicApiOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "startRumImpl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "recorderApi", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "profilerApi", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "name": "makeRumPublicApi" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!MAX_ATTRIBUTE_VALUE_CHAR_LENGTH:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "MAX_ATTRIBUTE_VALUE_CHAR_LENGTH = " + }, + { + "kind": "Content", + "text": "24000" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "MAX_ATTRIBUTE_VALUE_CHAR_LENGTH", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!MouseEventOnElement:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type MouseEventOnElement = " + }, + { + "kind": "Reference", + "text": "PointerEvent", + "canonicalReference": "!PointerEvent:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ExtraPointerEventFields", + "canonicalReference": "@datadog/browser-rum-core!~ExtraPointerEventFields:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/action/listenActionEvents.d.ts", + "releaseTag": "Public", + "name": "MouseEventOnElement", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type NodePrivacyLevel = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "releaseTag": "Public", + "name": "NodePrivacyLevel", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "NodePrivacyLevel: " + }, + { + "kind": "Content", + "text": "{\n readonly IGNORE: \"ignore\";\n readonly HIDDEN: \"hidden\";\n readonly ALLOW: \"allow\";\n readonly MASK: \"mask\";\n readonly MASK_USER_INPUT: \"mask-user-input\";\n}" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "NodePrivacyLevel", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevelCache:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type NodePrivacyLevelCache = " + }, + { + "kind": "Reference", + "text": "Map", + "canonicalReference": "!Map:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "releaseTag": "Public", + "name": "NodePrivacyLevelCache", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_NAME:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_ATTR_NAME = " + }, + { + "kind": "Content", + "text": "\"data-dd-privacy\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_ATTR_NAME", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_ALLOW:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_ATTR_VALUE_ALLOW = " + }, + { + "kind": "Content", + "text": "\"allow\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_ATTR_VALUE_ALLOW", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_HIDDEN:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_ATTR_VALUE_HIDDEN = " + }, + { + "kind": "Content", + "text": "\"hidden\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_ATTR_VALUE_HIDDEN", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_MASK_USER_INPUT:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_ATTR_VALUE_MASK_USER_INPUT = " + }, + { + "kind": "Content", + "text": "\"mask-user-input\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_ATTR_VALUE_MASK_USER_INPUT", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_MASK:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_ATTR_VALUE_MASK = " + }, + { + "kind": "Content", + "text": "\"mask\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_ATTR_VALUE_MASK", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!PRIVACY_CLASS_PREFIX:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVACY_CLASS_PREFIX = " + }, + { + "kind": "Content", + "text": "\"dd-privacy-\"" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "PRIVACY_CLASS_PREFIX", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ProfilerApi " + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "ProfilerApi", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ProfilerApi#onRumStart:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRumStart: " + }, + { + "kind": "Content", + "text": "(lifeCycle: " + }, + { + "kind": "Reference", + "text": "LifeCycle", + "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "RumConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" + }, + { + "kind": "Content", + "text": ", sessionManager: " + }, + { + "kind": "Reference", + "text": "RumSessionManager", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" + }, + { + "kind": "Content", + "text": ", viewHistory: " + }, + { + "kind": "Reference", + "text": "ViewHistory", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "onRumStart", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 10 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ProfilerApi#stop:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "stop: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stop", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RawRumActionEvent " + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RawRumActionEvent", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#_dd:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "_dd?: " + }, + { + "kind": "Content", + "text": "{\n action?: {\n target?: {\n selector?: string;\n width?: number;\n height?: number;\n };\n name_source?: string;\n position?: {\n x: number;\n y: number;\n };\n pointer_up_delay?: " + }, + { + "kind": "Reference", + "text": "Duration", + "canonicalReference": "@datadog/browser-core!Duration:type" + }, + { + "kind": "Content", + "text": ";\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "_dd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#action:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "action: " + }, + { + "kind": "Content", + "text": "{\n id: string;\n type: " + }, + { + "kind": "Reference", + "text": "ActionType", + "canonicalReference": "@datadog/browser-rum-core!ActionType:enum" + }, + { + "kind": "Content", + "text": ";\n loading_time?: " + }, + { + "kind": "Reference", + "text": "ServerDuration", + "canonicalReference": "@datadog/browser-core!ServerDuration:type" + }, + { + "kind": "Content", + "text": ";\n frustration?: {\n type: " + }, + { + "kind": "Reference", + "text": "FrustrationType", + "canonicalReference": "@datadog/browser-rum-core!FrustrationType:enum" + }, + { + "kind": "Content", + "text": "[];\n };\n error?: " + }, + { + "kind": "Reference", + "text": "Count", + "canonicalReference": "@datadog/browser-rum-core!~Count:interface" + }, + { + "kind": "Content", + "text": ";\n long_task?: " + }, + { + "kind": "Reference", + "text": "Count", + "canonicalReference": "@datadog/browser-rum-core!~Count:interface" + }, + { + "kind": "Content", + "text": ";\n resource?: " + }, + { + "kind": "Reference", + "text": "Count", + "canonicalReference": "@datadog/browser-rum-core!~Count:interface" + }, + { + "kind": "Content", + "text": ";\n target: {\n name: string;\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "action", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 14 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#date:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "date: " + }, + { + "kind": "Reference", + "text": "TimeStamp", + "canonicalReference": "@datadog/browser-core!TimeStamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "RumEventType.ACTION", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#view:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "view?: " + }, + { + "kind": "Content", + "text": "{\n in_foreground: boolean;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RawRumEvent:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RawRumEvent = " + }, + { + "kind": "Reference", + "text": "RawRumErrorEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumErrorEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumResourceEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumResourceEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumViewEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumViewEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumLongTaskEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumLongTaskEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumLongAnimationFrameEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumLongAnimationFrameEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumActionEvent", + "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RawRumVitalEvent", + "canonicalReference": "@datadog/browser-rum-core!~RawRumVitalEvent:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RawRumEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 14 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RawRumEventCollectedData " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "E", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "RawRumEventCollectedData", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#customerContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "customerContext?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "customerContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#domainContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "domainContext: " + }, + { + "kind": "Reference", + "text": "RumEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "domainContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#duration:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "duration?: " + }, + { + "kind": "Reference", + "text": "Duration", + "canonicalReference": "@datadog/browser-core!Duration:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "duration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#rawRumEvent:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "rawRumEvent: " + }, + { + "kind": "Content", + "text": "E" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "rawRumEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#startTime:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startTime: " + }, + { + "kind": "Reference", + "text": "RelativeTime", + "canonicalReference": "@datadog/browser-core!RelativeTime:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startTime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RecorderApi " + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "RecorderApi", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#getReplayStats:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getReplayStats: " + }, + { + "kind": "Content", + "text": "(viewId: string) => " + }, + { + "kind": "Reference", + "text": "ReplayStats", + "canonicalReference": "@datadog/browser-rum-core!ReplayStats:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getReplayStats", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#getSessionReplayLink:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSessionReplayLink: " + }, + { + "kind": "Content", + "text": "() => string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getSessionReplayLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#isRecording:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isRecording: " + }, + { + "kind": "Content", + "text": "() => boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#onRumStart:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRumStart: " + }, + { + "kind": "Content", + "text": "(lifeCycle: " + }, + { + "kind": "Reference", + "text": "LifeCycle", + "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "RumConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" + }, + { + "kind": "Content", + "text": ", sessionManager: " + }, + { + "kind": "Reference", + "text": "RumSessionManager", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" + }, + { + "kind": "Content", + "text": ", viewHistory: " + }, + { + "kind": "Reference", + "text": "ViewHistory", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" + }, + { + "kind": "Content", + "text": ", deflateWorker: " + }, + { + "kind": "Reference", + "text": "DeflateWorker", + "canonicalReference": "@datadog/browser-core!DeflateWorker:interface" + }, + { + "kind": "Content", + "text": " | undefined) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "onRumStart", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#start:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "start: " + }, + { + "kind": "Content", + "text": "(options?: " + }, + { + "kind": "Reference", + "text": "StartRecordingOptions", + "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "start", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi#stop:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "stop: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stop", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!reducePrivacyLevel:function(1)", + "docComment": "/**\n * Reduces the next privacy level based on self + parent privacy levels\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function reducePrivacyLevel(childPrivacyLevel: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ", parentNodePrivacyLevel: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "childPrivacyLevel", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + }, + { + "parameterName": "parentNodePrivacyLevel", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "isOptional": false + } + ], + "name": "reducePrivacyLevel" + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ReplayStats:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ReplayStats " + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "ReplayStats", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ReplayStats#records_count:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "records_count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "records_count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ReplayStats#segments_count:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "segments_count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "segments_count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ReplayStats#segments_total_raw_size:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "segments_total_raw_size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "segments_total_raw_size", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumActionEvent:type", + "docComment": "/**\n * Schema of all properties of an Action event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumActionEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumActionEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext#events:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "events?: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "!Event:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "events", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumConfiguration extends " + }, + { + "kind": "Reference", + "text": "Configuration", + "canonicalReference": "@datadog/browser-core!Configuration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/configuration/configuration.d.ts", + "releaseTag": "Public", + "name": "RumConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#actionNameAttribute:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionNameAttribute: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "actionNameAttribute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#allowedTracingUrls:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "allowedTracingUrls: " + }, + { + "kind": "Reference", + "text": "TracingOption", + "canonicalReference": "@datadog/browser-rum-core!~TracingOption:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "allowedTracingUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#applicationId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "applicationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#compressIntakeRequests:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "compressIntakeRequests: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "compressIntakeRequests", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#customerDataTelemetrySampleRate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "customerDataTelemetrySampleRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "customerDataTelemetrySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#defaultPrivacyLevel:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPrivacyLevel: " + }, + { + "kind": "Reference", + "text": "DefaultPrivacyLevel", + "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "defaultPrivacyLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#enablePrivacyForActionName:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "enablePrivacyForActionName: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "enablePrivacyForActionName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#excludedActivityUrls:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "excludedActivityUrls: " + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "excludedActivityUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#plugins:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "plugins: " + }, + { + "kind": "Reference", + "text": "RumPlugin", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "plugins", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#profilingSampleRate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "profilingSampleRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "profilingSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#propagateTraceBaggage:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "propagateTraceBaggage: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "propagateTraceBaggage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#rulePsr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "rulePsr: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "rulePsr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#sessionReplaySampleRate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionReplaySampleRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "sessionReplaySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#startSessionReplayRecordingManually:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecordingManually: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startSessionReplayRecordingManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#subdomain:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "subdomain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "subdomain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#traceContextInjection:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceContextInjection: " + }, + { + "kind": "Reference", + "text": "TraceContextInjection", + "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "traceContextInjection", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#traceSampleRate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceSampleRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "traceSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackFeatureFlagsForEvents:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackFeatureFlagsForEvents: " + }, + { + "kind": "Reference", + "text": "FeatureFlagsForEvents", + "canonicalReference": "@datadog/browser-rum-core!~FeatureFlagsForEvents:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "trackFeatureFlagsForEvents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackLongTasks:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackLongTasks: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "trackLongTasks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackResources:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackResources: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "trackResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackUserInteractions:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackUserInteractions: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "trackUserInteractions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackViewsManually:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackViewsManually: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "trackViewsManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#version:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#workerUrl:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "workerUrl: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "workerUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEvent:type", + "docComment": "/**\n * Schema of all properties of an Error event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumErrorEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumErrorEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumEvent:type", + "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEvent = " + }, + { + "kind": "Reference", + "text": "RumActionEvent", + "canonicalReference": "@datadog/browser-rum-core!RumActionEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumErrorEvent", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumLongTaskEvent", + "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumResourceEvent", + "canonicalReference": "@datadog/browser-rum-core!RumResourceEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumViewEvent", + "canonicalReference": "@datadog/browser-rum-core!RumViewEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumVitalEvent", + "canonicalReference": "@datadog/browser-rum-core!RumVitalEvent:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VIEW", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.VIEW:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumViewEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ACTION", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumActionEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.RESOURCE", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.RESOURCE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumFetchResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumXhrResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumOtherResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ERROR", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.ERROR:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumErrorEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.LONG_TASK", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.LONG_TASK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumLongTaskEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VITAL", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.VITAL:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumVitalEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!~RumVitalEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 34 + } + }, + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!RumEventType:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum RumEventType " + } + ], + "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumEventType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ACTION = " + }, + { + "kind": "Content", + "text": "\"action\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ACTION" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.ERROR:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ERROR = " + }, + { + "kind": "Content", + "text": "\"error\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ERROR" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.LONG_TASK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LONG_TASK = " + }, + { + "kind": "Content", + "text": "\"long_task\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "LONG_TASK" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.RESOURCE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RESOURCE = " + }, + { + "kind": "Content", + "text": "\"resource\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RESOURCE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.VIEW:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VIEW = " + }, + { + "kind": "Content", + "text": "\"view\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VIEW" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumEventType.VITAL:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VITAL = " + }, + { + "kind": "Content", + "text": "\"vital\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VITAL" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumFetchResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumFetchResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#requestInit:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInit?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "requestInit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#requestInput:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInput: " + }, + { + "kind": "Reference", + "text": "RequestInfo", + "canonicalReference": "!RequestInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "requestInput", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#response:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "response?: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "response", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/configuration/configuration.d.ts", + "releaseTag": "Public", + "name": "RumInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#actionNameAttribute:member", + "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionNameAttribute?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "actionNameAttribute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#allowedTracingUrls:member", + "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "allowedTracingUrls?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "TracingOption", + "canonicalReference": "@datadog/browser-rum-core!~TracingOption:type" + }, + { + "kind": "Content", + "text": "> | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "allowedTracingUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#applicationId:member", + "docComment": "/**\n * The RUM application ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applicationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "RumEvent", + "canonicalReference": "@datadog/browser-rum-core!RumEvent:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "RumEventDomainContext", + "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#compressIntakeRequests:member", + "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "compressIntakeRequests?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "compressIntakeRequests", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#defaultPrivacyLevel:member", + "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPrivacyLevel?: " + }, + { + "kind": "Reference", + "text": "DefaultPrivacyLevel", + "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "defaultPrivacyLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#enablePrivacyForActionName:member", + "docComment": "/**\n * Enables privacy control for action names.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enablePrivacyForActionName?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "enablePrivacyForActionName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#excludedActivityUrls:member", + "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "excludedActivityUrls?: " + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "excludedActivityUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#plugins:member", + "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "plugins?: " + }, + { + "kind": "Reference", + "text": "RumPlugin", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "plugins", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#profilingSampleRate:member", + "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "profilingSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "profilingSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#propagateTraceBaggage:member", + "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propagateTraceBaggage?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "propagateTraceBaggage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#remoteConfigurationId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "remoteConfigurationId?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "remoteConfigurationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#sessionReplaySampleRate:member", + "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionReplaySampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "sessionReplaySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#startSessionReplayRecordingManually:member", + "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecordingManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "startSessionReplayRecordingManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#subdomain:member", + "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subdomain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "subdomain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#traceContextInjection:member", + "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceContextInjection?: " + }, + { + "kind": "Reference", + "text": "TraceContextInjection", + "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceContextInjection", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#traceSampleRate:member", + "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackFeatureFlagsForEvents:member", + "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackFeatureFlagsForEvents?: " + }, + { + "kind": "Reference", + "text": "FeatureFlagsForEvents", + "canonicalReference": "@datadog/browser-rum-core!~FeatureFlagsForEvents:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackFeatureFlagsForEvents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackLongTasks:member", + "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackLongTasks?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackLongTasks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackResources:member", + "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackResources?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackUserInteractions:member", + "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackUserInteractions?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackUserInteractions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackViewsManually:member", + "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackViewsManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackViewsManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#workerUrl:member", + "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workerUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "workerUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEvent:type", + "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumLongTaskEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumLongTaskEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumOtherResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumOtherResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare enum RumPerformanceEntryType " + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/performanceObservable.d.ts", + "releaseTag": "Public", + "name": "RumPerformanceEntryType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.EVENT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "EVENT = " + }, + { + "kind": "Content", + "text": "\"event\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "EVENT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.FIRST_INPUT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FIRST_INPUT = " + }, + { + "kind": "Content", + "text": "\"first-input\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FIRST_INPUT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LARGEST_CONTENTFUL_PAINT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LARGEST_CONTENTFUL_PAINT = " + }, + { + "kind": "Content", + "text": "\"largest-contentful-paint\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "LARGEST_CONTENTFUL_PAINT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LAYOUT_SHIFT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LAYOUT_SHIFT = " + }, + { + "kind": "Content", + "text": "\"layout-shift\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "LAYOUT_SHIFT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LONG_ANIMATION_FRAME:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LONG_ANIMATION_FRAME = " + }, + { + "kind": "Content", + "text": "\"long-animation-frame\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "LONG_ANIMATION_FRAME" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LONG_TASK:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "LONG_TASK = " + }, + { + "kind": "Content", + "text": "\"longtask\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "LONG_TASK" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.NAVIGATION:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "NAVIGATION = " + }, + { + "kind": "Content", + "text": "\"navigation\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "NAVIGATION" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.PAINT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PAINT = " + }, + { + "kind": "Content", + "text": "\"paint\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PAINT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.RESOURCE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "RESOURCE = " + }, + { + "kind": "Content", + "text": "\"resource\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RESOURCE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.VISIBILITY_STATE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VISIBILITY_STATE = " + }, + { + "kind": "Content", + "text": "\"visibility-state\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VISIBILITY_STATE" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumPlugin " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/plugins.d.ts", + "releaseTag": "Public", + "name": "RumPlugin", + "preserveMemberOrder": false, + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin#getConfigurationTelemetry:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getConfigurationTelemetry?(): " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getConfigurationTelemetry" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin#name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin#onInit:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onInit?(options: " + }, + { + "kind": "Content", + "text": "{\n initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n publicApi: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isOptional": false + } + ], + "name": "onInit" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum-core!RumPlugin#onRumStart:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRumStart?(options: " + }, + { + "kind": "Content", + "text": "{\n strategy: " + }, + { + "kind": "Reference", + "text": "Strategy", + "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isOptional": false + } + ], + "name": "onRumStart" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "RumPublicApi", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addAction:member", + "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addAction: " + }, + { + "kind": "Content", + "text": "(name: string, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addDurationVital:member", + "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addError:member", + "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addError: " + }, + { + "kind": "Content", + "text": "(error: unknown, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addFeatureFlagEvaluation:member", + "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addFeatureFlagEvaluation: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addFeatureFlagEvaluation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addTiming:member", + "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addTiming: " + }, + { + "kind": "Content", + "text": "(name: string, time?: number) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addTiming", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-rum-core!~InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getSessionReplayLink:member", + "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSessionReplayLink: " + }, + { + "kind": "Content", + "text": "() => string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getSessionReplayLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getViewContext:member", + "docComment": "/**\n * Get View Context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getViewContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#init:member", + "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewContext:member", + "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContext: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewContextProperty:member", + "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContextProperty: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewName:member", + "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewName: " + }, + { + "kind": "Content", + "text": "(name: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startDurationVital:member", + "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startSessionReplayRecording:member", + "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "(options?: " + }, + { + "kind": "Reference", + "text": "StartRecordingOptions", + "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startView:member", + "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startView: " + }, + { + "kind": "Content", + "text": "{\n (name?: string): void;\n (options: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" + }, + { + "kind": "Content", + "text": "): void;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopDurationVital:member", + "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopDurationVital: " + }, + { + "kind": "Content", + "text": "(nameOrRef: string | " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopSession:member", + "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSession: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopSessionReplayRecording:member", + "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumResourceEvent:type", + "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumResourceEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumResourceEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumSession:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumSession = " + }, + { + "kind": "Content", + "text": "{\n id: string;\n sessionReplay: " + }, + { + "kind": "Reference", + "text": "SessionReplayState", + "canonicalReference": "@datadog/browser-rum-core!SessionReplayState:enum" + }, + { + "kind": "Content", + "text": ";\n anonymousId?: string;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", + "releaseTag": "Public", + "name": "RumSession", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumSessionManager " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", + "releaseTag": "Public", + "name": "RumSessionManager", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#expire:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expire: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "expire", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#expireObservable:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expireObservable: " + }, + { + "kind": "Reference", + "text": "Observable", + "canonicalReference": "@datadog/browser-core!Observable:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "expireObservable", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#findTrackedSession:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "findTrackedSession: " + }, + { + "kind": "Content", + "text": "(startTime?: " + }, + { + "kind": "Reference", + "text": "RelativeTime", + "canonicalReference": "@datadog/browser-core!RelativeTime:type" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "RumSession", + "canonicalReference": "@datadog/browser-rum-core!RumSession:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "findTrackedSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#setForcedReplay:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setForcedReplay: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setForcedReplay", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumViewEvent:type", + "docComment": "/**\n * Schema of all properties of a View event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumViewEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n flutter_raster_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n js_refresh_rate?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n performance?: " + }, + { + "kind": "Reference", + "text": "ViewPerformanceData", + "canonicalReference": "@datadog/browser-rum-core!~ViewPerformanceData:interface" + }, + { + "kind": "Content", + "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 13 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumViewEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext#location:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Location", + "canonicalReference": "!Location:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!RumVitalEvent:type", + "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumVitalEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumVitalEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumXhrResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumXhrResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#xhr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "xhr: " + }, + { + "kind": "Reference", + "text": "XMLHttpRequest", + "canonicalReference": "!XMLHttpRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "xhr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!sanitizeDataUrl:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function sanitizeDataUrl(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "sanitizeDataUrl" + }, + { + "kind": "Enum", + "canonicalReference": "@datadog/browser-rum-core!SessionReplayState:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare const enum SessionReplayState " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", + "releaseTag": "Public", + "name": "SessionReplayState", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.FORCED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FORCED = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FORCED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.OFF:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "OFF = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "OFF" + }, + { + "kind": "EnumMember", + "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.SAMPLED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "SAMPLED = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "SAMPLED" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!shouldIgnoreElement:function(1)", + "docComment": "/**\n * TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function shouldIgnoreElement(element: " + }, + { + "kind": "Reference", + "text": "Element", + "canonicalReference": "!Element:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "element", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "shouldIgnoreElement" + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!shouldMaskNode:function(1)", + "docComment": "/**\n * Helper aiming to unify `mask` and `mask-user-input` privacy levels:\n *\n * In the `mask` case, it is trivial: we should mask the element.\n *\n * In the `mask-user-input` case, we should mask the element only if it is a \"form\" element or the direct parent is a form element for text nodes).\n *\n * Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function shouldMaskNode(node: " + }, + { + "kind": "Reference", + "text": "Node", + "canonicalReference": "!Node:interface" + }, + { + "kind": "Content", + "text": ", privacyLevel: " + }, + { + "kind": "Reference", + "text": "NodePrivacyLevel", + "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "node", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "privacyLevel", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "name": "shouldMaskNode" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-core!STABLE_ATTRIBUTES:var", + "docComment": "/**\n * Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "STABLE_ATTRIBUTES: " + }, + { + "kind": "Content", + "text": "string[]" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/getSelectorFromElement.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "STABLE_ATTRIBUTES", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface StartRecordingOptions " + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "StartRecordingOptions", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions#force:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "force: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "force", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!startRum:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function startRum(configuration: " + }, + { + "kind": "Reference", + "text": "RumConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" + }, + { + "kind": "Content", + "text": ", recorderApi: " + }, + { + "kind": "Reference", + "text": "RecorderApi", + "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface" + }, + { + "kind": "Content", + "text": ", profilerApi: " + }, + { + "kind": "Reference", + "text": "ProfilerApi", + "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface" + }, + { + "kind": "Content", + "text": ", initialViewOptions: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ", createEncoder: " + }, + { + "kind": "Content", + "text": "(streamId: " + }, + { + "kind": "Reference", + "text": "DeflateEncoderStreamId", + "canonicalReference": "@datadog/browser-core!DeflateEncoderStreamId:enum" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "Encoder", + "canonicalReference": "@datadog/browser-core!Encoder:interface" + }, + { + "kind": "Content", + "text": ", trackingConsentState: " + }, + { + "kind": "Reference", + "text": "TrackingConsentState", + "canonicalReference": "@datadog/browser-core!TrackingConsentState:interface" + }, + { + "kind": "Content", + "text": ", customVitalsState: " + }, + { + "kind": "Reference", + "text": "CustomVitalsState", + "canonicalReference": "@datadog/browser-rum-core!~CustomVitalsState:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "{\n addAction: (action: import(\"../domain/action/actionCollection\")." + }, + { + "kind": "Reference", + "text": "CustomAction", + "canonicalReference": "@datadog/browser-rum-core!~CustomAction:interface" + }, + { + "kind": "Content", + "text": ") => void;\n addError: ({ error, handlingStack, componentStack, startClocks, " + }, + { + "kind": "Reference", + "text": "context", + "canonicalReference": "@datadog/browser-rum-core!~ProvidedError#context" + }, + { + "kind": "Content", + "text": ": customerContext }: import(\"../domain/error/errorCollection\")." + }, + { + "kind": "Reference", + "text": "ProvidedError", + "canonicalReference": "@datadog/browser-rum-core!~ProvidedError:interface" + }, + { + "kind": "Content", + "text": ") => void;\n addTiming: (name: string, time?: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "RelativeTime", + "canonicalReference": "@datadog/browser-core!RelativeTime:type" + }, + { + "kind": "Content", + "text": " | import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "TimeStamp", + "canonicalReference": "@datadog/browser-core!TimeStamp:type" + }, + { + "kind": "Content", + "text": ") => void;\n addFeatureFlagEvaluation: (key: string, value: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "ContextValue", + "canonicalReference": "@datadog/browser-core!ContextValue:type" + }, + { + "kind": "Content", + "text": ") => void;\n startView: (options?: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" + }, + { + "kind": "Content", + "text": ", startClocks?: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "ClocksState", + "canonicalReference": "@datadog/browser-core!ClocksState:type" + }, + { + "kind": "Content", + "text": ") => void;\n setViewContext: (context: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ") => void;\n setViewContextProperty: (key: string, value: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "ContextValue", + "canonicalReference": "@datadog/browser-core!ContextValue:type" + }, + { + "kind": "Content", + "text": ") => void;\n getViewContext: () => import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";\n setViewName: (name: string) => void;\n lifeCycle: import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "AbstractLifeCycle", + "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" + }, + { + "kind": "Content", + "text": ";\n viewHistory: import(\"../domain/contexts/viewHistory\")." + }, + { + "kind": "Reference", + "text": "ViewHistory", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" + }, + { + "kind": "Content", + "text": ";\n session: import(\"../domain/rumSessionManager\")." + }, + { + "kind": "Reference", + "text": "RumSessionManager", + "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" + }, + { + "kind": "Content", + "text": ";\n stopSession: () => void;\n getInternalContext: (startTime?: number) => import(\"../domain/contexts/internalContext\")." + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-rum-core!~InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined;\n startDurationVital: (name: string, options?: import(\"../domain/vital/vitalCollection\")." + }, + { + "kind": "Reference", + "text": "DurationVitalOptions", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalOptions:interface" + }, + { + "kind": "Content", + "text": ") => import(\"../domain/vital/vitalCollection\")." + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ";\n stopDurationVital: (nameOrRef: string | import(\"../domain/vital/vitalCollection\")." + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ", options?: import(\"../domain/vital/vitalCollection\")." + }, + { + "kind": "Reference", + "text": "DurationVitalOptions", + "canonicalReference": "@datadog/browser-rum-core!~DurationVitalOptions:interface" + }, + { + "kind": "Content", + "text": ") => void;\n addDurationVital: (vital: import(\"../domain/vital/vitalCollection\")." + }, + { + "kind": "Reference", + "text": "DurationVital", + "canonicalReference": "@datadog/browser-rum-core!~DurationVital:interface" + }, + { + "kind": "Content", + "text": ") => void;\n globalContext: {\n getContext: () => import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " + }, + { + "kind": "Reference", + "text": "Observable", + "canonicalReference": "@datadog/browser-core!Observable:class" + }, + { + "kind": "Content", + "text": ";\n };\n userContext: {\n getContext: () => import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " + }, + { + "kind": "Reference", + "text": "Observable", + "canonicalReference": "@datadog/browser-core!Observable:class" + }, + { + "kind": "Content", + "text": ";\n };\n accountContext: {\n getContext: () => import(\"@datadog/browser-core\")." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " + }, + { + "kind": "Reference", + "text": "Observable", + "canonicalReference": "@datadog/browser-core!Observable:class" + }, + { + "kind": "Content", + "text": ";\n };\n stop: () => void;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/startRum.d.ts", + "returnTypeTokenRange": { + "startIndex": 19, + "endIndex": 74 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "recorderApi", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "profilerApi", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "initialViewOptions", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "isOptional": false + }, + { + "parameterName": "createEncoder", + "parameterTypeTokenRange": { + "startIndex": 10, + "endIndex": 14 + }, + "isOptional": false + }, + { + "parameterName": "trackingConsentState", + "parameterTypeTokenRange": { + "startIndex": 15, + "endIndex": 16 + }, + "isOptional": false + }, + { + "parameterName": "customVitalsState", + "parameterTypeTokenRange": { + "startIndex": 17, + "endIndex": 18 + }, + "isOptional": false + } + ], + "name": "startRum" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum-core!StartRum:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type StartRum = " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "startRum", + "canonicalReference": "@datadog/browser-rum-core!startRum:function" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/startRum.d.ts", + "releaseTag": "Public", + "name": "StartRum", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!startViewHistory:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function startViewHistory(lifeCycle: " + }, + { + "kind": "Reference", + "text": "LifeCycle", + "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ViewHistory", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "lifeCycle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "startViewHistory" + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!Strategy:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Strategy " + } + ], + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "Strategy", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#accountContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accountContext: " + }, + { + "kind": "Reference", + "text": "ContextManager", + "canonicalReference": "@datadog/browser-core!ContextManager:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "accountContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#addAction:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addAction: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['addAction']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#addDurationVital:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addDurationVital: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['addDurationVital']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#addError:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addError: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['addError']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#addFeatureFlagEvaluation:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addFeatureFlagEvaluation: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['addFeatureFlagEvaluation']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addFeatureFlagEvaluation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#addTiming:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addTiming: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['addTiming']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addTiming", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#getInternalContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['getInternalContext']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#getViewContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getViewContext: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['getViewContext']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#globalContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "globalContext: " + }, + { + "kind": "Reference", + "text": "ContextManager", + "canonicalReference": "@datadog/browser-core!ContextManager:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "globalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#init:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ", publicApi: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#initConfiguration:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "initConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContext: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['setViewContext']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewContextProperty:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContextProperty: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['setViewContextProperty']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewName:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewName: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['setViewName']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#startDurationVital:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startDurationVital: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['startDurationVital']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#startView:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startView: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['startView']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#stopDurationVital:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopDurationVital: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['stopDurationVital']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#stopSession:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSession: " + }, + { + "kind": "Reference", + "text": "StartRumResult", + "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" + }, + { + "kind": "Content", + "text": "['stopSession']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!Strategy#userContext:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "userContext: " + }, + { + "kind": "Reference", + "text": "ContextManager", + "canonicalReference": "@datadog/browser-core!ContextManager:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "userContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-core!supportPerformanceTimingEvent:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function supportPerformanceTimingEvent(entryType: " + }, + { + "kind": "Reference", + "text": "RumPerformanceEntryType", + "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType:enum" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/performanceObservable.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "entryType", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "supportPerformanceTimingEvent" + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ViewCreatedEvent " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/view/trackViews.d.ts", + "releaseTag": "Public", + "name": "ViewCreatedEvent", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#service:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#startClocks:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startClocks: " + }, + { + "kind": "Reference", + "text": "ClocksState", + "canonicalReference": "@datadog/browser-core!ClocksState:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startClocks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#version:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ViewHistory " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", + "releaseTag": "Public", + "name": "ViewHistory", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory#findView:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "findView: " + }, + { + "kind": "Content", + "text": "(startTime?: " + }, + { + "kind": "Reference", + "text": "RelativeTime", + "canonicalReference": "@datadog/browser-core!RelativeTime:type" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "ViewHistoryEntry", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "findView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistory#stop:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "stop: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stop", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ViewHistoryEntry " + } + ], + "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", + "releaseTag": "Public", + "name": "ViewHistoryEntry", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#service:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#sessionIsActive:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionIsActive?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "sessionIsActive", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#startClocks:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "startClocks: " + }, + { + "kind": "Reference", + "text": "ClocksState", + "canonicalReference": "@datadog/browser-core!ClocksState:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startClocks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#version:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ViewportDimension " + } + ], + "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", + "releaseTag": "Public", + "name": "ViewportDimension", + "preserveMemberOrder": false, + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension#height:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "height: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "height", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum-core!ViewportDimension#width:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "width: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "width", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/package.json b/package.json index c95c1ff0b9..40477c37d4 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,8 @@ "docs:api:logs": "api-extractor run --local --config packages/logs/api-extractor.json", "docs:api:rum-slim": "api-extractor run --local --config packages/rum-slim/api-extractor.json", "docs:api:rum-react": "api-extractor run --local --config packages/rum-react/api-extractor.json", - "docs:api": "yarn build:types && yarn docs:api:rum && yarn docs:api:logs && yarn docs:api:rum-slim && yarn docs:api:rum-react" + "docs:api:rum-core": "api-extractor run --local --config packages/rum-core/api-extractor.json", + "docs:api": "yarn build:types && yarn docs:api:rum && yarn docs:api:logs && yarn docs:api:rum-slim && yarn docs:api:rum-react && yarn docs:api:rum-core" }, "devDependencies": { "@eslint/js": "9.26.0", diff --git a/packages/rum-core/api-extractor.json b/packages/rum-core/api-extractor.json new file mode 100644 index 0000000000..c41540aa27 --- /dev/null +++ b/packages/rum-core/api-extractor.json @@ -0,0 +1,35 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "./esm/index.d.ts", + "compiler": { + "tsconfigFilePath": "./tsconfig.esm.json" + }, + "dtsRollup": { + "enabled": false + }, + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/etc/.api.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning", + "addToApiReportFile": false + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} From 6160588f66b317044a5466a43cb5ce4a7bc5a63f Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Tue, 27 May 2025 11:53:12 +0200 Subject: [PATCH 03/21] b2b --- .../rum/browser-rum-core.actiontype.md | 59 - .../rum/browser-rum-core.censored_img_mark.md | 11 - .../browser-rum-core.censored_string_mark.md | 11 - .../rum/browser-rum-core.censortext.md | 13 - ...owser-rum-core.commonproperties.service.md | 13 - ...owser-rum-core.commonproperties.version.md | 13 - ...ault_programmatic_action_name_attribute.md | 13 - .../rum/browser-rum-core.foreachchildnodes.md | 63 - ...browser-rum-core.form_private_tag_names.md | 13 - .../rum/browser-rum-core.frustrationtype.md | 73 - ...rum-core.getmutationobserverconstructor.md | 15 - .../browser-rum-core.getnodeprivacylevel.md | 83 - ...rowser-rum-core.getnodeselfprivacylevel.md | 51 - .../rum/browser-rum-core.getparentnode.md | 51 - .../browser-rum-core.getprivacyselector.md | 49 - .../rum/browser-rum-core.getscrollx.md | 15 - .../rum/browser-rum-core.getscrolly.md | 15 - .../browser-rum-core.getsessionreplayurl.md | 67 - .../rum/browser-rum-core.gettextcontent.md | 77 - .../browser-rum-core.getviewportdimension.md | 15 - .../rum/browser-rum-core.haschildnodes.md | 49 - ...browser-rum-core.initviewportobservable.md | 49 - .../rum/browser-rum-core.iscommentnode.md | 49 - .../rum/browser-rum-core.iselementnode.md | 49 - .../rum/browser-rum-core.islongdataurl.md | 49 - .../rum/browser-rum-core.isnodeshadowhost.md | 51 - .../rum/browser-rum-core.isnodeshadowroot.md | 49 - .../rum/browser-rum-core.istextnode.md | 49 - .../rum/browser-rum-core.lifecycle.md | 13 - .../browser-rum-core.lifecycleeventtype.md | 241 - .../rum/browser-rum-core.makerumpublicapi.md | 93 - ...um-core.max_attribute_value_char_length.md | 11 - docs/api-reference/rum/browser-rum-core.md | 905 -- .../browser-rum-core.mouseeventonelement.md | 11 - .../rum/browser-rum-core.nodeprivacylevel.md | 17 - .../browser-rum-core.nodeprivacylevelcache.md | 13 - .../rum/browser-rum-core.privacy_attr_name.md | 11 - ...owser-rum-core.privacy_attr_value_allow.md | 11 - ...wser-rum-core.privacy_attr_value_hidden.md | 11 - ...rowser-rum-core.privacy_attr_value_mask.md | 11 - ...core.privacy_attr_value_mask_user_input.md | 11 - .../browser-rum-core.privacy_class_prefix.md | 11 - .../rum/browser-rum-core.profilerapi.md | 70 - ...browser-rum-core.profilerapi.onrumstart.md | 11 - .../rum/browser-rum-core.profilerapi.stop.md | 11 - .../browser-rum-core.rawrumactionevent._dd.md | 25 - ...owser-rum-core.rawrumactionevent.action.md | 24 - ...browser-rum-core.rawrumactionevent.date.md | 11 - .../rum/browser-rum-core.rawrumactionevent.md | 125 - ...browser-rum-core.rawrumactionevent.type.md | 11 - ...browser-rum-core.rawrumactionevent.view.md | 13 - .../rum/browser-rum-core.rawrumevent.md | 13 - ...awrumeventcollecteddata.customercontext.md | 11 - ....rawrumeventcollecteddata.domaincontext.md | 11 - ...-core.rawrumeventcollecteddata.duration.md | 11 - ...owser-rum-core.rawrumeventcollecteddata.md | 125 - ...re.rawrumeventcollecteddata.rawrumevent.md | 11 - ...core.rawrumeventcollecteddata.starttime.md | 11 - ...ser-rum-core.recorderapi.getreplaystats.md | 11 - ...m-core.recorderapi.getsessionreplaylink.md | 11 - ...rowser-rum-core.recorderapi.isrecording.md | 11 - .../rum/browser-rum-core.recorderapi.md | 138 - ...browser-rum-core.recorderapi.onrumstart.md | 11 - .../rum/browser-rum-core.recorderapi.start.md | 11 - .../rum/browser-rum-core.recorderapi.stop.md | 11 - .../browser-rum-core.reduceprivacylevel.md | 65 - .../rum/browser-rum-core.replaystats.md | 87 - ...wser-rum-core.replaystats.records_count.md | 11 - ...ser-rum-core.replaystats.segments_count.md | 11 - ...ore.replaystats.segments_total_raw_size.md | 11 - ...core.rumactioneventdomaincontext.events.md | 11 - ...mactioneventdomaincontext.handlingstack.md | 11 - ...re.rumconfiguration.actionnameattribute.md | 11 - ...ore.rumconfiguration.allowedtracingurls.md | 11 - ...rum-core.rumconfiguration.applicationid.md | 11 - ...rumconfiguration.compressintakerequests.md | 11 - ...uration.customerdatatelemetrysamplerate.md | 11 - ...re.rumconfiguration.defaultprivacylevel.md | 11 - ...onfiguration.enableprivacyforactionname.md | 11 - ...e.rumconfiguration.excludedactivityurls.md | 11 - .../rum/browser-rum-core.rumconfiguration.md | 449 - ...owser-rum-core.rumconfiguration.plugins.md | 11 - ...re.rumconfiguration.profilingsamplerate.md | 11 - ....rumconfiguration.propagatetracebaggage.md | 11 - ...owser-rum-core.rumconfiguration.rulepsr.md | 11 - ...umconfiguration.sessionreplaysamplerate.md | 11 - ...ion.startsessionreplayrecordingmanually.md | 11 - ...ser-rum-core.rumconfiguration.subdomain.md | 11 - ....rumconfiguration.tracecontextinjection.md | 11 - ...m-core.rumconfiguration.tracesamplerate.md | 11 - ...onfiguration.trackfeatureflagsforevents.md | 11 - ...um-core.rumconfiguration.tracklongtasks.md | 11 - ...um-core.rumconfiguration.trackresources.md | 11 - ....rumconfiguration.trackuserinteractions.md | 11 - ...ore.rumconfiguration.trackviewsmanually.md | 11 - ...owser-rum-core.rumconfiguration.version.md | 11 - ...ser-rum-core.rumconfiguration.workerurl.md | 11 - ...m-core.rumerroreventdomaincontext.error.md | 11 - ...umerroreventdomaincontext.handlingstack.md | 11 - .../rum/browser-rum-core.rumevent.md | 15 - .../browser-rum-core.rumeventdomaincontext.md | 13 - .../rum/browser-rum-core.rumeventtype.md | 115 - ...umfetchresourceeventdomaincontext.error.md | 11 - ...esourceeventdomaincontext.handlingstack.md | 11 - ...tchresourceeventdomaincontext.isaborted.md | 11 - ...urceeventdomaincontext.performanceentry.md | 11 - ...hresourceeventdomaincontext.requestinit.md | 11 - ...resourceeventdomaincontext.requestinput.md | 11 - ...etchresourceeventdomaincontext.response.md | 11 - ...core.ruminitconfiguration.applicationid.md | 13 - ...initconfiguration.remoteconfigurationid.md | 11 - ...taskeventdomaincontext.performanceentry.md | 11 - ...urceeventdomaincontext.performanceentry.md | 11 - ...rowser-rum-core.rumperformanceentrytype.md | 171 - ...ore.rumplugin.getconfigurationtelemetry.md | 15 - .../rum/browser-rum-core.rumplugin.md | 101 - .../rum/browser-rum-core.rumplugin.name.md | 11 - .../rum/browser-rum-core.rumplugin.oninit.md | 52 - .../browser-rum-core.rumplugin.onrumstart.md | 51 - ...browser-rum-core.rumpublicapi.addaction.md | 13 - .../browser-rum-core.rumpublicapi.adderror.md | 13 - ...e.rumpublicapi.addfeatureflagevaluation.md | 13 - ...wser-rum-core.rumpublicapi.clearaccount.md | 13 - ...rowser-rum-core.rumpublicapi.getaccount.md | 13 - ...-core.rumpublicapi.getinitconfiguration.md | 13 - ...um-core.rumpublicapi.getinternalcontext.md | 13 - ...er-rum-core.rumpublicapi.getviewcontext.md | 13 - .../rum/browser-rum-core.rumpublicapi.init.md | 13 - ...core.rumpublicapi.removeaccountproperty.md | 13 - ...rowser-rum-core.rumpublicapi.setaccount.md | 13 - ...um-core.rumpublicapi.setaccountproperty.md | 13 - ...-rum-core.rumpublicapi.setglobalcontext.md | 13 - ...e.rumpublicapi.setglobalcontextproperty.md | 13 - ...um-core.rumpublicapi.settrackingconsent.md | 13 - ...r-rum-core.rumpublicapi.setuserproperty.md | 13 - ...er-rum-core.rumpublicapi.setviewcontext.md | 15 - ...ore.rumpublicapi.setviewcontextproperty.md | 15 - ...owser-rum-core.rumpublicapi.setviewname.md | 15 - ...owser-rum-core.rumpublicapi.stopsession.md | 13 - .../rum/browser-rum-core.rumsession.md | 17 - ...owser-rum-core.rumsessionmanager.expire.md | 11 - ...core.rumsessionmanager.expireobservable.md | 11 - ...re.rumsessionmanager.findtrackedsession.md | 11 - .../rum/browser-rum-core.rumsessionmanager.md | 104 - ...-core.rumsessionmanager.setforcedreplay.md | 11 - ...core.rumvieweventdomaincontext.location.md | 11 - ...esourceeventdomaincontext.handlingstack.md | 11 - ...xhrresourceeventdomaincontext.isaborted.md | 11 - ...urceeventdomaincontext.performanceentry.md | 11 - ...re.rumxhrresourceeventdomaincontext.xhr.md | 11 - .../rum/browser-rum-core.sanitizedataurl.md | 49 - .../browser-rum-core.sessionreplaystate.md | 73 - .../browser-rum-core.shouldignoreelement.md | 51 - .../rum/browser-rum-core.shouldmasknode.md | 71 - .../rum/browser-rum-core.stable_attributes.md | 13 - ...er-rum-core.startrecordingoptions.force.md | 11 - .../browser-rum-core.startrecordingoptions.md | 53 - .../rum/browser-rum-core.startrum.md | 11 - .../rum/browser-rum-core.startviewhistory.md | 49 - ...rowser-rum-core.strategy.accountcontext.md | 11 - .../browser-rum-core.strategy.addaction.md | 11 - ...wser-rum-core.strategy.adddurationvital.md | 11 - .../rum/browser-rum-core.strategy.adderror.md | 11 - ...-core.strategy.addfeatureflagevaluation.md | 11 - .../browser-rum-core.strategy.addtiming.md | 11 - ...er-rum-core.strategy.getinternalcontext.md | 11 - ...rowser-rum-core.strategy.getviewcontext.md | 11 - ...browser-rum-core.strategy.globalcontext.md | 11 - .../rum/browser-rum-core.strategy.init.md | 11 - ...ser-rum-core.strategy.initconfiguration.md | 11 - .../rum/browser-rum-core.strategy.md | 359 - ...rowser-rum-core.strategy.setviewcontext.md | 11 - ...um-core.strategy.setviewcontextproperty.md | 11 - .../browser-rum-core.strategy.setviewname.md | 11 - ...er-rum-core.strategy.startdurationvital.md | 11 - .../browser-rum-core.strategy.startview.md | 11 - ...ser-rum-core.strategy.stopdurationvital.md | 11 - .../browser-rum-core.strategy.stopsession.md | 11 - .../browser-rum-core.strategy.usercontext.md | 11 - ...-rum-core.supportperformancetimingevent.md | 49 - ...owser-rum-core.viewcreatedevent.context.md | 11 - .../browser-rum-core.viewcreatedevent.id.md | 11 - .../rum/browser-rum-core.viewcreatedevent.md | 146 - .../browser-rum-core.viewcreatedevent.name.md | 11 - ...owser-rum-core.viewcreatedevent.service.md | 11 - ...r-rum-core.viewcreatedevent.startclocks.md | 11 - ...owser-rum-core.viewcreatedevent.version.md | 11 - .../browser-rum-core.viewhistory.findview.md | 11 - .../rum/browser-rum-core.viewhistory.md | 70 - .../rum/browser-rum-core.viewhistory.stop.md | 11 - ...owser-rum-core.viewhistoryentry.context.md | 11 - .../browser-rum-core.viewhistoryentry.id.md | 11 - .../rum/browser-rum-core.viewhistoryentry.md | 165 - .../browser-rum-core.viewhistoryentry.name.md | 11 - ...owser-rum-core.viewhistoryentry.service.md | 11 - ...m-core.viewhistoryentry.sessionisactive.md | 11 - ...r-rum-core.viewhistoryentry.startclocks.md | 11 - ...owser-rum-core.viewhistoryentry.version.md | 11 - ...owser-rum-core.viewportdimension.height.md | 11 - .../rum/browser-rum-core.viewportdimension.md | 70 - ...rowser-rum-core.viewportdimension.width.md | 11 - .../rum/browser-rum-react.reactplugin.md | 2 +- ...md => browser-rum.commonproperties._dd.md} | 2 +- ...> browser-rum.commonproperties.account.md} | 2 +- ...owser-rum.commonproperties.application.md} | 2 +- ... browser-rum.commonproperties.build_id.md} | 2 +- ...ser-rum.commonproperties.build_version.md} | 2 +- ...> browser-rum.commonproperties.ci_test.md} | 2 +- ...wser-rum.commonproperties.connectivity.md} | 2 +- ...> browser-rum.commonproperties.context.md} | 2 +- ...d => browser-rum.commonproperties.date.md} | 2 +- ...=> browser-rum.commonproperties.device.md} | 2 +- ...> browser-rum.commonproperties.display.md} | 2 +- ...ies.md => browser-rum.commonproperties.md} | 40 +- ....md => browser-rum.commonproperties.os.md} | 2 +- .../browser-rum.commonproperties.service.md | 13 + ...> browser-rum.commonproperties.session.md} | 2 +- ...=> browser-rum.commonproperties.source.md} | 2 +- ...rowser-rum.commonproperties.synthetics.md} | 2 +- ...md => browser-rum.commonproperties.usr.md} | 2 +- .../browser-rum.commonproperties.version.md | 13 + ...d => browser-rum.commonproperties.view.md} | 2 +- docs/api-reference/rum/browser-rum.md | 208 + ...event.md => browser-rum.rumactionevent.md} | 4 +- ...-rum.rumactioneventdomaincontext.events.md | 11 + ...mactioneventdomaincontext.handlingstack.md | 11 + ...rowser-rum.rumactioneventdomaincontext.md} | 6 +- ...revent.md => browser-rum.rumerrorevent.md} | 4 +- ...er-rum.rumerroreventdomaincontext.error.md | 11 + ...umerroreventdomaincontext.handlingstack.md | 11 + ...browser-rum.rumerroreventdomaincontext.md} | 6 +- .../api-reference/rum/browser-rum.rumevent.md | 15 + .../rum/browser-rum.rumeventdomaincontext.md | 13 + ...umfetchresourceeventdomaincontext.error.md | 11 + ...esourceeventdomaincontext.handlingstack.md | 11 + ...tchresourceeventdomaincontext.isaborted.md | 11 + ...rum.rumfetchresourceeventdomaincontext.md} | 16 +- ...urceeventdomaincontext.performanceentry.md | 11 + ...hresourceeventdomaincontext.requestinit.md | 11 + ...resourceeventdomaincontext.requestinput.md | 11 + ...etchresourceeventdomaincontext.response.md | 11 + .../rum/browser-rum.rumglobal.addaction.md | 13 + ...browser-rum.rumglobal.adddurationvital.md} | 4 +- .../rum/browser-rum.rumglobal.adderror.md | 13 + ...-rum.rumglobal.addfeatureflagevaluation.md | 13 + ....md => browser-rum.rumglobal.addtiming.md} | 4 +- .../rum/browser-rum.rumglobal.clearaccount.md | 13 + ...owser-rum.rumglobal.clearglobalcontext.md} | 4 +- ....md => browser-rum.rumglobal.clearuser.md} | 4 +- .../rum/browser-rum.rumglobal.getaccount.md | 13 + ...browser-rum.rumglobal.getglobalcontext.md} | 4 +- ...wser-rum.rumglobal.getinitconfiguration.md | 13 + ...rowser-rum.rumglobal.getinternalcontext.md | 13 + ...ser-rum.rumglobal.getsessionreplaylink.md} | 4 +- ...er.md => browser-rum.rumglobal.getuser.md} | 4 +- .../browser-rum.rumglobal.getviewcontext.md | 13 + .../rum/browser-rum.rumglobal.init.md | 13 + ...mpublicapi.md => browser-rum.rumglobal.md} | 82 +- ...ser-rum.rumglobal.removeaccountproperty.md | 13 + ....rumglobal.removeglobalcontextproperty.md} | 4 +- ...owser-rum.rumglobal.removeuserproperty.md} | 4 +- .../rum/browser-rum.rumglobal.setaccount.md | 13 + ...rowser-rum.rumglobal.setaccountproperty.md | 13 + .../browser-rum.rumglobal.setglobalcontext.md | 13 + ...-rum.rumglobal.setglobalcontextproperty.md | 13 + ...rowser-rum.rumglobal.settrackingconsent.md | 13 + ...er.md => browser-rum.rumglobal.setuser.md} | 4 +- ....md => browser-rum.rumglobal.setuser_1.md} | 4 +- .../browser-rum.rumglobal.setuserproperty.md | 13 + .../browser-rum.rumglobal.setviewcontext.md | 15 + ...er-rum.rumglobal.setviewcontextproperty.md | 15 + .../rum/browser-rum.rumglobal.setviewname.md | 15 + ...owser-rum.rumglobal.startdurationvital.md} | 4 +- ....rumglobal.startsessionreplayrecording.md} | 4 +- ....md => browser-rum.rumglobal.startview.md} | 4 +- ...rowser-rum.rumglobal.stopdurationvital.md} | 4 +- .../rum/browser-rum.rumglobal.stopsession.md | 13 + ...m.rumglobal.stopsessionreplayrecording.md} | 4 +- ...minitconfiguration.actionnameattribute.md} | 2 +- ...uminitconfiguration.allowedtracingurls.md} | 2 +- ...-rum.ruminitconfiguration.applicationid.md | 13 + ...er-rum.ruminitconfiguration.beforesend.md} | 2 +- ...itconfiguration.compressintakerequests.md} | 2 +- ...minitconfiguration.defaultprivacylevel.md} | 2 +- ...nfiguration.enableprivacyforactionname.md} | 2 +- ...initconfiguration.excludedactivityurls.md} | 2 +- ...md => browser-rum.ruminitconfiguration.md} | 71 +- ...owser-rum.ruminitconfiguration.plugins.md} | 2 +- ...minitconfiguration.profilingsamplerate.md} | 2 +- ...nitconfiguration.propagatetracebaggage.md} | 2 +- ...initconfiguration.remoteconfigurationid.md | 11 + ...tconfiguration.sessionreplaysamplerate.md} | 2 +- ...on.startsessionreplayrecordingmanually.md} | 2 +- ...ser-rum.ruminitconfiguration.subdomain.md} | 2 +- ...nitconfiguration.tracecontextinjection.md} | 2 +- ...m.ruminitconfiguration.tracesamplerate.md} | 2 +- ....ruminitconfiguration.trackbfcacheviews.md | 13 + ...nfiguration.trackfeatureflagsforevents.md} | 2 +- ...um.ruminitconfiguration.tracklongtasks.md} | 2 +- ...um.ruminitconfiguration.trackresources.md} | 2 +- ...nitconfiguration.trackuserinteractions.md} | 2 +- ...uminitconfiguration.trackviewsmanually.md} | 2 +- ...ser-rum.ruminitconfiguration.workerurl.md} | 2 +- ...ent.md => browser-rum.rumlongtaskevent.md} | 4 +- ...wser-rum.rumlongtaskeventdomaincontext.md} | 4 +- ...taskeventdomaincontext.performanceentry.md | 11 + ...rum.rumotherresourceeventdomaincontext.md} | 4 +- ...urceeventdomaincontext.performanceentry.md | 11 + ...ent.md => browser-rum.rumresourceevent.md} | 4 +- ...ewevent.md => browser-rum.rumviewevent.md} | 4 +- ...-rum.rumvieweventdomaincontext.location.md | 11 + ... browser-rum.rumvieweventdomaincontext.md} | 4 +- ...levent.md => browser-rum.rumvitalevent.md} | 4 +- ...esourceeventdomaincontext.handlingstack.md | 11 + ...xhrresourceeventdomaincontext.isaborted.md | 11 + ...r-rum.rumxhrresourceeventdomaincontext.md} | 10 +- ...urceeventdomaincontext.performanceentry.md | 11 + ...um.rumxhrresourceeventdomaincontext.xhr.md | 11 + docs/api-reference/rum/index.md | 9 - etc/browser-rum-core.api.json | 10481 ---------------- etc/browser-rum.api.json | 3672 +++++- package.json | 7 +- packages/logs/api-extractor.json | 1 + packages/rum-react/api-extractor.json | 1 + packages/rum-slim/api-extractor.json | 1 + packages/rum/api-extractor.json | 1 + 326 files changed, 4653 insertions(+), 17605 deletions(-) delete mode 100644 docs/api-reference/rum/browser-rum-core.actiontype.md delete mode 100644 docs/api-reference/rum/browser-rum-core.censored_img_mark.md delete mode 100644 docs/api-reference/rum/browser-rum-core.censored_string_mark.md delete mode 100644 docs/api-reference/rum/browser-rum-core.censortext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.service.md delete mode 100644 docs/api-reference/rum/browser-rum-core.commonproperties.version.md delete mode 100644 docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md delete mode 100644 docs/api-reference/rum/browser-rum-core.foreachchildnodes.md delete mode 100644 docs/api-reference/rum/browser-rum-core.form_private_tag_names.md delete mode 100644 docs/api-reference/rum/browser-rum-core.frustrationtype.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getparentnode.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getprivacyselector.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getscrollx.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getscrolly.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md delete mode 100644 docs/api-reference/rum/browser-rum-core.gettextcontent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.getviewportdimension.md delete mode 100644 docs/api-reference/rum/browser-rum-core.haschildnodes.md delete mode 100644 docs/api-reference/rum/browser-rum-core.initviewportobservable.md delete mode 100644 docs/api-reference/rum/browser-rum-core.iscommentnode.md delete mode 100644 docs/api-reference/rum/browser-rum-core.iselementnode.md delete mode 100644 docs/api-reference/rum/browser-rum-core.islongdataurl.md delete mode 100644 docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md delete mode 100644 docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md delete mode 100644 docs/api-reference/rum/browser-rum-core.istextnode.md delete mode 100644 docs/api-reference/rum/browser-rum-core.lifecycle.md delete mode 100644 docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md delete mode 100644 docs/api-reference/rum/browser-rum-core.makerumpublicapi.md delete mode 100644 docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md delete mode 100644 docs/api-reference/rum/browser-rum-core.md delete mode 100644 docs/api-reference/rum/browser-rum-core.mouseeventonelement.md delete mode 100644 docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md delete mode 100644 docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_name.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md delete mode 100644 docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md delete mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.md delete mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md delete mode 100644 docs/api-reference/rum/browser-rum-core.profilerapi.stop.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.start.md delete mode 100644 docs/api-reference/rum/browser-rum-core.recorderapi.stop.md delete mode 100644 docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md delete mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.md delete mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.records_count.md delete mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md delete mode 100644 docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumeventtype.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md delete mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md delete mode 100644 docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.name.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsession.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md delete mode 100644 docs/api-reference/rum/browser-rum-core.sanitizedataurl.md delete mode 100644 docs/api-reference/rum/browser-rum-core.sessionreplaystate.md delete mode 100644 docs/api-reference/rum/browser-rum-core.shouldignoreelement.md delete mode 100644 docs/api-reference/rum/browser-rum-core.shouldmasknode.md delete mode 100644 docs/api-reference/rum/browser-rum-core.stable_attributes.md delete mode 100644 docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md delete mode 100644 docs/api-reference/rum/browser-rum-core.startrecordingoptions.md delete mode 100644 docs/api-reference/rum/browser-rum-core.startrum.md delete mode 100644 docs/api-reference/rum/browser-rum-core.startviewhistory.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addaction.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.adderror.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.addtiming.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.init.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.setviewname.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.startview.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.stopsession.md delete mode 100644 docs/api-reference/rum/browser-rum-core.strategy.usercontext.md delete mode 100644 docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.findview.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistory.stop.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.height.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.md delete mode 100644 docs/api-reference/rum/browser-rum-core.viewportdimension.width.md rename docs/api-reference/rum/{browser-rum-core.commonproperties._dd.md => browser-rum.commonproperties._dd.md} (77%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.account.md => browser-rum.commonproperties.account.md} (57%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.application.md => browser-rum.commonproperties.application.md} (54%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.build_id.md => browser-rum.commonproperties.build_id.md} (62%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.build_version.md => browser-rum.commonproperties.build_version.md} (50%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.ci_test.md => browser-rum.commonproperties.ci_test.md} (56%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.connectivity.md => browser-rum.commonproperties.connectivity.md} (74%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.context.md => browser-rum.commonproperties.context.md} (51%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.date.md => browser-rum.commonproperties.date.md} (50%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.device.md => browser-rum.commonproperties.device.md} (67%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.display.md => browser-rum.commonproperties.display.md} (62%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.md => browser-rum.commonproperties.md} (73%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.os.md => browser-rum.commonproperties.os.md} (63%) create mode 100644 docs/api-reference/rum/browser-rum.commonproperties.service.md rename docs/api-reference/rum/{browser-rum-core.commonproperties.session.md => browser-rum.commonproperties.session.md} (61%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.source.md => browser-rum.commonproperties.source.md} (58%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.synthetics.md => browser-rum.commonproperties.synthetics.md} (60%) rename docs/api-reference/rum/{browser-rum-core.commonproperties.usr.md => browser-rum.commonproperties.usr.md} (62%) create mode 100644 docs/api-reference/rum/browser-rum.commonproperties.version.md rename docs/api-reference/rum/{browser-rum-core.commonproperties.view.md => browser-rum.commonproperties.view.md} (60%) rename docs/api-reference/rum/{browser-rum-core.rumactionevent.md => browser-rum.rumactionevent.md} (87%) create mode 100644 docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md create mode 100644 docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md rename docs/api-reference/rum/{browser-rum-core.rumactioneventdomaincontext.md => browser-rum.rumactioneventdomaincontext.md} (57%) rename docs/api-reference/rum/{browser-rum-core.rumerrorevent.md => browser-rum.rumerrorevent.md} (91%) create mode 100644 docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md create mode 100644 docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md rename docs/api-reference/rum/{browser-rum-core.rumerroreventdomaincontext.md => browser-rum.rumerroreventdomaincontext.md} (57%) create mode 100644 docs/api-reference/rum/browser-rum.rumevent.md create mode 100644 docs/api-reference/rum/browser-rum.rumeventdomaincontext.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md rename docs/api-reference/rum/{browser-rum-core.rumfetchresourceeventdomaincontext.md => browser-rum.rumfetchresourceeventdomaincontext.md} (50%) create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md create mode 100644 docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.addaction.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.adddurationvital.md => browser-rum.rumglobal.adddurationvital.md} (54%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.adderror.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.addtiming.md => browser-rum.rumglobal.addtiming.md} (53%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.clearglobalcontext.md => browser-rum.rumglobal.clearglobalcontext.md} (54%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.clearuser.md => browser-rum.rumglobal.clearuser.md} (56%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.getaccount.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.getglobalcontext.md => browser-rum.rumglobal.getglobalcontext.md} (55%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.getsessionreplaylink.md => browser-rum.rumglobal.getsessionreplaylink.md} (58%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.getuser.md => browser-rum.rumglobal.getuser.md} (56%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.init.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.md => browser-rum.rumglobal.md} (66%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.removeglobalcontextproperty.md => browser-rum.rumglobal.removeglobalcontextproperty.md} (54%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.removeuserproperty.md => browser-rum.rumglobal.removeuserproperty.md} (54%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setaccount.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.setuser.md => browser-rum.rumglobal.setuser.md} (68%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.setuser_1.md => browser-rum.rumglobal.setuser_1.md} (63%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.setviewname.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.startdurationvital.md => browser-rum.rumglobal.startdurationvital.md} (59%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.startsessionreplayrecording.md => browser-rum.rumglobal.startsessionreplayrecording.md} (62%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.startview.md => browser-rum.rumglobal.startview.md} (63%) rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.stopdurationvital.md => browser-rum.rumglobal.stopdurationvital.md} (52%) create mode 100644 docs/api-reference/rum/browser-rum.rumglobal.stopsession.md rename docs/api-reference/rum/{browser-rum-core.rumpublicapi.stopsessionreplayrecording.md => browser-rum.rumglobal.stopsessionreplayrecording.md} (52%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.actionnameattribute.md => browser-rum.ruminitconfiguration.actionnameattribute.md} (64%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.allowedtracingurls.md => browser-rum.ruminitconfiguration.allowedtracingurls.md} (64%) create mode 100644 docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.beforesend.md => browser-rum.ruminitconfiguration.beforesend.md} (75%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.compressintakerequests.md => browser-rum.ruminitconfiguration.compressintakerequests.md} (69%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.defaultprivacylevel.md => browser-rum.ruminitconfiguration.defaultprivacylevel.md} (65%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md => browser-rum.ruminitconfiguration.enableprivacyforactionname.md} (50%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.excludedactivityurls.md => browser-rum.ruminitconfiguration.excludedactivityurls.md} (65%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.md => browser-rum.ruminitconfiguration.md} (71%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.plugins.md => browser-rum.ruminitconfiguration.plugins.md} (63%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.profilingsamplerate.md => browser-rum.ruminitconfiguration.profilingsamplerate.md} (54%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.propagatetracebaggage.md => browser-rum.ruminitconfiguration.propagatetracebaggage.md} (54%) create mode 100644 docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md => browser-rum.ruminitconfiguration.sessionreplaysamplerate.md} (71%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md => browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md} (68%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.subdomain.md => browser-rum.ruminitconfiguration.subdomain.md} (69%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.tracecontextinjection.md => browser-rum.ruminitconfiguration.tracecontextinjection.md} (69%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.tracesamplerate.md => browser-rum.ruminitconfiguration.tracesamplerate.md} (63%) create mode 100644 docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md => browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md} (52%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.tracklongtasks.md => browser-rum.ruminitconfiguration.tracklongtasks.md} (51%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.trackresources.md => browser-rum.ruminitconfiguration.trackresources.md} (50%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.trackuserinteractions.md => browser-rum.ruminitconfiguration.trackuserinteractions.md} (61%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.trackviewsmanually.md => browser-rum.ruminitconfiguration.trackviewsmanually.md} (64%) rename docs/api-reference/rum/{browser-rum-core.ruminitconfiguration.workerurl.md => browser-rum.ruminitconfiguration.workerurl.md} (70%) rename docs/api-reference/rum/{browser-rum-core.rumlongtaskevent.md => browser-rum.rumlongtaskevent.md} (85%) rename docs/api-reference/rum/{browser-rum-core.rumlongtaskeventdomaincontext.md => browser-rum.rumlongtaskeventdomaincontext.md} (59%) create mode 100644 docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md rename docs/api-reference/rum/{browser-rum-core.rumotherresourceeventdomaincontext.md => browser-rum.rumotherresourceeventdomaincontext.md} (58%) create mode 100644 docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md rename docs/api-reference/rum/{browser-rum-core.rumresourceevent.md => browser-rum.rumresourceevent.md} (90%) rename docs/api-reference/rum/{browser-rum-core.rumviewevent.md => browser-rum.rumviewevent.md} (93%) create mode 100644 docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md rename docs/api-reference/rum/{browser-rum-core.rumvieweventdomaincontext.md => browser-rum.rumvieweventdomaincontext.md} (61%) rename docs/api-reference/rum/{browser-rum-core.rumvitalevent.md => browser-rum.rumvitalevent.md} (76%) create mode 100644 docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md create mode 100644 docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md rename docs/api-reference/rum/{browser-rum-core.rumxhrresourceeventdomaincontext.md => browser-rum.rumxhrresourceeventdomaincontext.md} (53%) create mode 100644 docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md create mode 100644 docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md delete mode 100644 etc/browser-rum-core.api.json diff --git a/docs/api-reference/rum/browser-rum-core.actiontype.md b/docs/api-reference/rum/browser-rum-core.actiontype.md deleted file mode 100644 index ed5792175a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.actiontype.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ActionType](./browser-rum-core.actiontype.md) - -## ActionType enum - -**Signature:** - -```typescript -export declare const enum ActionType -``` - -## Enumeration Members - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -CLICK - - - - -`"click"` - - - - - -
- -CUSTOM - - - - -`"custom"` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.censored_img_mark.md b/docs/api-reference/rum/browser-rum-core.censored_img_mark.md deleted file mode 100644 index 93979ea541..0000000000 --- a/docs/api-reference/rum/browser-rum-core.censored_img_mark.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CENSORED\_IMG\_MARK](./browser-rum-core.censored_img_mark.md) - -## CENSORED\_IMG\_MARK variable - -**Signature:** - -```typescript -CENSORED_IMG_MARK = "data:image/gif;base64,R0lGODlhAQABAIAAAMLCwgAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==" -``` diff --git a/docs/api-reference/rum/browser-rum-core.censored_string_mark.md b/docs/api-reference/rum/browser-rum-core.censored_string_mark.md deleted file mode 100644 index e6da7ef5da..0000000000 --- a/docs/api-reference/rum/browser-rum-core.censored_string_mark.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CENSORED\_STRING\_MARK](./browser-rum-core.censored_string_mark.md) - -## CENSORED\_STRING\_MARK variable - -**Signature:** - -```typescript -CENSORED_STRING_MARK = "***" -``` diff --git a/docs/api-reference/rum/browser-rum-core.censortext.md b/docs/api-reference/rum/browser-rum-core.censortext.md deleted file mode 100644 index 43eb80dc24..0000000000 --- a/docs/api-reference/rum/browser-rum-core.censortext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [censorText](./browser-rum-core.censortext.md) - -## censorText variable - -Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay. - -**Signature:** - -```typescript -censorText: (text: string) => string -``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.service.md b/docs/api-reference/rum/browser-rum-core.commonproperties.service.md deleted file mode 100644 index c94b7337cf..0000000000 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.service.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [service](./browser-rum-core.commonproperties.service.md) - -## CommonProperties.service property - -The service name for this application - -**Signature:** - -```typescript -service?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.version.md b/docs/api-reference/rum/browser-rum-core.commonproperties.version.md deleted file mode 100644 index 92d4a79663..0000000000 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [version](./browser-rum-core.commonproperties.version.md) - -## CommonProperties.version property - -The version for this application - -**Signature:** - -```typescript -version?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md b/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md deleted file mode 100644 index 8c611e7bdb..0000000000 --- a/docs/api-reference/rum/browser-rum-core.default_programmatic_action_name_attribute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE](./browser-rum-core.default_programmatic_action_name_attribute.md) - -## DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE variable - -Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute. - -**Signature:** - -```typescript -DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE = "data-dd-action-name" -``` diff --git a/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md b/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md deleted file mode 100644 index 7a2fc81e49..0000000000 --- a/docs/api-reference/rum/browser-rum-core.foreachchildnodes.md +++ /dev/null @@ -1,63 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [forEachChildNodes](./browser-rum-core.foreachchildnodes.md) - -## forEachChildNodes() function - -**Signature:** - -```typescript -export declare function forEachChildNodes(node: Node, callback: (child: Node) => void): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
- -callback - - - - -(child: Node) => void - - - - - -
-**Returns:** - -void - diff --git a/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md b/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md deleted file mode 100644 index fc38cf2337..0000000000 --- a/docs/api-reference/rum/browser-rum-core.form_private_tag_names.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [FORM\_PRIVATE\_TAG\_NAMES](./browser-rum-core.form_private_tag_names.md) - -## FORM\_PRIVATE\_TAG\_NAMES variable - -**Signature:** - -```typescript -FORM_PRIVATE_TAG_NAMES: { - [tagName: string]: true; -} -``` diff --git a/docs/api-reference/rum/browser-rum-core.frustrationtype.md b/docs/api-reference/rum/browser-rum-core.frustrationtype.md deleted file mode 100644 index a2311dd543..0000000000 --- a/docs/api-reference/rum/browser-rum-core.frustrationtype.md +++ /dev/null @@ -1,73 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [FrustrationType](./browser-rum-core.frustrationtype.md) - -## FrustrationType enum - -**Signature:** - -```typescript -export declare const enum FrustrationType -``` - -## Enumeration Members - - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -DEAD\_CLICK - - - - -`"dead_click"` - - - - - -
- -ERROR\_CLICK - - - - -`"error_click"` - - - - - -
- -RAGE\_CLICK - - - - -`"rage_click"` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md b/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md deleted file mode 100644 index b1d1f9b80a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getmutationobserverconstructor.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getMutationObserverConstructor](./browser-rum-core.getmutationobserverconstructor.md) - -## getMutationObserverConstructor() function - -**Signature:** - -```typescript -export declare function getMutationObserverConstructor(): MutationObserverConstructor | undefined; -``` -**Returns:** - -MutationObserverConstructor \| undefined - diff --git a/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md b/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md deleted file mode 100644 index 65e28696a7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getnodeprivacylevel.md +++ /dev/null @@ -1,83 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getNodePrivacyLevel](./browser-rum-core.getnodeprivacylevel.md) - -## getNodePrivacyLevel() function - -Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like: - -derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel) - -**Signature:** - -```typescript -export declare function getNodePrivacyLevel(node: Node, defaultPrivacyLevel: NodePrivacyLevel, cache?: NodePrivacyLevelCache): NodePrivacyLevel; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
- -defaultPrivacyLevel - - - - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
- -cache - - - - -[NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) - - - - -_(Optional)_ - - -
-**Returns:** - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - diff --git a/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md b/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md deleted file mode 100644 index ee6971a8ad..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getnodeselfprivacylevel.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getNodeSelfPrivacyLevel](./browser-rum-core.getnodeselfprivacylevel.md) - -## getNodeSelfPrivacyLevel() function - -Determines the node's own privacy level without checking for ancestors. - -**Signature:** - -```typescript -export declare function getNodeSelfPrivacyLevel(node: Node): NodePrivacyLevel | undefined; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) \| undefined - diff --git a/docs/api-reference/rum/browser-rum-core.getparentnode.md b/docs/api-reference/rum/browser-rum-core.getparentnode.md deleted file mode 100644 index 8800c30ede..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getparentnode.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getParentNode](./browser-rum-core.getparentnode.md) - -## getParentNode() function - -Return `host` in case if the current node is a shadow root otherwise will return the `parentNode` - -**Signature:** - -```typescript -export declare function getParentNode(node: Node): Node | null; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -Node \| null - diff --git a/docs/api-reference/rum/browser-rum-core.getprivacyselector.md b/docs/api-reference/rum/browser-rum-core.getprivacyselector.md deleted file mode 100644 index df69f4035c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getprivacyselector.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getPrivacySelector](./browser-rum-core.getprivacyselector.md) - -## getPrivacySelector() function - -**Signature:** - -```typescript -export declare function getPrivacySelector(privacyLevel: string): string; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -privacyLevel - - - - -string - - - - - -
-**Returns:** - -string - diff --git a/docs/api-reference/rum/browser-rum-core.getscrollx.md b/docs/api-reference/rum/browser-rum-core.getscrollx.md deleted file mode 100644 index 62782c0a62..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getscrollx.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getScrollX](./browser-rum-core.getscrollx.md) - -## getScrollX() function - -**Signature:** - -```typescript -export declare function getScrollX(): number; -``` -**Returns:** - -number - diff --git a/docs/api-reference/rum/browser-rum-core.getscrolly.md b/docs/api-reference/rum/browser-rum-core.getscrolly.md deleted file mode 100644 index 90fe5b6d2b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getscrolly.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getScrollY](./browser-rum-core.getscrolly.md) - -## getScrollY() function - -**Signature:** - -```typescript -export declare function getScrollY(): number; -``` -**Returns:** - -number - diff --git a/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md b/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md deleted file mode 100644 index 5a9f0f5b40..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getsessionreplayurl.md +++ /dev/null @@ -1,67 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getSessionReplayUrl](./browser-rum-core.getsessionreplayurl.md) - -## getSessionReplayUrl() function - -**Signature:** - -```typescript -export declare function getSessionReplayUrl(configuration: RumConfiguration, { session, viewContext, errorType, }: { - session?: RumSession; - viewContext?: ViewHistoryEntry; - errorType?: string; -}): string; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -configuration - - - - -[RumConfiguration](./browser-rum-core.rumconfiguration.md) - - - - - -
- -{ session, viewContext, errorType, } - - - - -{ session?: [RumSession](./browser-rum-core.rumsession.md); viewContext?: [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md); errorType?: string; } - - - - - -
-**Returns:** - -string - diff --git a/docs/api-reference/rum/browser-rum-core.gettextcontent.md b/docs/api-reference/rum/browser-rum-core.gettextcontent.md deleted file mode 100644 index 673ae1c4c7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.gettextcontent.md +++ /dev/null @@ -1,77 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getTextContent](./browser-rum-core.gettextcontent.md) - -## getTextContent() function - -**Signature:** - -```typescript -export declare function getTextContent(textNode: Node, ignoreWhiteSpace: boolean, parentNodePrivacyLevel: NodePrivacyLevel): string | undefined; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -textNode - - - - -Node - - - - - -
- -ignoreWhiteSpace - - - - -boolean - - - - - -
- -parentNodePrivacyLevel - - - - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
-**Returns:** - -string \| undefined - diff --git a/docs/api-reference/rum/browser-rum-core.getviewportdimension.md b/docs/api-reference/rum/browser-rum-core.getviewportdimension.md deleted file mode 100644 index c2539d8cb4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.getviewportdimension.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [getViewportDimension](./browser-rum-core.getviewportdimension.md) - -## getViewportDimension() function - -**Signature:** - -```typescript -export declare function getViewportDimension(): ViewportDimension; -``` -**Returns:** - -[ViewportDimension](./browser-rum-core.viewportdimension.md) - diff --git a/docs/api-reference/rum/browser-rum-core.haschildnodes.md b/docs/api-reference/rum/browser-rum-core.haschildnodes.md deleted file mode 100644 index 51d4ad16c0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.haschildnodes.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [hasChildNodes](./browser-rum-core.haschildnodes.md) - -## hasChildNodes() function - -**Signature:** - -```typescript -export declare function hasChildNodes(node: Node): boolean; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -boolean - diff --git a/docs/api-reference/rum/browser-rum-core.initviewportobservable.md b/docs/api-reference/rum/browser-rum-core.initviewportobservable.md deleted file mode 100644 index 4287b90a43..0000000000 --- a/docs/api-reference/rum/browser-rum-core.initviewportobservable.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [initViewportObservable](./browser-rum-core.initviewportobservable.md) - -## initViewportObservable() function - -**Signature:** - -```typescript -export declare function initViewportObservable(configuration: RumConfiguration): Observable; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -configuration - - - - -[RumConfiguration](./browser-rum-core.rumconfiguration.md) - - - - - -
-**Returns:** - -Observable<[ViewportDimension](./browser-rum-core.viewportdimension.md)> - diff --git a/docs/api-reference/rum/browser-rum-core.iscommentnode.md b/docs/api-reference/rum/browser-rum-core.iscommentnode.md deleted file mode 100644 index 75ede411d3..0000000000 --- a/docs/api-reference/rum/browser-rum-core.iscommentnode.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isCommentNode](./browser-rum-core.iscommentnode.md) - -## isCommentNode() function - -**Signature:** - -```typescript -export declare function isCommentNode(node: Node): node is Comment; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -node is Comment - diff --git a/docs/api-reference/rum/browser-rum-core.iselementnode.md b/docs/api-reference/rum/browser-rum-core.iselementnode.md deleted file mode 100644 index 6a544cc3a0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.iselementnode.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isElementNode](./browser-rum-core.iselementnode.md) - -## isElementNode() function - -**Signature:** - -```typescript -export declare function isElementNode(node: Node): node is Element; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -node is Element - diff --git a/docs/api-reference/rum/browser-rum-core.islongdataurl.md b/docs/api-reference/rum/browser-rum-core.islongdataurl.md deleted file mode 100644 index b8cd5f3319..0000000000 --- a/docs/api-reference/rum/browser-rum-core.islongdataurl.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isLongDataUrl](./browser-rum-core.islongdataurl.md) - -## isLongDataUrl() function - -**Signature:** - -```typescript -export declare function isLongDataUrl(url: string): boolean; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - - -
-**Returns:** - -boolean - diff --git a/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md b/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md deleted file mode 100644 index d817219900..0000000000 --- a/docs/api-reference/rum/browser-rum-core.isnodeshadowhost.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isNodeShadowHost](./browser-rum-core.isnodeshadowhost.md) - -## isNodeShadowHost() function - -**Signature:** - -```typescript -export declare function isNodeShadowHost(node: Node): node is Element & { - shadowRoot: ShadowRoot; -}; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -node is Element & { shadowRoot: ShadowRoot; } - diff --git a/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md b/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md deleted file mode 100644 index 7126b5e861..0000000000 --- a/docs/api-reference/rum/browser-rum-core.isnodeshadowroot.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isNodeShadowRoot](./browser-rum-core.isnodeshadowroot.md) - -## isNodeShadowRoot() function - -**Signature:** - -```typescript -export declare function isNodeShadowRoot(node: Node): node is ShadowRoot; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -node is ShadowRoot - diff --git a/docs/api-reference/rum/browser-rum-core.istextnode.md b/docs/api-reference/rum/browser-rum-core.istextnode.md deleted file mode 100644 index 412a1d7f1b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.istextnode.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [isTextNode](./browser-rum-core.istextnode.md) - -## isTextNode() function - -**Signature:** - -```typescript -export declare function isTextNode(node: Node): node is Text; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
-**Returns:** - -node is Text - diff --git a/docs/api-reference/rum/browser-rum-core.lifecycle.md b/docs/api-reference/rum/browser-rum-core.lifecycle.md deleted file mode 100644 index df6556da24..0000000000 --- a/docs/api-reference/rum/browser-rum-core.lifecycle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [LifeCycle](./browser-rum-core.lifecycle.md) - -## LifeCycle variable - -**Signature:** - -```typescript -LifeCycle: { - new (): AbstractLifeCycle; -} -``` diff --git a/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md b/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md deleted file mode 100644 index 7a7dae6941..0000000000 --- a/docs/api-reference/rum/browser-rum-core.lifecycleeventtype.md +++ /dev/null @@ -1,241 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [LifeCycleEventType](./browser-rum-core.lifecycleeventtype.md) - -## LifeCycleEventType enum - -**Signature:** - -```typescript -export declare const enum LifeCycleEventType -``` - -## Enumeration Members - - - - - - - - - - - - - - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -AFTER\_VIEW\_ENDED - - - - -`6` - - - - - -
- -AUTO\_ACTION\_COMPLETED - - - - -`0` - - - - - -
- -BEFORE\_VIEW\_CREATED - - - - -`1` - - - - - -
- -BEFORE\_VIEW\_UPDATED - - - - -`3` - - - - - -
- -PAGE\_MAY\_EXIT - - - - -`11` - - - - - -
- -RAW\_ERROR\_COLLECTED - - - - -`14` - - - - - -
- -RAW\_RUM\_EVENT\_COLLECTED - - - - -`12` - - - - - -
- -REQUEST\_COMPLETED - - - - -`8` - - - - - -
- -REQUEST\_STARTED - - - - -`7` - - - - - -
- -RUM\_EVENT\_COLLECTED - - - - -`13` - - - - - -
- -SESSION\_EXPIRED - - - - -`9` - - - - - -
- -SESSION\_RENEWED - - - - -`10` - - - - - -
- -VIEW\_CREATED - - - - -`2` - - - - - -
- -VIEW\_ENDED - - - - -`5` - - - - - -
- -VIEW\_UPDATED - - - - -`4` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md b/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md deleted file mode 100644 index f7bde104be..0000000000 --- a/docs/api-reference/rum/browser-rum-core.makerumpublicapi.md +++ /dev/null @@ -1,93 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [makeRumPublicApi](./browser-rum-core.makerumpublicapi.md) - -## makeRumPublicApi() function - -**Signature:** - -```typescript -export declare function makeRumPublicApi(startRumImpl: StartRum, recorderApi: RecorderApi, profilerApi: ProfilerApi, options?: RumPublicApiOptions): RumPublicApi; -``` - -## Parameters - - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -startRumImpl - - - - -[StartRum](./browser-rum-core.startrum.md) - - - - - -
- -recorderApi - - - - -[RecorderApi](./browser-rum-core.recorderapi.md) - - - - - -
- -profilerApi - - - - -[ProfilerApi](./browser-rum-core.profilerapi.md) - - - - - -
- -options - - - - -RumPublicApiOptions - - - - -_(Optional)_ - - -
-**Returns:** - -[RumPublicApi](./browser-rum-core.rumpublicapi.md) - diff --git a/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md b/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md deleted file mode 100644 index f72d2e65b0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.max_attribute_value_char_length.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH](./browser-rum-core.max_attribute_value_char_length.md) - -## MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH variable - -**Signature:** - -```typescript -MAX_ATTRIBUTE_VALUE_CHAR_LENGTH = 24000 -``` diff --git a/docs/api-reference/rum/browser-rum-core.md b/docs/api-reference/rum/browser-rum-core.md deleted file mode 100644 index f7076ae486..0000000000 --- a/docs/api-reference/rum/browser-rum-core.md +++ /dev/null @@ -1,905 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) - -## browser-rum-core package - -## Enumerations - - - - - - - - -
- -Enumeration - - - - -Description - - -
- -[ActionType](./browser-rum-core.actiontype.md) - - - - - -
- -[FrustrationType](./browser-rum-core.frustrationtype.md) - - - - - -
- -[LifeCycleEventType](./browser-rum-core.lifecycleeventtype.md) - - - - - -
- -[RumEventType](./browser-rum-core.rumeventtype.md) - - - - - -
- -[RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) - - - - - -
- -[SessionReplayState](./browser-rum-core.sessionreplaystate.md) - - - - - -
- -## Functions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Function - - - - -Description - - -
- -[forEachChildNodes(node, callback)](./browser-rum-core.foreachchildnodes.md) - - - - - -
- -[getMutationObserverConstructor()](./browser-rum-core.getmutationobserverconstructor.md) - - - - - -
- -[getNodePrivacyLevel(node, defaultPrivacyLevel, cache)](./browser-rum-core.getnodeprivacylevel.md) - - - - -Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like: - -derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel) - - -
- -[getNodeSelfPrivacyLevel(node)](./browser-rum-core.getnodeselfprivacylevel.md) - - - - -Determines the node's own privacy level without checking for ancestors. - - -
- -[getParentNode(node)](./browser-rum-core.getparentnode.md) - - - - -Return `host` in case if the current node is a shadow root otherwise will return the `parentNode` - - -
- -[getPrivacySelector(privacyLevel)](./browser-rum-core.getprivacyselector.md) - - - - - -
- -[getScrollX()](./browser-rum-core.getscrollx.md) - - - - - -
- -[getScrollY()](./browser-rum-core.getscrolly.md) - - - - - -
- -[getSessionReplayUrl(configuration, { session, viewContext, errorType, })](./browser-rum-core.getsessionreplayurl.md) - - - - - -
- -[getTextContent(textNode, ignoreWhiteSpace, parentNodePrivacyLevel)](./browser-rum-core.gettextcontent.md) - - - - - -
- -[getViewportDimension()](./browser-rum-core.getviewportdimension.md) - - - - - -
- -[hasChildNodes(node)](./browser-rum-core.haschildnodes.md) - - - - - -
- -[initViewportObservable(configuration)](./browser-rum-core.initviewportobservable.md) - - - - - -
- -[isCommentNode(node)](./browser-rum-core.iscommentnode.md) - - - - - -
- -[isElementNode(node)](./browser-rum-core.iselementnode.md) - - - - - -
- -[isLongDataUrl(url)](./browser-rum-core.islongdataurl.md) - - - - - -
- -[isNodeShadowHost(node)](./browser-rum-core.isnodeshadowhost.md) - - - - - -
- -[isNodeShadowRoot(node)](./browser-rum-core.isnodeshadowroot.md) - - - - - -
- -[isTextNode(node)](./browser-rum-core.istextnode.md) - - - - - -
- -[makeRumPublicApi(startRumImpl, recorderApi, profilerApi, options)](./browser-rum-core.makerumpublicapi.md) - - - - - -
- -[reducePrivacyLevel(childPrivacyLevel, parentNodePrivacyLevel)](./browser-rum-core.reduceprivacylevel.md) - - - - -Reduces the next privacy level based on self + parent privacy levels - - -
- -[sanitizeDataUrl(url)](./browser-rum-core.sanitizedataurl.md) - - - - - -
- -[shouldIgnoreElement(element)](./browser-rum-core.shouldignoreelement.md) - - - - -TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag. - - -
- -[shouldMaskNode(node, privacyLevel)](./browser-rum-core.shouldmasknode.md) - - - - -Helper aiming to unify `mask` and `mask-user-input` privacy levels: - -In the `mask` case, it is trivial: we should mask the element. - -In the `mask-user-input` case, we should mask the element only if it is a "form" element or the direct parent is a form element for text nodes). - -Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized). - - -
- -[startRum(configuration, recorderApi, profilerApi, initialViewOptions, createEncoder, trackingConsentState, customVitalsState)](./browser-rum-core.startrum.md) - - - - - -
- -[startViewHistory(lifeCycle)](./browser-rum-core.startviewhistory.md) - - - - - -
- -[supportPerformanceTimingEvent(entryType)](./browser-rum-core.supportperformancetimingevent.md) - - - - - -
- -## Interfaces - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Interface - - - - -Description - - -
- -[CommonProperties](./browser-rum-core.commonproperties.md) - - - - -Schema of common properties of RUM events - - -
- -[ProfilerApi](./browser-rum-core.profilerapi.md) - - - - - -
- -[RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) - - - - - -
- -[RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) - - - - - -
- -[RecorderApi](./browser-rum-core.recorderapi.md) - - - - - -
- -[ReplayStats](./browser-rum-core.replaystats.md) - - - - - -
- -[RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) - - - - - -
- -[RumConfiguration](./browser-rum-core.rumconfiguration.md) - - - - - -
- -[RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) - - - - - -
- -[RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) - - - - - -
- -[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) - - - - - -
- -[RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) - - - - - -
- -[RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) - - - - - -
- -[RumPlugin](./browser-rum-core.rumplugin.md) - - - - - -
- -[RumPublicApi](./browser-rum-core.rumpublicapi.md) - - - - - -
- -[RumSessionManager](./browser-rum-core.rumsessionmanager.md) - - - - - -
- -[RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) - - - - - -
- -[RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) - - - - - -
- -[StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) - - - - - -
- -[Strategy](./browser-rum-core.strategy.md) - - - - - -
- -[ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) - - - - - -
- -[ViewHistory](./browser-rum-core.viewhistory.md) - - - - - -
- -[ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) - - - - - -
- -[ViewportDimension](./browser-rum-core.viewportdimension.md) - - - - - -
- -## Variables - - - - - - - - - - - - - - - - - -
- -Variable - - - - -Description - - -
- -[CENSORED\_IMG\_MARK](./browser-rum-core.censored_img_mark.md) - - - - - -
- -[CENSORED\_STRING\_MARK](./browser-rum-core.censored_string_mark.md) - - - - - -
- -[censorText](./browser-rum-core.censortext.md) - - - - -Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay. - - -
- -[DEFAULT\_PROGRAMMATIC\_ACTION\_NAME\_ATTRIBUTE](./browser-rum-core.default_programmatic_action_name_attribute.md) - - - - -Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute. - - -
- -[FORM\_PRIVATE\_TAG\_NAMES](./browser-rum-core.form_private_tag_names.md) - - - - - -
- -[LifeCycle](./browser-rum-core.lifecycle.md) - - - - - -
- -[MAX\_ATTRIBUTE\_VALUE\_CHAR\_LENGTH](./browser-rum-core.max_attribute_value_char_length.md) - - - - - -
- -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
- -[PRIVACY\_ATTR\_NAME](./browser-rum-core.privacy_attr_name.md) - - - - - -
- -[PRIVACY\_ATTR\_VALUE\_ALLOW](./browser-rum-core.privacy_attr_value_allow.md) - - - - - -
- -[PRIVACY\_ATTR\_VALUE\_HIDDEN](./browser-rum-core.privacy_attr_value_hidden.md) - - - - - -
- -[PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT](./browser-rum-core.privacy_attr_value_mask_user_input.md) - - - - - -
- -[PRIVACY\_ATTR\_VALUE\_MASK](./browser-rum-core.privacy_attr_value_mask.md) - - - - - -
- -[PRIVACY\_CLASS\_PREFIX](./browser-rum-core.privacy_class_prefix.md) - - - - - -
- -[STABLE\_ATTRIBUTES](./browser-rum-core.stable_attributes.md) - - - - -Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document. - - -
- -## Type Aliases - - - - - - - - - - - - - - - - - -
- -Type Alias - - - - -Description - - -
- -[LifeCycle](./browser-rum-core.lifecycle.md) - - - - - -
- -[MouseEventOnElement](./browser-rum-core.mouseeventonelement.md) - - - - - -
- -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
- -[NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) - - - - - -
- -[RawRumEvent](./browser-rum-core.rawrumevent.md) - - - - - -
- -[RumActionEvent](./browser-rum-core.rumactionevent.md) - - - - -Schema of all properties of an Action event - - -
- -[RumErrorEvent](./browser-rum-core.rumerrorevent.md) - - - - -Schema of all properties of an Error event - - -
- -[RumEvent](./browser-rum-core.rumevent.md) - - - - -Schema of all properties of a RUM event - - -
- -[RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md) - - - - - -
- -[RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md) - - - - -Schema of all properties of a Long Task event - - -
- -[RumResourceEvent](./browser-rum-core.rumresourceevent.md) - - - - -Schema of all properties of a Resource event - - -
- -[RumSession](./browser-rum-core.rumsession.md) - - - - - -
- -[RumViewEvent](./browser-rum-core.rumviewevent.md) - - - - -Schema of all properties of a View event - - -
- -[RumVitalEvent](./browser-rum-core.rumvitalevent.md) - - - - -Schema of all properties of a Vital event - - -
- -[StartRum](./browser-rum-core.startrum.md) - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md b/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md deleted file mode 100644 index 21dcc03b9e..0000000000 --- a/docs/api-reference/rum/browser-rum-core.mouseeventonelement.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [MouseEventOnElement](./browser-rum-core.mouseeventonelement.md) - -## MouseEventOnElement type - -**Signature:** - -```typescript -export type MouseEventOnElement = PointerEvent & ExtraPointerEventFields; -``` diff --git a/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md b/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md deleted file mode 100644 index 3d031b0156..0000000000 --- a/docs/api-reference/rum/browser-rum-core.nodeprivacylevel.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - -## NodePrivacyLevel variable - -**Signature:** - -```typescript -NodePrivacyLevel: { - readonly IGNORE: "ignore"; - readonly HIDDEN: "hidden"; - readonly ALLOW: "allow"; - readonly MASK: "mask"; - readonly MASK_USER_INPUT: "mask-user-input"; -} -``` diff --git a/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md b/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md deleted file mode 100644 index d3b364c383..0000000000 --- a/docs/api-reference/rum/browser-rum-core.nodeprivacylevelcache.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [NodePrivacyLevelCache](./browser-rum-core.nodeprivacylevelcache.md) - -## NodePrivacyLevelCache type - -**Signature:** - -```typescript -export type NodePrivacyLevelCache = Map; -``` -**References:** [NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md deleted file mode 100644 index ddf32522f0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_attr_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_NAME](./browser-rum-core.privacy_attr_name.md) - -## PRIVACY\_ATTR\_NAME variable - -**Signature:** - -```typescript -PRIVACY_ATTR_NAME = "data-dd-privacy" -``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md deleted file mode 100644 index db1a668944..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_allow.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_ALLOW](./browser-rum-core.privacy_attr_value_allow.md) - -## PRIVACY\_ATTR\_VALUE\_ALLOW variable - -**Signature:** - -```typescript -PRIVACY_ATTR_VALUE_ALLOW = "allow" -``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md deleted file mode 100644 index ee0c968d24..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_hidden.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_HIDDEN](./browser-rum-core.privacy_attr_value_hidden.md) - -## PRIVACY\_ATTR\_VALUE\_HIDDEN variable - -**Signature:** - -```typescript -PRIVACY_ATTR_VALUE_HIDDEN = "hidden" -``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md deleted file mode 100644 index 895367370f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_MASK](./browser-rum-core.privacy_attr_value_mask.md) - -## PRIVACY\_ATTR\_VALUE\_MASK variable - -**Signature:** - -```typescript -PRIVACY_ATTR_VALUE_MASK = "mask" -``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md b/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md deleted file mode 100644 index 7bdc9d0621..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_attr_value_mask_user_input.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT](./browser-rum-core.privacy_attr_value_mask_user_input.md) - -## PRIVACY\_ATTR\_VALUE\_MASK\_USER\_INPUT variable - -**Signature:** - -```typescript -PRIVACY_ATTR_VALUE_MASK_USER_INPUT = "mask-user-input" -``` diff --git a/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md b/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md deleted file mode 100644 index cbc0ae2584..0000000000 --- a/docs/api-reference/rum/browser-rum-core.privacy_class_prefix.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [PRIVACY\_CLASS\_PREFIX](./browser-rum-core.privacy_class_prefix.md) - -## PRIVACY\_CLASS\_PREFIX variable - -**Signature:** - -```typescript -PRIVACY_CLASS_PREFIX = "dd-privacy-" -``` diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.md b/docs/api-reference/rum/browser-rum-core.profilerapi.md deleted file mode 100644 index ac5a61f639..0000000000 --- a/docs/api-reference/rum/browser-rum-core.profilerapi.md +++ /dev/null @@ -1,70 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) - -## ProfilerApi interface - -**Signature:** - -```typescript -export interface ProfilerApi -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[onRumStart](./browser-rum-core.profilerapi.onrumstart.md) - - - - - - - -(lifeCycle: [LifeCycle](./browser-rum-core.lifecycle.md), configuration: [RumConfiguration](./browser-rum-core.rumconfiguration.md), sessionManager: [RumSessionManager](./browser-rum-core.rumsessionmanager.md), viewHistory: [ViewHistory](./browser-rum-core.viewhistory.md)) => void - - - - - -
- -[stop](./browser-rum-core.profilerapi.stop.md) - - - - - - - -() => void - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md b/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md deleted file mode 100644 index c55c32d36c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.profilerapi.onrumstart.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) > [onRumStart](./browser-rum-core.profilerapi.onrumstart.md) - -## ProfilerApi.onRumStart property - -**Signature:** - -```typescript -onRumStart: (lifeCycle: LifeCycle, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md b/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md deleted file mode 100644 index 819dcd1d0c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.profilerapi.stop.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ProfilerApi](./browser-rum-core.profilerapi.md) > [stop](./browser-rum-core.profilerapi.stop.md) - -## ProfilerApi.stop property - -**Signature:** - -```typescript -stop: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md deleted file mode 100644 index f842e9c8f6..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent._dd.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [\_dd](./browser-rum-core.rawrumactionevent._dd.md) - -## RawRumActionEvent.\_dd property - -**Signature:** - -```typescript -_dd?: { - action?: { - target?: { - selector?: string; - width?: number; - height?: number; - }; - name_source?: string; - position?: { - x: number; - y: number; - }; - pointer_up_delay?: Duration; - }; - }; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md deleted file mode 100644 index 6e7e926ce8..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.action.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [action](./browser-rum-core.rawrumactionevent.action.md) - -## RawRumActionEvent.action property - -**Signature:** - -```typescript -action: { - id: string; - type: ActionType; - loading_time?: ServerDuration; - frustration?: { - type: FrustrationType[]; - }; - error?: Count; - long_task?: Count; - resource?: Count; - target: { - name: string; - }; - }; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md deleted file mode 100644 index e60abd0055..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.date.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [date](./browser-rum-core.rawrumactionevent.date.md) - -## RawRumActionEvent.date property - -**Signature:** - -```typescript -date: TimeStamp; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md deleted file mode 100644 index ce47035543..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.md +++ /dev/null @@ -1,125 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) - -## RawRumActionEvent interface - -**Signature:** - -```typescript -export interface RawRumActionEvent -``` - -## Properties - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[\_dd?](./browser-rum-core.rawrumactionevent._dd.md) - - - - - - - -{ action?: { target?: { selector?: string; width?: number; height?: number; }; name\_source?: string; position?: { x: number; y: number; }; pointer\_up\_delay?: Duration; }; } - - - - -_(Optional)_ - - -
- -[action](./browser-rum-core.rawrumactionevent.action.md) - - - - - - - -{ id: string; type: [ActionType](./browser-rum-core.actiontype.md); loading\_time?: ServerDuration; frustration?: { type: [FrustrationType](./browser-rum-core.frustrationtype.md)\[\]; }; error?: Count; long\_task?: Count; resource?: Count; target: { name: string; }; } - - - - - -
- -[date](./browser-rum-core.rawrumactionevent.date.md) - - - - - - - -TimeStamp - - - - - -
- -[type](./browser-rum-core.rawrumactionevent.type.md) - - - - - - - -[RumEventType.ACTION](./browser-rum-core.rumeventtype.md) - - - - - -
- -[view?](./browser-rum-core.rawrumactionevent.view.md) - - - - - - - -{ in\_foreground: boolean; } - - - - -_(Optional)_ - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md deleted file mode 100644 index cdb94b33d3..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [type](./browser-rum-core.rawrumactionevent.type.md) - -## RawRumActionEvent.type property - -**Signature:** - -```typescript -type: RumEventType.ACTION; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md b/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md deleted file mode 100644 index ff7ec01314..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumactionevent.view.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) > [view](./browser-rum-core.rawrumactionevent.view.md) - -## RawRumActionEvent.view property - -**Signature:** - -```typescript -view?: { - in_foreground: boolean; - }; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumevent.md b/docs/api-reference/rum/browser-rum-core.rawrumevent.md deleted file mode 100644 index dd2c1f5dbd..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumevent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEvent](./browser-rum-core.rawrumevent.md) - -## RawRumEvent type - -**Signature:** - -```typescript -export type RawRumEvent = RawRumErrorEvent | RawRumResourceEvent | RawRumViewEvent | RawRumLongTaskEvent | RawRumLongAnimationFrameEvent | RawRumActionEvent | RawRumVitalEvent; -``` -**References:** [RawRumActionEvent](./browser-rum-core.rawrumactionevent.md) - diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md deleted file mode 100644 index 0a07e2c02c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.customercontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [customerContext](./browser-rum-core.rawrumeventcollecteddata.customercontext.md) - -## RawRumEventCollectedData.customerContext property - -**Signature:** - -```typescript -customerContext?: Context; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md deleted file mode 100644 index 0bb722f431..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.domaincontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [domainContext](./browser-rum-core.rawrumeventcollecteddata.domaincontext.md) - -## RawRumEventCollectedData.domainContext property - -**Signature:** - -```typescript -domainContext: RumEventDomainContext; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md deleted file mode 100644 index 9f941cbf81..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.duration.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [duration](./browser-rum-core.rawrumeventcollecteddata.duration.md) - -## RawRumEventCollectedData.duration property - -**Signature:** - -```typescript -duration?: Duration; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md deleted file mode 100644 index 0d7d6bef35..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.md +++ /dev/null @@ -1,125 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) - -## RawRumEventCollectedData interface - -**Signature:** - -```typescript -export interface RawRumEventCollectedData -``` - -## Properties - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[customerContext?](./browser-rum-core.rawrumeventcollecteddata.customercontext.md) - - - - - - - -Context - - - - -_(Optional)_ - - -
- -[domainContext](./browser-rum-core.rawrumeventcollecteddata.domaincontext.md) - - - - - - - -[RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md)<E\['type'\]> - - - - - -
- -[duration?](./browser-rum-core.rawrumeventcollecteddata.duration.md) - - - - - - - -Duration - - - - -_(Optional)_ - - -
- -[rawRumEvent](./browser-rum-core.rawrumeventcollecteddata.rawrumevent.md) - - - - - - - -E - - - - - -
- -[startTime](./browser-rum-core.rawrumeventcollecteddata.starttime.md) - - - - - - - -RelativeTime - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md deleted file mode 100644 index 9ee713b619..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.rawrumevent.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [rawRumEvent](./browser-rum-core.rawrumeventcollecteddata.rawrumevent.md) - -## RawRumEventCollectedData.rawRumEvent property - -**Signature:** - -```typescript -rawRumEvent: E; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md b/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md deleted file mode 100644 index 2831a41380..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rawrumeventcollecteddata.starttime.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RawRumEventCollectedData](./browser-rum-core.rawrumeventcollecteddata.md) > [startTime](./browser-rum-core.rawrumeventcollecteddata.starttime.md) - -## RawRumEventCollectedData.startTime property - -**Signature:** - -```typescript -startTime: RelativeTime; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md b/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md deleted file mode 100644 index a26f7231ff..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.getreplaystats.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [getReplayStats](./browser-rum-core.recorderapi.getreplaystats.md) - -## RecorderApi.getReplayStats property - -**Signature:** - -```typescript -getReplayStats: (viewId: string) => ReplayStats | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md b/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md deleted file mode 100644 index 3dacf34a09..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.getsessionreplaylink.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [getSessionReplayLink](./browser-rum-core.recorderapi.getsessionreplaylink.md) - -## RecorderApi.getSessionReplayLink property - -**Signature:** - -```typescript -getSessionReplayLink: () => string | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md b/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md deleted file mode 100644 index 76bfeed391..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.isrecording.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [isRecording](./browser-rum-core.recorderapi.isrecording.md) - -## RecorderApi.isRecording property - -**Signature:** - -```typescript -isRecording: () => boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.md b/docs/api-reference/rum/browser-rum-core.recorderapi.md deleted file mode 100644 index 166d8c2f2a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.md +++ /dev/null @@ -1,138 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) - -## RecorderApi interface - -**Signature:** - -```typescript -export interface RecorderApi -``` - -## Properties - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[getReplayStats](./browser-rum-core.recorderapi.getreplaystats.md) - - - - - - - -(viewId: string) => [ReplayStats](./browser-rum-core.replaystats.md) \| undefined - - - - - -
- -[getSessionReplayLink](./browser-rum-core.recorderapi.getsessionreplaylink.md) - - - - - - - -() => string \| undefined - - - - - -
- -[isRecording](./browser-rum-core.recorderapi.isrecording.md) - - - - - - - -() => boolean - - - - - -
- -[onRumStart](./browser-rum-core.recorderapi.onrumstart.md) - - - - - - - -(lifeCycle: [LifeCycle](./browser-rum-core.lifecycle.md), configuration: [RumConfiguration](./browser-rum-core.rumconfiguration.md), sessionManager: [RumSessionManager](./browser-rum-core.rumsessionmanager.md), viewHistory: [ViewHistory](./browser-rum-core.viewhistory.md), deflateWorker: DeflateWorker \| undefined) => void - - - - - -
- -[start](./browser-rum-core.recorderapi.start.md) - - - - - - - -(options?: [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md)) => void - - - - - -
- -[stop](./browser-rum-core.recorderapi.stop.md) - - - - - - - -() => void - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md b/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md deleted file mode 100644 index b7be2048e5..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.onrumstart.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [onRumStart](./browser-rum-core.recorderapi.onrumstart.md) - -## RecorderApi.onRumStart property - -**Signature:** - -```typescript -onRumStart: (lifeCycle: LifeCycle, configuration: RumConfiguration, sessionManager: RumSessionManager, viewHistory: ViewHistory, deflateWorker: DeflateWorker | undefined) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.start.md b/docs/api-reference/rum/browser-rum-core.recorderapi.start.md deleted file mode 100644 index b86b7b4239..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.start.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [start](./browser-rum-core.recorderapi.start.md) - -## RecorderApi.start property - -**Signature:** - -```typescript -start: (options?: StartRecordingOptions) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md b/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md deleted file mode 100644 index de65e25972..0000000000 --- a/docs/api-reference/rum/browser-rum-core.recorderapi.stop.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RecorderApi](./browser-rum-core.recorderapi.md) > [stop](./browser-rum-core.recorderapi.stop.md) - -## RecorderApi.stop property - -**Signature:** - -```typescript -stop: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md b/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md deleted file mode 100644 index fdf01def9a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.reduceprivacylevel.md +++ /dev/null @@ -1,65 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [reducePrivacyLevel](./browser-rum-core.reduceprivacylevel.md) - -## reducePrivacyLevel() function - -Reduces the next privacy level based on self + parent privacy levels - -**Signature:** - -```typescript -export declare function reducePrivacyLevel(childPrivacyLevel: NodePrivacyLevel | undefined, parentNodePrivacyLevel: NodePrivacyLevel): NodePrivacyLevel; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -childPrivacyLevel - - - - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) \| undefined - - - - - -
- -parentNodePrivacyLevel - - - - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
-**Returns:** - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.md b/docs/api-reference/rum/browser-rum-core.replaystats.md deleted file mode 100644 index c6cae2fe68..0000000000 --- a/docs/api-reference/rum/browser-rum-core.replaystats.md +++ /dev/null @@ -1,87 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) - -## ReplayStats interface - -**Signature:** - -```typescript -export interface ReplayStats -``` - -## Properties - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[records\_count](./browser-rum-core.replaystats.records_count.md) - - - - - - - -number - - - - - -
- -[segments\_count](./browser-rum-core.replaystats.segments_count.md) - - - - - - - -number - - - - - -
- -[segments\_total\_raw\_size](./browser-rum-core.replaystats.segments_total_raw_size.md) - - - - - - - -number - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md b/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md deleted file mode 100644 index fe3f25060f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.replaystats.records_count.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [records\_count](./browser-rum-core.replaystats.records_count.md) - -## ReplayStats.records\_count property - -**Signature:** - -```typescript -records_count: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md b/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md deleted file mode 100644 index 7f113d2543..0000000000 --- a/docs/api-reference/rum/browser-rum-core.replaystats.segments_count.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [segments\_count](./browser-rum-core.replaystats.segments_count.md) - -## ReplayStats.segments\_count property - -**Signature:** - -```typescript -segments_count: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md b/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md deleted file mode 100644 index 254f0c36db..0000000000 --- a/docs/api-reference/rum/browser-rum-core.replaystats.segments_total_raw_size.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ReplayStats](./browser-rum-core.replaystats.md) > [segments\_total\_raw\_size](./browser-rum-core.replaystats.segments_total_raw_size.md) - -## ReplayStats.segments\_total\_raw\_size property - -**Signature:** - -```typescript -segments_total_raw_size: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md deleted file mode 100644 index 5afe16fd8f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.events.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) > [events](./browser-rum-core.rumactioneventdomaincontext.events.md) - -## RumActionEventDomainContext.events property - -**Signature:** - -```typescript -events?: Event[]; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md deleted file mode 100644 index 80eddb8ef7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.handlingstack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) > [handlingStack](./browser-rum-core.rumactioneventdomaincontext.handlingstack.md) - -## RumActionEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md deleted file mode 100644 index f30cdb8773..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.actionnameattribute.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [actionNameAttribute](./browser-rum-core.rumconfiguration.actionnameattribute.md) - -## RumConfiguration.actionNameAttribute property - -**Signature:** - -```typescript -actionNameAttribute: string | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md deleted file mode 100644 index 1cbc936bb0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.allowedtracingurls.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [allowedTracingUrls](./browser-rum-core.rumconfiguration.allowedtracingurls.md) - -## RumConfiguration.allowedTracingUrls property - -**Signature:** - -```typescript -allowedTracingUrls: TracingOption[]; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md deleted file mode 100644 index c109ac8ad7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.applicationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [applicationId](./browser-rum-core.rumconfiguration.applicationid.md) - -## RumConfiguration.applicationId property - -**Signature:** - -```typescript -applicationId: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md deleted file mode 100644 index 8a4f347bed..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.compressintakerequests.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [compressIntakeRequests](./browser-rum-core.rumconfiguration.compressintakerequests.md) - -## RumConfiguration.compressIntakeRequests property - -**Signature:** - -```typescript -compressIntakeRequests: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md deleted file mode 100644 index 3bf9898308..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [customerDataTelemetrySampleRate](./browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md) - -## RumConfiguration.customerDataTelemetrySampleRate property - -**Signature:** - -```typescript -customerDataTelemetrySampleRate: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md deleted file mode 100644 index 5123733626..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.defaultprivacylevel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [defaultPrivacyLevel](./browser-rum-core.rumconfiguration.defaultprivacylevel.md) - -## RumConfiguration.defaultPrivacyLevel property - -**Signature:** - -```typescript -defaultPrivacyLevel: DefaultPrivacyLevel; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md deleted file mode 100644 index 6f7772117c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.enableprivacyforactionname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [enablePrivacyForActionName](./browser-rum-core.rumconfiguration.enableprivacyforactionname.md) - -## RumConfiguration.enablePrivacyForActionName property - -**Signature:** - -```typescript -enablePrivacyForActionName: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md deleted file mode 100644 index bd6ae03925..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.excludedactivityurls.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [excludedActivityUrls](./browser-rum-core.rumconfiguration.excludedactivityurls.md) - -## RumConfiguration.excludedActivityUrls property - -**Signature:** - -```typescript -excludedActivityUrls: MatchOption[]; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.md deleted file mode 100644 index 4e5c1682f5..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.md +++ /dev/null @@ -1,449 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) - -## RumConfiguration interface - -**Signature:** - -```typescript -export interface RumConfiguration extends Configuration -``` -**Extends:** Configuration - -## Properties - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[actionNameAttribute](./browser-rum-core.rumconfiguration.actionnameattribute.md) - - - - - - - -string \| undefined - - - - - -
- -[allowedTracingUrls](./browser-rum-core.rumconfiguration.allowedtracingurls.md) - - - - - - - -TracingOption\[\] - - - - - -
- -[applicationId](./browser-rum-core.rumconfiguration.applicationid.md) - - - - - - - -string - - - - - -
- -[compressIntakeRequests](./browser-rum-core.rumconfiguration.compressintakerequests.md) - - - - - - - -boolean - - - - - -
- -[customerDataTelemetrySampleRate](./browser-rum-core.rumconfiguration.customerdatatelemetrysamplerate.md) - - - - - - - -number - - - - - -
- -[defaultPrivacyLevel](./browser-rum-core.rumconfiguration.defaultprivacylevel.md) - - - - - - - -DefaultPrivacyLevel - - - - - -
- -[enablePrivacyForActionName](./browser-rum-core.rumconfiguration.enableprivacyforactionname.md) - - - - - - - -boolean - - - - - -
- -[excludedActivityUrls](./browser-rum-core.rumconfiguration.excludedactivityurls.md) - - - - - - - -MatchOption\[\] - - - - - -
- -[plugins](./browser-rum-core.rumconfiguration.plugins.md) - - - - - - - -[RumPlugin](./browser-rum-core.rumplugin.md)\[\] - - - - - -
- -[profilingSampleRate](./browser-rum-core.rumconfiguration.profilingsamplerate.md) - - - - - - - -number - - - - - -
- -[propagateTraceBaggage](./browser-rum-core.rumconfiguration.propagatetracebaggage.md) - - - - - - - -boolean - - - - - -
- -[rulePsr](./browser-rum-core.rumconfiguration.rulepsr.md) - - - - - - - -number \| undefined - - - - - -
- -[sessionReplaySampleRate](./browser-rum-core.rumconfiguration.sessionreplaysamplerate.md) - - - - - - - -number - - - - - -
- -[startSessionReplayRecordingManually](./browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md) - - - - - - - -boolean - - - - - -
- -[subdomain?](./browser-rum-core.rumconfiguration.subdomain.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[traceContextInjection](./browser-rum-core.rumconfiguration.tracecontextinjection.md) - - - - - - - -TraceContextInjection - - - - - -
- -[traceSampleRate](./browser-rum-core.rumconfiguration.tracesamplerate.md) - - - - - - - -number - - - - - -
- -[trackFeatureFlagsForEvents](./browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md) - - - - - - - -FeatureFlagsForEvents\[\] - - - - - -
- -[trackLongTasks](./browser-rum-core.rumconfiguration.tracklongtasks.md) - - - - - - - -boolean - - - - - -
- -[trackResources](./browser-rum-core.rumconfiguration.trackresources.md) - - - - - - - -boolean - - - - - -
- -[trackUserInteractions](./browser-rum-core.rumconfiguration.trackuserinteractions.md) - - - - - - - -boolean - - - - - -
- -[trackViewsManually](./browser-rum-core.rumconfiguration.trackviewsmanually.md) - - - - - - - -boolean - - - - - -
- -[version?](./browser-rum-core.rumconfiguration.version.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[workerUrl](./browser-rum-core.rumconfiguration.workerurl.md) - - - - - - - -string \| undefined - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md deleted file mode 100644 index d1450b4f84..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.plugins.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [plugins](./browser-rum-core.rumconfiguration.plugins.md) - -## RumConfiguration.plugins property - -**Signature:** - -```typescript -plugins: RumPlugin[]; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md deleted file mode 100644 index 9f9e6f779c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.profilingsamplerate.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [profilingSampleRate](./browser-rum-core.rumconfiguration.profilingsamplerate.md) - -## RumConfiguration.profilingSampleRate property - -**Signature:** - -```typescript -profilingSampleRate: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md deleted file mode 100644 index 2a165facf6..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.propagatetracebaggage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [propagateTraceBaggage](./browser-rum-core.rumconfiguration.propagatetracebaggage.md) - -## RumConfiguration.propagateTraceBaggage property - -**Signature:** - -```typescript -propagateTraceBaggage: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md deleted file mode 100644 index ffeb4b7419..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.rulepsr.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [rulePsr](./browser-rum-core.rumconfiguration.rulepsr.md) - -## RumConfiguration.rulePsr property - -**Signature:** - -```typescript -rulePsr: number | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md deleted file mode 100644 index 3c8843f275..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.sessionreplaysamplerate.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [sessionReplaySampleRate](./browser-rum-core.rumconfiguration.sessionreplaysamplerate.md) - -## RumConfiguration.sessionReplaySampleRate property - -**Signature:** - -```typescript -sessionReplaySampleRate: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md deleted file mode 100644 index 8f5619cc90..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum-core.rumconfiguration.startsessionreplayrecordingmanually.md) - -## RumConfiguration.startSessionReplayRecordingManually property - -**Signature:** - -```typescript -startSessionReplayRecordingManually: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md deleted file mode 100644 index 42c354ba26..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.subdomain.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [subdomain](./browser-rum-core.rumconfiguration.subdomain.md) - -## RumConfiguration.subdomain property - -**Signature:** - -```typescript -subdomain?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md deleted file mode 100644 index b382c60347..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracecontextinjection.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [traceContextInjection](./browser-rum-core.rumconfiguration.tracecontextinjection.md) - -## RumConfiguration.traceContextInjection property - -**Signature:** - -```typescript -traceContextInjection: TraceContextInjection; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md deleted file mode 100644 index 9a587b9297..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracesamplerate.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [traceSampleRate](./browser-rum-core.rumconfiguration.tracesamplerate.md) - -## RumConfiguration.traceSampleRate property - -**Signature:** - -```typescript -traceSampleRate: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md deleted file mode 100644 index 6fcab40447..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum-core.rumconfiguration.trackfeatureflagsforevents.md) - -## RumConfiguration.trackFeatureFlagsForEvents property - -**Signature:** - -```typescript -trackFeatureFlagsForEvents: FeatureFlagsForEvents[]; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md deleted file mode 100644 index 68ca55fbe2..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.tracklongtasks.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackLongTasks](./browser-rum-core.rumconfiguration.tracklongtasks.md) - -## RumConfiguration.trackLongTasks property - -**Signature:** - -```typescript -trackLongTasks: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md deleted file mode 100644 index 7f8140fc9c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackresources.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackResources](./browser-rum-core.rumconfiguration.trackresources.md) - -## RumConfiguration.trackResources property - -**Signature:** - -```typescript -trackResources: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md deleted file mode 100644 index b6b11dd237..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackuserinteractions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackUserInteractions](./browser-rum-core.rumconfiguration.trackuserinteractions.md) - -## RumConfiguration.trackUserInteractions property - -**Signature:** - -```typescript -trackUserInteractions: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md deleted file mode 100644 index 6c3ff1029a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.trackviewsmanually.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [trackViewsManually](./browser-rum-core.rumconfiguration.trackviewsmanually.md) - -## RumConfiguration.trackViewsManually property - -**Signature:** - -```typescript -trackViewsManually: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md deleted file mode 100644 index e67ac7d030..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [version](./browser-rum-core.rumconfiguration.version.md) - -## RumConfiguration.version property - -**Signature:** - -```typescript -version?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md b/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md deleted file mode 100644 index a43a16ab25..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumconfiguration.workerurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumConfiguration](./browser-rum-core.rumconfiguration.md) > [workerUrl](./browser-rum-core.rumconfiguration.workerurl.md) - -## RumConfiguration.workerUrl property - -**Signature:** - -```typescript -workerUrl: string | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md deleted file mode 100644 index 867f19bdb7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) > [error](./browser-rum-core.rumerroreventdomaincontext.error.md) - -## RumErrorEventDomainContext.error property - -**Signature:** - -```typescript -error: unknown; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md deleted file mode 100644 index 2ac3038d73..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.handlingstack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) > [handlingStack](./browser-rum-core.rumerroreventdomaincontext.handlingstack.md) - -## RumErrorEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumevent.md b/docs/api-reference/rum/browser-rum-core.rumevent.md deleted file mode 100644 index 79e8ad1fd9..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumevent.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEvent](./browser-rum-core.rumevent.md) - -## RumEvent type - -Schema of all properties of a RUM event - -**Signature:** - -```typescript -export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; -``` -**References:** [RumActionEvent](./browser-rum-core.rumactionevent.md), [RumErrorEvent](./browser-rum-core.rumerrorevent.md), [RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md), [RumResourceEvent](./browser-rum-core.rumresourceevent.md), [RumViewEvent](./browser-rum-core.rumviewevent.md), [RumVitalEvent](./browser-rum-core.rumvitalevent.md) - diff --git a/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md b/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md deleted file mode 100644 index e526ec1b2f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumeventdomaincontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md) - -## RumEventDomainContext type - -**Signature:** - -```typescript -export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; -``` -**References:** [RumEventType](./browser-rum-core.rumeventtype.md), [RumEventType.VIEW](./browser-rum-core.rumeventtype.md), [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md), [RumEventType.ACTION](./browser-rum-core.rumeventtype.md), [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md), [RumEventType.RESOURCE](./browser-rum-core.rumeventtype.md), [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md), [RumEventType.ERROR](./browser-rum-core.rumeventtype.md), [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md), [RumEventType.LONG\_TASK](./browser-rum-core.rumeventtype.md), [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md), [RumEventType.VITAL](./browser-rum-core.rumeventtype.md) - diff --git a/docs/api-reference/rum/browser-rum-core.rumeventtype.md b/docs/api-reference/rum/browser-rum-core.rumeventtype.md deleted file mode 100644 index b2b61d6661..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumeventtype.md +++ /dev/null @@ -1,115 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumEventType](./browser-rum-core.rumeventtype.md) - -## RumEventType enum - -**Signature:** - -```typescript -export declare const enum RumEventType -``` - -## Enumeration Members - - - - - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -ACTION - - - - -`"action"` - - - - - -
- -ERROR - - - - -`"error"` - - - - - -
- -LONG\_TASK - - - - -`"long_task"` - - - - - -
- -RESOURCE - - - - -`"resource"` - - - - - -
- -VIEW - - - - -`"view"` - - - - - -
- -VITAL - - - - -`"vital"` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md deleted file mode 100644 index 5fd4f2a05a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [error](./browser-rum-core.rumfetchresourceeventdomaincontext.error.md) - -## RumFetchResourceEventDomainContext.error property - -**Signature:** - -```typescript -error?: Error; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md deleted file mode 100644 index 8ed1ebe68f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [handlingStack](./browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md) - -## RumFetchResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md deleted file mode 100644 index 3826406053..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [isAborted](./browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md) - -## RumFetchResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md deleted file mode 100644 index 3f6ad497ca..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md) - -## RumFetchResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md deleted file mode 100644 index 3fb2720966..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [requestInit](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md) - -## RumFetchResourceEventDomainContext.requestInit property - -**Signature:** - -```typescript -requestInit?: RequestInit; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md deleted file mode 100644 index cadf54b2b4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [requestInput](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md) - -## RumFetchResourceEventDomainContext.requestInput property - -**Signature:** - -```typescript -requestInput: RequestInfo; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md b/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md deleted file mode 100644 index 798c0dceec..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) > [response](./browser-rum-core.rumfetchresourceeventdomaincontext.response.md) - -## RumFetchResourceEventDomainContext.response property - -**Signature:** - -```typescript -response?: Response; -``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md deleted file mode 100644 index 27ed1d8648..0000000000 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.applicationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [applicationId](./browser-rum-core.ruminitconfiguration.applicationid.md) - -## RumInitConfiguration.applicationId property - -The RUM application ID. - -**Signature:** - -```typescript -applicationId: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md b/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md deleted file mode 100644 index 3163fda2ab..0000000000 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.remoteconfigurationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [remoteConfigurationId](./browser-rum-core.ruminitconfiguration.remoteconfigurationid.md) - -## RumInitConfiguration.remoteConfigurationId property - -**Signature:** - -```typescript -remoteConfigurationId?: string | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md deleted file mode 100644 index 552af2a8dc..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md) - -## RumLongTaskEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md deleted file mode 100644 index 11851ca297..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md) - -## RumOtherResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md b/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md deleted file mode 100644 index 4bd8633391..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumperformanceentrytype.md +++ /dev/null @@ -1,171 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) - -## RumPerformanceEntryType enum - -**Signature:** - -```typescript -export declare enum RumPerformanceEntryType -``` - -## Enumeration Members - - - - - - - - - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -EVENT - - - - -`"event"` - - - - - -
- -FIRST\_INPUT - - - - -`"first-input"` - - - - - -
- -LARGEST\_CONTENTFUL\_PAINT - - - - -`"largest-contentful-paint"` - - - - - -
- -LAYOUT\_SHIFT - - - - -`"layout-shift"` - - - - - -
- -LONG\_ANIMATION\_FRAME - - - - -`"long-animation-frame"` - - - - - -
- -LONG\_TASK - - - - -`"longtask"` - - - - - -
- -NAVIGATION - - - - -`"navigation"` - - - - - -
- -PAINT - - - - -`"paint"` - - - - - -
- -RESOURCE - - - - -`"resource"` - - - - - -
- -VISIBILITY\_STATE - - - - -`"visibility-state"` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md b/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md deleted file mode 100644 index feacaddd87..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumplugin.getconfigurationtelemetry.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [getConfigurationTelemetry](./browser-rum-core.rumplugin.getconfigurationtelemetry.md) - -## RumPlugin.getConfigurationTelemetry() method - -**Signature:** - -```typescript -getConfigurationTelemetry?(): Record; -``` -**Returns:** - -Record<string, unknown> - diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.md b/docs/api-reference/rum/browser-rum-core.rumplugin.md deleted file mode 100644 index 8dd9b789a2..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumplugin.md +++ /dev/null @@ -1,101 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) - -## RumPlugin interface - -**Signature:** - -```typescript -export interface RumPlugin -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[name](./browser-rum-core.rumplugin.name.md) - - - - - - - -string - - - - - -
- -## Methods - - - - - -
- -Method - - - - -Description - - -
- -[getConfigurationTelemetry()?](./browser-rum-core.rumplugin.getconfigurationtelemetry.md) - - - - -_(Optional)_ - - -
- -[onInit(options)?](./browser-rum-core.rumplugin.oninit.md) - - - - -_(Optional)_ - - -
- -[onRumStart(options)?](./browser-rum-core.rumplugin.onrumstart.md) - - - - -_(Optional)_ - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.name.md b/docs/api-reference/rum/browser-rum-core.rumplugin.name.md deleted file mode 100644 index 253b58eb6b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumplugin.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [name](./browser-rum-core.rumplugin.name.md) - -## RumPlugin.name property - -**Signature:** - -```typescript -name: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md b/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md deleted file mode 100644 index 3d59169d1b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumplugin.oninit.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [onInit](./browser-rum-core.rumplugin.oninit.md) - -## RumPlugin.onInit() method - -**Signature:** - -```typescript -onInit?(options: { - initConfiguration: RumInitConfiguration; - publicApi: RumPublicApi; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -options - - - - -{ initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md); publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md); } - - - - - -
-**Returns:** - -void - diff --git a/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md b/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md deleted file mode 100644 index ece83a6e33..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumplugin.onrumstart.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPlugin](./browser-rum-core.rumplugin.md) > [onRumStart](./browser-rum-core.rumplugin.onrumstart.md) - -## RumPlugin.onRumStart() method - -**Signature:** - -```typescript -onRumStart?(options: { - strategy: Strategy; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -options - - - - -{ strategy: [Strategy](./browser-rum-core.strategy.md); } - - - - - -
-**Returns:** - -void - diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md deleted file mode 100644 index 44278d08c0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addaction.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addAction](./browser-rum-core.rumpublicapi.addaction.md) - -## RumPublicApi.addAction property - -Add a custom action, stored in `@action` - -**Signature:** - -```typescript -addAction: (name: string, context?: object) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md deleted file mode 100644 index 698f7a3836..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adderror.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addError](./browser-rum-core.rumpublicapi.adderror.md) - -## RumPublicApi.addError property - -Add a custom error, stored in `@error`. - -**Signature:** - -```typescript -addError: (error: unknown, context?: object) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md deleted file mode 100644 index 6c941fcd25..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addfeatureflagevaluation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addFeatureFlagEvaluation](./browser-rum-core.rumpublicapi.addfeatureflagevaluation.md) - -## RumPublicApi.addFeatureFlagEvaluation property - -Add a feature flag evaluation, stored in `@feature_flags.` - -**Signature:** - -```typescript -addFeatureFlagEvaluation: (key: string, value: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md deleted file mode 100644 index 79a28408c4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearaccount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearAccount](./browser-rum-core.rumpublicapi.clearaccount.md) - -## RumPublicApi.clearAccount property - -Clear all account information - -**Signature:** - -```typescript -clearAccount: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md deleted file mode 100644 index 7e9d8beae8..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getaccount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getAccount](./browser-rum-core.rumpublicapi.getaccount.md) - -## RumPublicApi.getAccount property - -Get account information - -**Signature:** - -```typescript -getAccount: () => Context; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md deleted file mode 100644 index 15c3fd2db1..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinitconfiguration.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getInitConfiguration](./browser-rum-core.rumpublicapi.getinitconfiguration.md) - -## RumPublicApi.getInitConfiguration property - -Get the init configuration - -**Signature:** - -```typescript -getInitConfiguration: () => RumInitConfiguration | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md deleted file mode 100644 index d9bc7fe5bb..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getinternalcontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getInternalContext](./browser-rum-core.rumpublicapi.getinternalcontext.md) - -## RumPublicApi.getInternalContext property - -\[Internal API\] Get the internal SDK context - -**Signature:** - -```typescript -getInternalContext: (startTime?: number) => InternalContext | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md deleted file mode 100644 index 7ef7e6ed96..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getviewcontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getViewContext](./browser-rum-core.rumpublicapi.getviewcontext.md) - -## RumPublicApi.getViewContext property - -Get View Context. - -**Signature:** - -```typescript -getViewContext: () => Context; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md deleted file mode 100644 index b46b91d029..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.init.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [init](./browser-rum-core.rumpublicapi.init.md) - -## RumPublicApi.init property - -Init the RUM browser SDK. - -**Signature:** - -```typescript -init: (initConfiguration: RumInitConfiguration) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md deleted file mode 100644 index 1e72715131..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeaccountproperty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeAccountProperty](./browser-rum-core.rumpublicapi.removeaccountproperty.md) - -## RumPublicApi.removeAccountProperty property - -Remove an account property - -**Signature:** - -```typescript -removeAccountProperty: (key: string) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md deleted file mode 100644 index f463c57dec..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setAccount](./browser-rum-core.rumpublicapi.setaccount.md) - -## RumPublicApi.setAccount property - -Set account information to all events, stored in `@account` - -**Signature:** - -```typescript -setAccount: (newAccount: Account) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md deleted file mode 100644 index db6da70569..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setaccountproperty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setAccountProperty](./browser-rum-core.rumpublicapi.setaccountproperty.md) - -## RumPublicApi.setAccountProperty property - -Set or update the account property, stored in `@account.` - -**Signature:** - -```typescript -setAccountProperty: (key: string, property: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md deleted file mode 100644 index 9e3af8164a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setGlobalContext](./browser-rum-core.rumpublicapi.setglobalcontext.md) - -## RumPublicApi.setGlobalContext property - -Set the global context information to all events, stored in `@context` - -**Signature:** - -```typescript -setGlobalContext: (context: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md deleted file mode 100644 index d20aa6172d..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setglobalcontextproperty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setGlobalContextProperty](./browser-rum-core.rumpublicapi.setglobalcontextproperty.md) - -## RumPublicApi.setGlobalContextProperty property - -Set or update a global context property, stored in `@context.` - -**Signature:** - -```typescript -setGlobalContextProperty: (key: any, value: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md deleted file mode 100644 index 2f3e1eb1e7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.settrackingconsent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setTrackingConsent](./browser-rum-core.rumpublicapi.settrackingconsent.md) - -## RumPublicApi.setTrackingConsent property - -Set the tracking consent of the current user. - -**Signature:** - -```typescript -setTrackingConsent: (trackingConsent: TrackingConsent) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md deleted file mode 100644 index a264114577..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuserproperty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUserProperty](./browser-rum-core.rumpublicapi.setuserproperty.md) - -## RumPublicApi.setUserProperty property - -Set or update the user property, stored in `@usr.` - -**Signature:** - -```typescript -setUserProperty: (key: any, property: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md deleted file mode 100644 index 16bf10583f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontext.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewContext](./browser-rum-core.rumpublicapi.setviewcontext.md) - -## RumPublicApi.setViewContext property - -Set View Context. - -Enable to manually set the context of the current view. - -**Signature:** - -```typescript -setViewContext: (context: Context) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md deleted file mode 100644 index a56ff6bdf3..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewcontextproperty.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewContextProperty](./browser-rum-core.rumpublicapi.setviewcontextproperty.md) - -## RumPublicApi.setViewContextProperty property - -Set View Context Property. - -Enable to manually set a property of the context of the current view. - -**Signature:** - -```typescript -setViewContextProperty: (key: string, value: any) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md deleted file mode 100644 index e15dff70be..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setviewname.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setViewName](./browser-rum-core.rumpublicapi.setviewname.md) - -## RumPublicApi.setViewName property - -Set View Name. - -Enable to manually change the name of the current view. - -**Signature:** - -```typescript -setViewName: (name: string) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md b/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md deleted file mode 100644 index eab79179bb..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsession.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopSession](./browser-rum-core.rumpublicapi.stopsession.md) - -## RumPublicApi.stopSession property - -Stop the session. A new session will start at the next user interaction with the page. - -**Signature:** - -```typescript -stopSession: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsession.md b/docs/api-reference/rum/browser-rum-core.rumsession.md deleted file mode 100644 index 74683739e9..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsession.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSession](./browser-rum-core.rumsession.md) - -## RumSession type - -**Signature:** - -```typescript -export type RumSession = { - id: string; - sessionReplay: SessionReplayState; - anonymousId?: string; -}; -``` -**References:** [SessionReplayState](./browser-rum-core.sessionreplaystate.md) - diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md deleted file mode 100644 index 9b53fe5db7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expire.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [expire](./browser-rum-core.rumsessionmanager.expire.md) - -## RumSessionManager.expire property - -**Signature:** - -```typescript -expire: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md deleted file mode 100644 index e1ab0e3b46..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.expireobservable.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [expireObservable](./browser-rum-core.rumsessionmanager.expireobservable.md) - -## RumSessionManager.expireObservable property - -**Signature:** - -```typescript -expireObservable: Observable; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md deleted file mode 100644 index f2c6d12db4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.findtrackedsession.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [findTrackedSession](./browser-rum-core.rumsessionmanager.findtrackedsession.md) - -## RumSessionManager.findTrackedSession property - -**Signature:** - -```typescript -findTrackedSession: (startTime?: RelativeTime) => RumSession | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md deleted file mode 100644 index f5c62131a9..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.md +++ /dev/null @@ -1,104 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) - -## RumSessionManager interface - -**Signature:** - -```typescript -export interface RumSessionManager -``` - -## Properties - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[expire](./browser-rum-core.rumsessionmanager.expire.md) - - - - - - - -() => void - - - - - -
- -[expireObservable](./browser-rum-core.rumsessionmanager.expireobservable.md) - - - - - - - -Observable<void> - - - - - -
- -[findTrackedSession](./browser-rum-core.rumsessionmanager.findtrackedsession.md) - - - - - - - -(startTime?: RelativeTime) => [RumSession](./browser-rum-core.rumsession.md) \| undefined - - - - - -
- -[setForcedReplay](./browser-rum-core.rumsessionmanager.setforcedreplay.md) - - - - - - - -() => void - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md b/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md deleted file mode 100644 index e0a257b648..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumsessionmanager.setforcedreplay.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumSessionManager](./browser-rum-core.rumsessionmanager.md) > [setForcedReplay](./browser-rum-core.rumsessionmanager.setforcedreplay.md) - -## RumSessionManager.setForcedReplay property - -**Signature:** - -```typescript -setForcedReplay: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md b/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md deleted file mode 100644 index 1f072ad8da..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.location.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) > [location](./browser-rum-core.rumvieweventdomaincontext.location.md) - -## RumViewEventDomainContext.location property - -**Signature:** - -```typescript -location: Readonly; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md deleted file mode 100644 index 50fc15352c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [handlingStack](./browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md) - -## RumXhrResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md deleted file mode 100644 index 3df4817c78..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [isAborted](./browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md) - -## RumXhrResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md deleted file mode 100644 index addf41c78c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [performanceEntry](./browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md) - -## RumXhrResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md b/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md deleted file mode 100644 index a6efc70dd7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) > [xhr](./browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md) - -## RumXhrResourceEventDomainContext.xhr property - -**Signature:** - -```typescript -xhr: XMLHttpRequest; -``` diff --git a/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md b/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md deleted file mode 100644 index ddd7896f4a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.sanitizedataurl.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [sanitizeDataUrl](./browser-rum-core.sanitizedataurl.md) - -## sanitizeDataUrl() function - -**Signature:** - -```typescript -export declare function sanitizeDataUrl(url: string): string; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - - -
-**Returns:** - -string - diff --git a/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md b/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md deleted file mode 100644 index e547ebb84a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.sessionreplaystate.md +++ /dev/null @@ -1,73 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [SessionReplayState](./browser-rum-core.sessionreplaystate.md) - -## SessionReplayState enum - -**Signature:** - -```typescript -export declare const enum SessionReplayState -``` - -## Enumeration Members - - - - - -
- -Member - - - - -Value - - - - -Description - - -
- -FORCED - - - - -`2` - - - - - -
- -OFF - - - - -`0` - - - - - -
- -SAMPLED - - - - -`1` - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md b/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md deleted file mode 100644 index 821eb502d8..0000000000 --- a/docs/api-reference/rum/browser-rum-core.shouldignoreelement.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [shouldIgnoreElement](./browser-rum-core.shouldignoreelement.md) - -## shouldIgnoreElement() function - -TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag. - -**Signature:** - -```typescript -export declare function shouldIgnoreElement(element: Element): boolean; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -element - - - - -Element - - - - - -
-**Returns:** - -boolean - diff --git a/docs/api-reference/rum/browser-rum-core.shouldmasknode.md b/docs/api-reference/rum/browser-rum-core.shouldmasknode.md deleted file mode 100644 index 79a7994f5d..0000000000 --- a/docs/api-reference/rum/browser-rum-core.shouldmasknode.md +++ /dev/null @@ -1,71 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [shouldMaskNode](./browser-rum-core.shouldmasknode.md) - -## shouldMaskNode() function - -Helper aiming to unify `mask` and `mask-user-input` privacy levels: - -In the `mask` case, it is trivial: we should mask the element. - -In the `mask-user-input` case, we should mask the element only if it is a "form" element or the direct parent is a form element for text nodes). - -Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized). - -**Signature:** - -```typescript -export declare function shouldMaskNode(node: Node, privacyLevel: NodePrivacyLevel): boolean; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -node - - - - -Node - - - - - -
- -privacyLevel - - - - -[NodePrivacyLevel](./browser-rum-core.nodeprivacylevel.md) - - - - - -
-**Returns:** - -boolean - diff --git a/docs/api-reference/rum/browser-rum-core.stable_attributes.md b/docs/api-reference/rum/browser-rum-core.stable_attributes.md deleted file mode 100644 index 5380a11f09..0000000000 --- a/docs/api-reference/rum/browser-rum-core.stable_attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [STABLE\_ATTRIBUTES](./browser-rum-core.stable_attributes.md) - -## STABLE\_ATTRIBUTES variable - -Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document. - -**Signature:** - -```typescript -STABLE_ATTRIBUTES: string[] -``` diff --git a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md deleted file mode 100644 index a8e8056406..0000000000 --- a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.force.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) > [force](./browser-rum-core.startrecordingoptions.force.md) - -## StartRecordingOptions.force property - -**Signature:** - -```typescript -force: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md b/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md deleted file mode 100644 index 0d41cdf510..0000000000 --- a/docs/api-reference/rum/browser-rum-core.startrecordingoptions.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md) - -## StartRecordingOptions interface - -**Signature:** - -```typescript -export interface StartRecordingOptions -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[force](./browser-rum-core.startrecordingoptions.force.md) - - - - - - - -boolean - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.startrum.md b/docs/api-reference/rum/browser-rum-core.startrum.md deleted file mode 100644 index f4718de728..0000000000 --- a/docs/api-reference/rum/browser-rum-core.startrum.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [StartRum](./browser-rum-core.startrum.md) - -## StartRum type - -**Signature:** - -```typescript -export type StartRum = typeof startRum; -``` diff --git a/docs/api-reference/rum/browser-rum-core.startviewhistory.md b/docs/api-reference/rum/browser-rum-core.startviewhistory.md deleted file mode 100644 index f938a1d7c0..0000000000 --- a/docs/api-reference/rum/browser-rum-core.startviewhistory.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [startViewHistory](./browser-rum-core.startviewhistory.md) - -## startViewHistory() function - -**Signature:** - -```typescript -export declare function startViewHistory(lifeCycle: LifeCycle): ViewHistory; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -lifeCycle - - - - -[LifeCycle](./browser-rum-core.lifecycle.md) - - - - - -
-**Returns:** - -[ViewHistory](./browser-rum-core.viewhistory.md) - diff --git a/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md deleted file mode 100644 index 82e7c4262c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.accountcontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [accountContext](./browser-rum-core.strategy.accountcontext.md) - -## Strategy.accountContext property - -**Signature:** - -```typescript -accountContext: ContextManager; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addaction.md b/docs/api-reference/rum/browser-rum-core.strategy.addaction.md deleted file mode 100644 index 0b0e5cae3c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.addaction.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addAction](./browser-rum-core.strategy.addaction.md) - -## Strategy.addAction property - -**Signature:** - -```typescript -addAction: StartRumResult['addAction']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md deleted file mode 100644 index 492ae4c22e..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.adddurationvital.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addDurationVital](./browser-rum-core.strategy.adddurationvital.md) - -## Strategy.addDurationVital property - -**Signature:** - -```typescript -addDurationVital: StartRumResult['addDurationVital']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.adderror.md b/docs/api-reference/rum/browser-rum-core.strategy.adderror.md deleted file mode 100644 index 19d42b97fe..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.adderror.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addError](./browser-rum-core.strategy.adderror.md) - -## Strategy.addError property - -**Signature:** - -```typescript -addError: StartRumResult['addError']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md b/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md deleted file mode 100644 index 8d573526a3..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.addfeatureflagevaluation.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addFeatureFlagEvaluation](./browser-rum-core.strategy.addfeatureflagevaluation.md) - -## Strategy.addFeatureFlagEvaluation property - -**Signature:** - -```typescript -addFeatureFlagEvaluation: StartRumResult['addFeatureFlagEvaluation']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md b/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md deleted file mode 100644 index 045f535c99..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.addtiming.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [addTiming](./browser-rum-core.strategy.addtiming.md) - -## Strategy.addTiming property - -**Signature:** - -```typescript -addTiming: StartRumResult['addTiming']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md deleted file mode 100644 index 1b92853fa7..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.getinternalcontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [getInternalContext](./browser-rum-core.strategy.getinternalcontext.md) - -## Strategy.getInternalContext property - -**Signature:** - -```typescript -getInternalContext: StartRumResult['getInternalContext']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md deleted file mode 100644 index 9b7a783f1f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.getviewcontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [getViewContext](./browser-rum-core.strategy.getviewcontext.md) - -## Strategy.getViewContext property - -**Signature:** - -```typescript -getViewContext: StartRumResult['getViewContext']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md deleted file mode 100644 index 3a8adf6d6f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.globalcontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [globalContext](./browser-rum-core.strategy.globalcontext.md) - -## Strategy.globalContext property - -**Signature:** - -```typescript -globalContext: ContextManager; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.init.md b/docs/api-reference/rum/browser-rum-core.strategy.init.md deleted file mode 100644 index 64ef69ae2b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.init.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [init](./browser-rum-core.strategy.init.md) - -## Strategy.init property - -**Signature:** - -```typescript -init: (initConfiguration: RumInitConfiguration, publicApi: RumPublicApi) => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md b/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md deleted file mode 100644 index e945f0e18f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.initconfiguration.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [initConfiguration](./browser-rum-core.strategy.initconfiguration.md) - -## Strategy.initConfiguration property - -**Signature:** - -```typescript -initConfiguration: RumInitConfiguration | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.md b/docs/api-reference/rum/browser-rum-core.strategy.md deleted file mode 100644 index 2e6d935159..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.md +++ /dev/null @@ -1,359 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) - -## Strategy interface - -**Signature:** - -```typescript -export interface Strategy -``` - -## Properties - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[accountContext](./browser-rum-core.strategy.accountcontext.md) - - - - - - - -ContextManager - - - - - -
- -[addAction](./browser-rum-core.strategy.addaction.md) - - - - - - - -StartRumResult\['addAction'\] - - - - - -
- -[addDurationVital](./browser-rum-core.strategy.adddurationvital.md) - - - - - - - -StartRumResult\['addDurationVital'\] - - - - - -
- -[addError](./browser-rum-core.strategy.adderror.md) - - - - - - - -StartRumResult\['addError'\] - - - - - -
- -[addFeatureFlagEvaluation](./browser-rum-core.strategy.addfeatureflagevaluation.md) - - - - - - - -StartRumResult\['addFeatureFlagEvaluation'\] - - - - - -
- -[addTiming](./browser-rum-core.strategy.addtiming.md) - - - - - - - -StartRumResult\['addTiming'\] - - - - - -
- -[getInternalContext](./browser-rum-core.strategy.getinternalcontext.md) - - - - - - - -StartRumResult\['getInternalContext'\] - - - - - -
- -[getViewContext](./browser-rum-core.strategy.getviewcontext.md) - - - - - - - -StartRumResult\['getViewContext'\] - - - - - -
- -[globalContext](./browser-rum-core.strategy.globalcontext.md) - - - - - - - -ContextManager - - - - - -
- -[init](./browser-rum-core.strategy.init.md) - - - - - - - -(initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md), publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md)) => void - - - - - -
- -[initConfiguration](./browser-rum-core.strategy.initconfiguration.md) - - - - - - - -[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) \| undefined - - - - - -
- -[setViewContext](./browser-rum-core.strategy.setviewcontext.md) - - - - - - - -StartRumResult\['setViewContext'\] - - - - - -
- -[setViewContextProperty](./browser-rum-core.strategy.setviewcontextproperty.md) - - - - - - - -StartRumResult\['setViewContextProperty'\] - - - - - -
- -[setViewName](./browser-rum-core.strategy.setviewname.md) - - - - - - - -StartRumResult\['setViewName'\] - - - - - -
- -[startDurationVital](./browser-rum-core.strategy.startdurationvital.md) - - - - - - - -StartRumResult\['startDurationVital'\] - - - - - -
- -[startView](./browser-rum-core.strategy.startview.md) - - - - - - - -StartRumResult\['startView'\] - - - - - -
- -[stopDurationVital](./browser-rum-core.strategy.stopdurationvital.md) - - - - - - - -StartRumResult\['stopDurationVital'\] - - - - - -
- -[stopSession](./browser-rum-core.strategy.stopsession.md) - - - - - - - -StartRumResult\['stopSession'\] - - - - - -
- -[userContext](./browser-rum-core.strategy.usercontext.md) - - - - - - - -ContextManager - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md deleted file mode 100644 index 3389137449..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewContext](./browser-rum-core.strategy.setviewcontext.md) - -## Strategy.setViewContext property - -**Signature:** - -```typescript -setViewContext: StartRumResult['setViewContext']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md deleted file mode 100644 index 3a01f4be68..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.setviewcontextproperty.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewContextProperty](./browser-rum-core.strategy.setviewcontextproperty.md) - -## Strategy.setViewContextProperty property - -**Signature:** - -```typescript -setViewContextProperty: StartRumResult['setViewContextProperty']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md b/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md deleted file mode 100644 index ea91e72cbb..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.setviewname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [setViewName](./browser-rum-core.strategy.setviewname.md) - -## Strategy.setViewName property - -**Signature:** - -```typescript -setViewName: StartRumResult['setViewName']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md deleted file mode 100644 index ab5c6f8082..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.startdurationvital.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [startDurationVital](./browser-rum-core.strategy.startdurationvital.md) - -## Strategy.startDurationVital property - -**Signature:** - -```typescript -startDurationVital: StartRumResult['startDurationVital']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.startview.md b/docs/api-reference/rum/browser-rum-core.strategy.startview.md deleted file mode 100644 index f329810f4f..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.startview.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [startView](./browser-rum-core.strategy.startview.md) - -## Strategy.startView property - -**Signature:** - -```typescript -startView: StartRumResult['startView']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md b/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md deleted file mode 100644 index 505f52321b..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.stopdurationvital.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [stopDurationVital](./browser-rum-core.strategy.stopdurationvital.md) - -## Strategy.stopDurationVital property - -**Signature:** - -```typescript -stopDurationVital: StartRumResult['stopDurationVital']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md b/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md deleted file mode 100644 index 4f82c6e902..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.stopsession.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [stopSession](./browser-rum-core.strategy.stopsession.md) - -## Strategy.stopSession property - -**Signature:** - -```typescript -stopSession: StartRumResult['stopSession']; -``` diff --git a/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md b/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md deleted file mode 100644 index 2cfbd23e99..0000000000 --- a/docs/api-reference/rum/browser-rum-core.strategy.usercontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [Strategy](./browser-rum-core.strategy.md) > [userContext](./browser-rum-core.strategy.usercontext.md) - -## Strategy.userContext property - -**Signature:** - -```typescript -userContext: ContextManager; -``` diff --git a/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md b/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md deleted file mode 100644 index ff8427479d..0000000000 --- a/docs/api-reference/rum/browser-rum-core.supportperformancetimingevent.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [supportPerformanceTimingEvent](./browser-rum-core.supportperformancetimingevent.md) - -## supportPerformanceTimingEvent() function - -**Signature:** - -```typescript -export declare function supportPerformanceTimingEvent(entryType: RumPerformanceEntryType): boolean; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -entryType - - - - -[RumPerformanceEntryType](./browser-rum-core.rumperformanceentrytype.md) - - - - - -
-**Returns:** - -boolean - diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md deleted file mode 100644 index dc979dfa8d..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.context.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [context](./browser-rum-core.viewcreatedevent.context.md) - -## ViewCreatedEvent.context property - -**Signature:** - -```typescript -context?: Context; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md deleted file mode 100644 index 9737ab71ae..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [id](./browser-rum-core.viewcreatedevent.id.md) - -## ViewCreatedEvent.id property - -**Signature:** - -```typescript -id: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md deleted file mode 100644 index 6f6406f8ba..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.md +++ /dev/null @@ -1,146 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) - -## ViewCreatedEvent interface - -**Signature:** - -```typescript -export interface ViewCreatedEvent -``` - -## Properties - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[context?](./browser-rum-core.viewcreatedevent.context.md) - - - - - - - -Context - - - - -_(Optional)_ - - -
- -[id](./browser-rum-core.viewcreatedevent.id.md) - - - - - - - -string - - - - - -
- -[name?](./browser-rum-core.viewcreatedevent.name.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[service?](./browser-rum-core.viewcreatedevent.service.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[startClocks](./browser-rum-core.viewcreatedevent.startclocks.md) - - - - - - - -ClocksState - - - - - -
- -[version?](./browser-rum-core.viewcreatedevent.version.md) - - - - - - - -string - - - - -_(Optional)_ - - -
diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md deleted file mode 100644 index 68d639f5c9..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [name](./browser-rum-core.viewcreatedevent.name.md) - -## ViewCreatedEvent.name property - -**Signature:** - -```typescript -name?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md deleted file mode 100644 index 7e02fb7711..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.service.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [service](./browser-rum-core.viewcreatedevent.service.md) - -## ViewCreatedEvent.service property - -**Signature:** - -```typescript -service?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md deleted file mode 100644 index 13a362c85e..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.startclocks.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [startClocks](./browser-rum-core.viewcreatedevent.startclocks.md) - -## ViewCreatedEvent.startClocks property - -**Signature:** - -```typescript -startClocks: ClocksState; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md b/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md deleted file mode 100644 index 04918af655..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewcreatedevent.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewCreatedEvent](./browser-rum-core.viewcreatedevent.md) > [version](./browser-rum-core.viewcreatedevent.version.md) - -## ViewCreatedEvent.version property - -**Signature:** - -```typescript -version?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md b/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md deleted file mode 100644 index 304bc8077e..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistory.findview.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) > [findView](./browser-rum-core.viewhistory.findview.md) - -## ViewHistory.findView property - -**Signature:** - -```typescript -findView: (startTime?: RelativeTime) => ViewHistoryEntry | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.md b/docs/api-reference/rum/browser-rum-core.viewhistory.md deleted file mode 100644 index a9235c67b4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistory.md +++ /dev/null @@ -1,70 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) - -## ViewHistory interface - -**Signature:** - -```typescript -export interface ViewHistory -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[findView](./browser-rum-core.viewhistory.findview.md) - - - - - - - -(startTime?: RelativeTime) => [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) \| undefined - - - - - -
- -[stop](./browser-rum-core.viewhistory.stop.md) - - - - - - - -() => void - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md b/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md deleted file mode 100644 index 4ea644985e..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistory.stop.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistory](./browser-rum-core.viewhistory.md) > [stop](./browser-rum-core.viewhistory.stop.md) - -## ViewHistory.stop property - -**Signature:** - -```typescript -stop: () => void; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md deleted file mode 100644 index 3497d94212..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.context.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [context](./browser-rum-core.viewhistoryentry.context.md) - -## ViewHistoryEntry.context property - -**Signature:** - -```typescript -context?: Context | undefined; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md deleted file mode 100644 index 819a21a1c4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [id](./browser-rum-core.viewhistoryentry.id.md) - -## ViewHistoryEntry.id property - -**Signature:** - -```typescript -id: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md deleted file mode 100644 index 03096486d4..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.md +++ /dev/null @@ -1,165 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) - -## ViewHistoryEntry interface - -**Signature:** - -```typescript -export interface ViewHistoryEntry -``` - -## Properties - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[context?](./browser-rum-core.viewhistoryentry.context.md) - - - - - - - -Context \| undefined - - - - -_(Optional)_ - - -
- -[id](./browser-rum-core.viewhistoryentry.id.md) - - - - - - - -string - - - - - -
- -[name?](./browser-rum-core.viewhistoryentry.name.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[service?](./browser-rum-core.viewhistoryentry.service.md) - - - - - - - -string - - - - -_(Optional)_ - - -
- -[sessionIsActive?](./browser-rum-core.viewhistoryentry.sessionisactive.md) - - - - - - - -boolean - - - - -_(Optional)_ - - -
- -[startClocks](./browser-rum-core.viewhistoryentry.startclocks.md) - - - - - - - -ClocksState - - - - - -
- -[version?](./browser-rum-core.viewhistoryentry.version.md) - - - - - - - -string - - - - -_(Optional)_ - - -
diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md deleted file mode 100644 index 51383e7822..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [name](./browser-rum-core.viewhistoryentry.name.md) - -## ViewHistoryEntry.name property - -**Signature:** - -```typescript -name?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md deleted file mode 100644 index d82cefc957..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.service.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [service](./browser-rum-core.viewhistoryentry.service.md) - -## ViewHistoryEntry.service property - -**Signature:** - -```typescript -service?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md deleted file mode 100644 index 78e1eb8a3a..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.sessionisactive.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [sessionIsActive](./browser-rum-core.viewhistoryentry.sessionisactive.md) - -## ViewHistoryEntry.sessionIsActive property - -**Signature:** - -```typescript -sessionIsActive?: boolean; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md deleted file mode 100644 index ed3cc8f7cd..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.startclocks.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [startClocks](./browser-rum-core.viewhistoryentry.startclocks.md) - -## ViewHistoryEntry.startClocks property - -**Signature:** - -```typescript -startClocks: ClocksState; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md b/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md deleted file mode 100644 index 2b0a1788e9..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewhistoryentry.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewHistoryEntry](./browser-rum-core.viewhistoryentry.md) > [version](./browser-rum-core.viewhistoryentry.version.md) - -## ViewHistoryEntry.version property - -**Signature:** - -```typescript -version?: string; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md deleted file mode 100644 index c7ca8f26c5..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewportdimension.height.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) > [height](./browser-rum-core.viewportdimension.height.md) - -## ViewportDimension.height property - -**Signature:** - -```typescript -height: number; -``` diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.md deleted file mode 100644 index 143b84e7c2..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewportdimension.md +++ /dev/null @@ -1,70 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) - -## ViewportDimension interface - -**Signature:** - -```typescript -export interface ViewportDimension -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[height](./browser-rum-core.viewportdimension.height.md) - - - - - - - -number - - - - - -
- -[width](./browser-rum-core.viewportdimension.width.md) - - - - - - - -number - - - - - -
diff --git a/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md b/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md deleted file mode 100644 index 961607556c..0000000000 --- a/docs/api-reference/rum/browser-rum-core.viewportdimension.width.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [ViewportDimension](./browser-rum-core.viewportdimension.md) > [width](./browser-rum-core.viewportdimension.width.md) - -## ViewportDimension.width property - -**Signature:** - -```typescript -width: number; -``` diff --git a/docs/api-reference/rum/browser-rum-react.reactplugin.md b/docs/api-reference/rum/browser-rum-react.reactplugin.md index 112b74f5e1..14abf1f0ec 100644 --- a/docs/api-reference/rum/browser-rum-react.reactplugin.md +++ b/docs/api-reference/rum/browser-rum-react.reactplugin.md @@ -59,5 +59,5 @@ _(Optional)_ **Returns:** -{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").[RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md); publicApi: [RumPublicApi](./browser-rum-core.rumpublicapi.md); }): void; onRumStart({ strategy }: { strategy: [Strategy](./browser-rum-core.strategy.md); }): void; getConfigurationTelemetry(): { router: boolean; }; } +{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties._dd.md b/docs/api-reference/rum/browser-rum.commonproperties._dd.md similarity index 77% rename from docs/api-reference/rum/browser-rum-core.commonproperties._dd.md rename to docs/api-reference/rum/browser-rum.commonproperties._dd.md index db25b545fc..6b578e5e1d 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties._dd.md +++ b/docs/api-reference/rum/browser-rum.commonproperties._dd.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [\_dd](./browser-rum-core.commonproperties._dd.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [\_dd](./browser-rum.commonproperties._dd.md) ## CommonProperties.\_dd property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.account.md b/docs/api-reference/rum/browser-rum.commonproperties.account.md similarity index 57% rename from docs/api-reference/rum/browser-rum-core.commonproperties.account.md rename to docs/api-reference/rum/browser-rum.commonproperties.account.md index ddc8c60fa7..75f5f1fa6b 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.account.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.account.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [account](./browser-rum-core.commonproperties.account.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [account](./browser-rum.commonproperties.account.md) ## CommonProperties.account property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.application.md b/docs/api-reference/rum/browser-rum.commonproperties.application.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.commonproperties.application.md rename to docs/api-reference/rum/browser-rum.commonproperties.application.md index 92bb87c321..8bfcccd067 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.application.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.application.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [application](./browser-rum-core.commonproperties.application.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [application](./browser-rum.commonproperties.application.md) ## CommonProperties.application property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md b/docs/api-reference/rum/browser-rum.commonproperties.build_id.md similarity index 62% rename from docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md rename to docs/api-reference/rum/browser-rum.commonproperties.build_id.md index 3e205fc861..25eaae7531 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.build_id.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.build_id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [build\_id](./browser-rum-core.commonproperties.build_id.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [build\_id](./browser-rum.commonproperties.build_id.md) ## CommonProperties.build\_id property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md b/docs/api-reference/rum/browser-rum.commonproperties.build_version.md similarity index 50% rename from docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md rename to docs/api-reference/rum/browser-rum.commonproperties.build_version.md index 5a88e2289a..9e7f2b9168 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.build_version.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.build_version.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [build\_version](./browser-rum-core.commonproperties.build_version.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [build\_version](./browser-rum.commonproperties.build_version.md) ## CommonProperties.build\_version property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md b/docs/api-reference/rum/browser-rum.commonproperties.ci_test.md similarity index 56% rename from docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md rename to docs/api-reference/rum/browser-rum.commonproperties.ci_test.md index 634db42391..2163f5003b 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.ci_test.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.ci_test.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [ci\_test](./browser-rum-core.commonproperties.ci_test.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [ci\_test](./browser-rum.commonproperties.ci_test.md) ## CommonProperties.ci\_test property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md b/docs/api-reference/rum/browser-rum.commonproperties.connectivity.md similarity index 74% rename from docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md rename to docs/api-reference/rum/browser-rum.commonproperties.connectivity.md index 2a631c1683..4151bfb45a 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.connectivity.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.connectivity.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [connectivity](./browser-rum-core.commonproperties.connectivity.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [connectivity](./browser-rum.commonproperties.connectivity.md) ## CommonProperties.connectivity property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.context.md b/docs/api-reference/rum/browser-rum.commonproperties.context.md similarity index 51% rename from docs/api-reference/rum/browser-rum-core.commonproperties.context.md rename to docs/api-reference/rum/browser-rum.commonproperties.context.md index 770e808832..cb7e686953 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.context.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [context](./browser-rum-core.commonproperties.context.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [context](./browser-rum.commonproperties.context.md) ## CommonProperties.context property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.date.md b/docs/api-reference/rum/browser-rum.commonproperties.date.md similarity index 50% rename from docs/api-reference/rum/browser-rum-core.commonproperties.date.md rename to docs/api-reference/rum/browser-rum.commonproperties.date.md index f5aebf2540..ec436b6f5b 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.date.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.date.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [date](./browser-rum-core.commonproperties.date.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [date](./browser-rum.commonproperties.date.md) ## CommonProperties.date property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.device.md b/docs/api-reference/rum/browser-rum.commonproperties.device.md similarity index 67% rename from docs/api-reference/rum/browser-rum-core.commonproperties.device.md rename to docs/api-reference/rum/browser-rum.commonproperties.device.md index 27f04acb3c..541c71ad3e 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.device.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.device.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [device](./browser-rum-core.commonproperties.device.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [device](./browser-rum.commonproperties.device.md) ## CommonProperties.device property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.display.md b/docs/api-reference/rum/browser-rum.commonproperties.display.md similarity index 62% rename from docs/api-reference/rum/browser-rum-core.commonproperties.display.md rename to docs/api-reference/rum/browser-rum.commonproperties.display.md index 9a319fe7b0..8e002da646 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.display.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.display.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [display](./browser-rum-core.commonproperties.display.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [display](./browser-rum.commonproperties.display.md) ## CommonProperties.display property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.md b/docs/api-reference/rum/browser-rum.commonproperties.md similarity index 73% rename from docs/api-reference/rum/browser-rum-core.commonproperties.md rename to docs/api-reference/rum/browser-rum.commonproperties.md index acd5e5aea2..61dd5d3c19 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) ## CommonProperties interface @@ -37,7 +37,7 @@ Description -[\_dd](./browser-rum-core.commonproperties._dd.md) +[\_dd](./browser-rum.commonproperties._dd.md) @@ -58,7 +58,7 @@ Internal properties -[account?](./browser-rum-core.commonproperties.account.md) +[account?](./browser-rum.commonproperties.account.md) @@ -79,7 +79,7 @@ _(Optional)_ Account properties -[application](./browser-rum-core.commonproperties.application.md) +[application](./browser-rum.commonproperties.application.md) @@ -100,7 +100,7 @@ Application properties -[build\_id?](./browser-rum-core.commonproperties.build_id.md) +[build\_id?](./browser-rum.commonproperties.build_id.md) @@ -121,7 +121,7 @@ _(Optional)_ Generated unique ID of the application build. Unlike version or bui -[build\_version?](./browser-rum-core.commonproperties.build_version.md) +[build\_version?](./browser-rum.commonproperties.build_version.md) @@ -142,7 +142,7 @@ _(Optional)_ The build version for this application -[ci\_test?](./browser-rum-core.commonproperties.ci_test.md) +[ci\_test?](./browser-rum.commonproperties.ci_test.md) @@ -163,7 +163,7 @@ _(Optional)_ CI Visibility properties -[connectivity?](./browser-rum-core.commonproperties.connectivity.md) +[connectivity?](./browser-rum.commonproperties.connectivity.md) @@ -182,7 +182,7 @@ _(Optional)_ Device connectivity properties -[context?](./browser-rum-core.commonproperties.context.md) +[context?](./browser-rum.commonproperties.context.md) @@ -201,7 +201,7 @@ _(Optional)_ User provided context -[date](./browser-rum-core.commonproperties.date.md) +[date](./browser-rum.commonproperties.date.md) @@ -222,7 +222,7 @@ Start of the event in ms from epoch -[device?](./browser-rum-core.commonproperties.device.md) +[device?](./browser-rum.commonproperties.device.md) @@ -241,7 +241,7 @@ _(Optional)_ Device properties -[display?](./browser-rum-core.commonproperties.display.md) +[display?](./browser-rum.commonproperties.display.md) @@ -260,7 +260,7 @@ _(Optional)_ Display properties -[os?](./browser-rum-core.commonproperties.os.md) +[os?](./browser-rum.commonproperties.os.md) @@ -279,7 +279,7 @@ _(Optional)_ Operating system properties -[service?](./browser-rum-core.commonproperties.service.md) +[service?](./browser-rum.commonproperties.service.md) @@ -298,7 +298,7 @@ _(Optional)_ The service name for this application -[session](./browser-rum-core.commonproperties.session.md) +[session](./browser-rum.commonproperties.session.md) @@ -319,7 +319,7 @@ Session properties -[source?](./browser-rum-core.commonproperties.source.md) +[source?](./browser-rum.commonproperties.source.md) @@ -340,7 +340,7 @@ _(Optional)_ The source of this event -[synthetics?](./browser-rum-core.commonproperties.synthetics.md) +[synthetics?](./browser-rum.commonproperties.synthetics.md) @@ -361,7 +361,7 @@ _(Optional)_ Synthetics properties -[usr?](./browser-rum-core.commonproperties.usr.md) +[usr?](./browser-rum.commonproperties.usr.md) @@ -382,7 +382,7 @@ _(Optional)_ User properties -[version?](./browser-rum-core.commonproperties.version.md) +[version?](./browser-rum.commonproperties.version.md) @@ -401,7 +401,7 @@ _(Optional)_ The version for this application -[view](./browser-rum-core.commonproperties.view.md) +[view](./browser-rum.commonproperties.view.md) diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.os.md b/docs/api-reference/rum/browser-rum.commonproperties.os.md similarity index 63% rename from docs/api-reference/rum/browser-rum-core.commonproperties.os.md rename to docs/api-reference/rum/browser-rum.commonproperties.os.md index 23631540c9..de823a4dec 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.os.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.os.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [os](./browser-rum-core.commonproperties.os.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [os](./browser-rum.commonproperties.os.md) ## CommonProperties.os property diff --git a/docs/api-reference/rum/browser-rum.commonproperties.service.md b/docs/api-reference/rum/browser-rum.commonproperties.service.md new file mode 100644 index 0000000000..d1a723a885 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.commonproperties.service.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [service](./browser-rum.commonproperties.service.md) + +## CommonProperties.service property + +The service name for this application + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.session.md b/docs/api-reference/rum/browser-rum.commonproperties.session.md similarity index 61% rename from docs/api-reference/rum/browser-rum-core.commonproperties.session.md rename to docs/api-reference/rum/browser-rum.commonproperties.session.md index 4a3a9ed3b3..44231dbf19 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.session.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.session.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [session](./browser-rum-core.commonproperties.session.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [session](./browser-rum.commonproperties.session.md) ## CommonProperties.session property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.source.md b/docs/api-reference/rum/browser-rum.commonproperties.source.md similarity index 58% rename from docs/api-reference/rum/browser-rum-core.commonproperties.source.md rename to docs/api-reference/rum/browser-rum.commonproperties.source.md index a4615148d5..b7b95961a8 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.source.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.source.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [source](./browser-rum-core.commonproperties.source.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [source](./browser-rum.commonproperties.source.md) ## CommonProperties.source property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md b/docs/api-reference/rum/browser-rum.commonproperties.synthetics.md similarity index 60% rename from docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md rename to docs/api-reference/rum/browser-rum.commonproperties.synthetics.md index 42c396f1d6..7bafd41fed 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.synthetics.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.synthetics.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [synthetics](./browser-rum-core.commonproperties.synthetics.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [synthetics](./browser-rum.commonproperties.synthetics.md) ## CommonProperties.synthetics property diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.usr.md b/docs/api-reference/rum/browser-rum.commonproperties.usr.md similarity index 62% rename from docs/api-reference/rum/browser-rum-core.commonproperties.usr.md rename to docs/api-reference/rum/browser-rum.commonproperties.usr.md index 90855a51fe..fb7e4615c2 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.usr.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.usr.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [usr](./browser-rum-core.commonproperties.usr.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [usr](./browser-rum.commonproperties.usr.md) ## CommonProperties.usr property diff --git a/docs/api-reference/rum/browser-rum.commonproperties.version.md b/docs/api-reference/rum/browser-rum.commonproperties.version.md new file mode 100644 index 0000000000..7e7db354d1 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.commonproperties.version.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [version](./browser-rum.commonproperties.version.md) + +## CommonProperties.version property + +The version for this application + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.commonproperties.view.md b/docs/api-reference/rum/browser-rum.commonproperties.view.md similarity index 60% rename from docs/api-reference/rum/browser-rum-core.commonproperties.view.md rename to docs/api-reference/rum/browser-rum.commonproperties.view.md index ab9a214e39..93bc4d48a6 100644 --- a/docs/api-reference/rum/browser-rum-core.commonproperties.view.md +++ b/docs/api-reference/rum/browser-rum.commonproperties.view.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [CommonProperties](./browser-rum-core.commonproperties.md) > [view](./browser-rum-core.commonproperties.view.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [view](./browser-rum.commonproperties.view.md) ## CommonProperties.view property diff --git a/docs/api-reference/rum/browser-rum.md b/docs/api-reference/rum/browser-rum.md index 7e1821dafb..13b6eaae58 100644 --- a/docs/api-reference/rum/browser-rum.md +++ b/docs/api-reference/rum/browser-rum.md @@ -4,6 +4,113 @@ ## browser-rum package +## Interfaces + + + + + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[CommonProperties](./browser-rum.commonproperties.md) + + + + +Schema of common properties of RUM events + + +
+ +[RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) + + + + + +
+ +[RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) + + + + + +
+ +[RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) + + + + + +
+ +[RumGlobal](./browser-rum.rumglobal.md) + + + + + +
+ +[RumInitConfiguration](./browser-rum.ruminitconfiguration.md) + + + + + +
+ +[RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) + + + + + +
+ +[RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) + + + + + +
+ +[RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) + + + + + +
+ +[RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) + + + + + +
+ ## Variables +
@@ -25,5 +132,106 @@ Description +
+ +## Type Aliases + + + + + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[RumActionEvent](./browser-rum.rumactionevent.md) + + + + +Schema of all properties of an Action event + + +
+ +[RumErrorEvent](./browser-rum.rumerrorevent.md) + + + + +Schema of all properties of an Error event + + +
+ +[RumEvent](./browser-rum.rumevent.md) + + + + +Schema of all properties of a RUM event + + +
+ +[RumEventDomainContext](./browser-rum.rumeventdomaincontext.md) + + + + + +
+ +[RumLongTaskEvent](./browser-rum.rumlongtaskevent.md) + + + + +Schema of all properties of a Long Task event + + +
+ +[RumResourceEvent](./browser-rum.rumresourceevent.md) + + + + +Schema of all properties of a Resource event + + +
+ +[RumViewEvent](./browser-rum.rumviewevent.md) + + + + +Schema of all properties of a View event + + +
+ +[RumVitalEvent](./browser-rum.rumvitalevent.md) + + + + +Schema of all properties of a Vital event + +
diff --git a/docs/api-reference/rum/browser-rum-core.rumactionevent.md b/docs/api-reference/rum/browser-rum.rumactionevent.md similarity index 87% rename from docs/api-reference/rum/browser-rum-core.rumactionevent.md rename to docs/api-reference/rum/browser-rum.rumactionevent.md index d9d68f095c..95683a12b1 100644 --- a/docs/api-reference/rum/browser-rum-core.rumactionevent.md +++ b/docs/api-reference/rum/browser-rum.rumactionevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEvent](./browser-rum-core.rumactionevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEvent](./browser-rum.rumactionevent.md) ## RumActionEvent type @@ -66,5 +66,5 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md new file mode 100644 index 0000000000..ee1da6f454 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) > [events](./browser-rum.rumactioneventdomaincontext.events.md) + +## RumActionEventDomainContext.events property + +**Signature:** + +```typescript +events?: Event[]; +``` diff --git a/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..00b729c00e --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) > [handlingStack](./browser-rum.rumactioneventdomaincontext.handlingstack.md) + +## RumActionEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.md similarity index 57% rename from docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.md index 5b8264dd76..18c9e5198f 100644 --- a/docs/api-reference/rum/browser-rum-core.rumactioneventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumActionEventDomainContext](./browser-rum-core.rumactioneventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) ## RumActionEventDomainContext interface @@ -35,7 +35,7 @@ Description -[events?](./browser-rum-core.rumactioneventdomaincontext.events.md) +[events?](./browser-rum.rumactioneventdomaincontext.events.md) @@ -54,7 +54,7 @@ _(Optional)_ -[handlingStack?](./browser-rum-core.rumactioneventdomaincontext.handlingstack.md) +[handlingStack?](./browser-rum.rumactioneventdomaincontext.handlingstack.md) diff --git a/docs/api-reference/rum/browser-rum-core.rumerrorevent.md b/docs/api-reference/rum/browser-rum.rumerrorevent.md similarity index 91% rename from docs/api-reference/rum/browser-rum-core.rumerrorevent.md rename to docs/api-reference/rum/browser-rum.rumerrorevent.md index 11206c4ae8..af44321526 100644 --- a/docs/api-reference/rum/browser-rum-core.rumerrorevent.md +++ b/docs/api-reference/rum/browser-rum.rumerrorevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEvent](./browser-rum-core.rumerrorevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEvent](./browser-rum.rumerrorevent.md) ## RumErrorEvent type @@ -90,5 +90,5 @@ export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewConta [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md new file mode 100644 index 0000000000..07b86a62c7 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) > [error](./browser-rum.rumerroreventdomaincontext.error.md) + +## RumErrorEventDomainContext.error property + +**Signature:** + +```typescript +error: unknown; +``` diff --git a/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..a34386757b --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) > [handlingStack](./browser-rum.rumerroreventdomaincontext.handlingstack.md) + +## RumErrorEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.md similarity index 57% rename from docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.md index ef2ea5b2cf..144dc2e01c 100644 --- a/docs/api-reference/rum/browser-rum-core.rumerroreventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumErrorEventDomainContext](./browser-rum-core.rumerroreventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) ## RumErrorEventDomainContext interface @@ -35,7 +35,7 @@ Description -[error](./browser-rum-core.rumerroreventdomaincontext.error.md) +[error](./browser-rum.rumerroreventdomaincontext.error.md) @@ -52,7 +52,7 @@ unknown -[handlingStack?](./browser-rum-core.rumerroreventdomaincontext.handlingstack.md) +[handlingStack?](./browser-rum.rumerroreventdomaincontext.handlingstack.md) diff --git a/docs/api-reference/rum/browser-rum.rumevent.md b/docs/api-reference/rum/browser-rum.rumevent.md new file mode 100644 index 0000000000..33ce6e8059 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumevent.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumEvent](./browser-rum.rumevent.md) + +## RumEvent type + +Schema of all properties of a RUM event + +**Signature:** + +```typescript +export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; +``` +**References:** [RumActionEvent](./browser-rum.rumactionevent.md), [RumErrorEvent](./browser-rum.rumerrorevent.md), [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md), [RumResourceEvent](./browser-rum.rumresourceevent.md), [RumViewEvent](./browser-rum.rumviewevent.md), [RumVitalEvent](./browser-rum.rumvitalevent.md) + diff --git a/docs/api-reference/rum/browser-rum.rumeventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumeventdomaincontext.md new file mode 100644 index 0000000000..c232bce44c --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumeventdomaincontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumEventDomainContext](./browser-rum.rumeventdomaincontext.md) + +## RumEventDomainContext type + +**Signature:** + +```typescript +export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; +``` +**References:** [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md), [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md), [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md), [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md), [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) + diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md new file mode 100644 index 0000000000..4d79f74441 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [error](./browser-rum.rumfetchresourceeventdomaincontext.error.md) + +## RumFetchResourceEventDomainContext.error property + +**Signature:** + +```typescript +error?: Error; +``` diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..ec51e5665f --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [handlingStack](./browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md) + +## RumFetchResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md new file mode 100644 index 0000000000..84bcee1ea4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [isAborted](./browser-rum.rumfetchresourceeventdomaincontext.isaborted.md) + +## RumFetchResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.md similarity index 50% rename from docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.md index 1bae30737f..037e85bf86 100644 --- a/docs/api-reference/rum/browser-rum-core.rumfetchresourceeventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumFetchResourceEventDomainContext](./browser-rum-core.rumfetchresourceeventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) ## RumFetchResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -[error?](./browser-rum-core.rumfetchresourceeventdomaincontext.error.md) +[error?](./browser-rum.rumfetchresourceeventdomaincontext.error.md) @@ -54,7 +54,7 @@ _(Optional)_ -[handlingStack?](./browser-rum-core.rumfetchresourceeventdomaincontext.handlingstack.md) +[handlingStack?](./browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md) @@ -73,7 +73,7 @@ _(Optional)_ -[isAborted](./browser-rum-core.rumfetchresourceeventdomaincontext.isaborted.md) +[isAborted](./browser-rum.rumfetchresourceeventdomaincontext.isaborted.md) @@ -90,7 +90,7 @@ boolean -[performanceEntry?](./browser-rum-core.rumfetchresourceeventdomaincontext.performanceentry.md) +[performanceEntry?](./browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md) @@ -109,7 +109,7 @@ _(Optional)_ -[requestInit?](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinit.md) +[requestInit?](./browser-rum.rumfetchresourceeventdomaincontext.requestinit.md) @@ -128,7 +128,7 @@ _(Optional)_ -[requestInput](./browser-rum-core.rumfetchresourceeventdomaincontext.requestinput.md) +[requestInput](./browser-rum.rumfetchresourceeventdomaincontext.requestinput.md) @@ -145,7 +145,7 @@ RequestInfo -[response?](./browser-rum-core.rumfetchresourceeventdomaincontext.response.md) +[response?](./browser-rum.rumfetchresourceeventdomaincontext.response.md) diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..6598327071 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md) + +## RumFetchResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md new file mode 100644 index 0000000000..17e9697eb8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [requestInit](./browser-rum.rumfetchresourceeventdomaincontext.requestinit.md) + +## RumFetchResourceEventDomainContext.requestInit property + +**Signature:** + +```typescript +requestInit?: RequestInit; +``` diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md new file mode 100644 index 0000000000..a4a6ebcb19 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [requestInput](./browser-rum.rumfetchresourceeventdomaincontext.requestinput.md) + +## RumFetchResourceEventDomainContext.requestInput property + +**Signature:** + +```typescript +requestInput: RequestInfo; +``` diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md new file mode 100644 index 0000000000..faae9fb0e5 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [response](./browser-rum.rumfetchresourceeventdomaincontext.response.md) + +## RumFetchResourceEventDomainContext.response property + +**Signature:** + +```typescript +response?: Response; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.addaction.md b/docs/api-reference/rum/browser-rum.rumglobal.addaction.md new file mode 100644 index 0000000000..10288771cb --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.addaction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addAction](./browser-rum.rumglobal.addaction.md) + +## RumGlobal.addAction property + +Add a custom action, stored in `@action` + +**Signature:** + +```typescript +addAction: (name: string, context?: object) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md b/docs/api-reference/rum/browser-rum.rumglobal.adddurationvital.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md rename to docs/api-reference/rum/browser-rum.rumglobal.adddurationvital.md index b7e6f9c7f6..c2616c339c 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.adddurationvital.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.adddurationvital.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addDurationVital](./browser-rum-core.rumpublicapi.adddurationvital.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addDurationVital](./browser-rum.rumglobal.adddurationvital.md) -## RumPublicApi.addDurationVital property +## RumGlobal.addDurationVital property Add a custom duration vital diff --git a/docs/api-reference/rum/browser-rum.rumglobal.adderror.md b/docs/api-reference/rum/browser-rum.rumglobal.adderror.md new file mode 100644 index 0000000000..82b2c38810 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.adderror.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addError](./browser-rum.rumglobal.adderror.md) + +## RumGlobal.addError property + +Add a custom error, stored in `@error`. + +**Signature:** + +```typescript +addError: (error: unknown, context?: object) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md new file mode 100644 index 0000000000..5201237968 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addFeatureFlagEvaluation](./browser-rum.rumglobal.addfeatureflagevaluation.md) + +## RumGlobal.addFeatureFlagEvaluation property + +Add a feature flag evaluation, stored in `@feature_flags.` + +**Signature:** + +```typescript +addFeatureFlagEvaluation: (key: string, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md b/docs/api-reference/rum/browser-rum.rumglobal.addtiming.md similarity index 53% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md rename to docs/api-reference/rum/browser-rum.rumglobal.addtiming.md index 293b8bee21..b86ec8fb7c 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.addtiming.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.addtiming.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [addTiming](./browser-rum-core.rumpublicapi.addtiming.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addTiming](./browser-rum.rumglobal.addtiming.md) -## RumPublicApi.addTiming property +## RumGlobal.addTiming property Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md b/docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md new file mode 100644 index 0000000000..b405a5cd27 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearAccount](./browser-rum.rumglobal.clearaccount.md) + +## RumGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.clearglobalcontext.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md rename to docs/api-reference/rum/browser-rum.rumglobal.clearglobalcontext.md index 363c85699f..b4454d9b05 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearglobalcontext.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.clearglobalcontext.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearGlobalContext](./browser-rum-core.rumpublicapi.clearglobalcontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearGlobalContext](./browser-rum.rumglobal.clearglobalcontext.md) -## RumPublicApi.clearGlobalContext property +## RumGlobal.clearGlobalContext property Clear the global context diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md b/docs/api-reference/rum/browser-rum.rumglobal.clearuser.md similarity index 56% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md rename to docs/api-reference/rum/browser-rum.rumglobal.clearuser.md index 630013563d..b832f58248 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.clearuser.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.clearuser.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [clearUser](./browser-rum-core.rumpublicapi.clearuser.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearUser](./browser-rum.rumglobal.clearuser.md) -## RumPublicApi.clearUser property +## RumGlobal.clearUser property Clear all user information diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getaccount.md b/docs/api-reference/rum/browser-rum.rumglobal.getaccount.md new file mode 100644 index 0000000000..114a476219 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.getaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getAccount](./browser-rum.rumglobal.getaccount.md) + +## RumGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.getglobalcontext.md similarity index 55% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md rename to docs/api-reference/rum/browser-rum.rumglobal.getglobalcontext.md index 4e4bfa3520..0986d24876 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getglobalcontext.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.getglobalcontext.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getGlobalContext](./browser-rum-core.rumpublicapi.getglobalcontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getGlobalContext](./browser-rum.rumglobal.getglobalcontext.md) -## RumPublicApi.getGlobalContext property +## RumGlobal.getGlobalContext property Get the global Context diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md b/docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md new file mode 100644 index 0000000000..9baebc09ac --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getInitConfiguration](./browser-rum.rumglobal.getinitconfiguration.md) + +## RumGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => RumInitConfiguration | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md new file mode 100644 index 0000000000..b76f162af9 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getInternalContext](./browser-rum.rumglobal.getinternalcontext.md) + +## RumGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md b/docs/api-reference/rum/browser-rum.rumglobal.getsessionreplaylink.md similarity index 58% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md rename to docs/api-reference/rum/browser-rum.rumglobal.getsessionreplaylink.md index 8fcdab0c34..bcd7602159 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getsessionreplaylink.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getSessionReplayLink](./browser-rum-core.rumpublicapi.getsessionreplaylink.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getSessionReplayLink](./browser-rum.rumglobal.getsessionreplaylink.md) -## RumPublicApi.getSessionReplayLink property +## RumGlobal.getSessionReplayLink property Get the Session Replay Link. diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md b/docs/api-reference/rum/browser-rum.rumglobal.getuser.md similarity index 56% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md rename to docs/api-reference/rum/browser-rum.rumglobal.getuser.md index 4e4cf21e87..e373ef5af5 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.getuser.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.getuser.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [getUser](./browser-rum-core.rumpublicapi.getuser.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getUser](./browser-rum.rumglobal.getuser.md) -## RumPublicApi.getUser property +## RumGlobal.getUser property Get user information diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md new file mode 100644 index 0000000000..10aba554f2 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getViewContext](./browser-rum.rumglobal.getviewcontext.md) + +## RumGlobal.getViewContext property + +Get View Context. + +**Signature:** + +```typescript +getViewContext: () => Context; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.init.md b/docs/api-reference/rum/browser-rum.rumglobal.init.md new file mode 100644 index 0000000000..3dc614c3c4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.init.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [init](./browser-rum.rumglobal.init.md) + +## RumGlobal.init property + +Init the RUM browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: RumInitConfiguration) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.md b/docs/api-reference/rum/browser-rum.rumglobal.md similarity index 66% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.md rename to docs/api-reference/rum/browser-rum.rumglobal.md index a09847e2a8..cbf2faca90 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) -## RumPublicApi interface +## RumGlobal interface **Signature:** @@ -36,7 +36,7 @@ Description -[addAction](./browser-rum-core.rumpublicapi.addaction.md) +[addAction](./browser-rum.rumglobal.addaction.md) @@ -55,7 +55,7 @@ Add a custom action, stored in `@action` -[addDurationVital](./browser-rum-core.rumpublicapi.adddurationvital.md) +[addDurationVital](./browser-rum.rumglobal.adddurationvital.md) @@ -74,7 +74,7 @@ Add a custom duration vital -[addError](./browser-rum-core.rumpublicapi.adderror.md) +[addError](./browser-rum.rumglobal.adderror.md) @@ -93,7 +93,7 @@ Add a custom error, stored in `@error`. -[addFeatureFlagEvaluation](./browser-rum-core.rumpublicapi.addfeatureflagevaluation.md) +[addFeatureFlagEvaluation](./browser-rum.rumglobal.addfeatureflagevaluation.md) @@ -112,7 +112,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` -[addTiming](./browser-rum-core.rumpublicapi.addtiming.md) +[addTiming](./browser-rum.rumglobal.addtiming.md) @@ -131,7 +131,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. -[clearAccount](./browser-rum-core.rumpublicapi.clearaccount.md) +[clearAccount](./browser-rum.rumglobal.clearaccount.md) @@ -150,7 +150,7 @@ Clear all account information -[clearGlobalContext](./browser-rum-core.rumpublicapi.clearglobalcontext.md) +[clearGlobalContext](./browser-rum.rumglobal.clearglobalcontext.md) @@ -171,7 +171,7 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser -[clearUser](./browser-rum-core.rumpublicapi.clearuser.md) +[clearUser](./browser-rum.rumglobal.clearuser.md) @@ -192,7 +192,7 @@ See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/a -[getAccount](./browser-rum-core.rumpublicapi.getaccount.md) +[getAccount](./browser-rum.rumglobal.getaccount.md) @@ -211,7 +211,7 @@ Get account information -[getGlobalContext](./browser-rum-core.rumpublicapi.getglobalcontext.md) +[getGlobalContext](./browser-rum.rumglobal.getglobalcontext.md) @@ -232,7 +232,7 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser -[getInitConfiguration](./browser-rum-core.rumpublicapi.getinitconfiguration.md) +[getInitConfiguration](./browser-rum.rumglobal.getinitconfiguration.md) @@ -240,7 +240,7 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser -() => [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) \| undefined +() => [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) \| undefined @@ -251,7 +251,7 @@ Get the init configuration -[getInternalContext](./browser-rum-core.rumpublicapi.getinternalcontext.md) +[getInternalContext](./browser-rum.rumglobal.getinternalcontext.md) @@ -270,7 +270,7 @@ Get the init configuration -[getSessionReplayLink](./browser-rum-core.rumpublicapi.getsessionreplaylink.md) +[getSessionReplayLink](./browser-rum.rumglobal.getsessionreplaylink.md) @@ -291,7 +291,7 @@ See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq. -[getUser](./browser-rum-core.rumpublicapi.getuser.md) +[getUser](./browser-rum.rumglobal.getuser.md) @@ -312,7 +312,7 @@ See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/a -[getViewContext](./browser-rum-core.rumpublicapi.getviewcontext.md) +[getViewContext](./browser-rum.rumglobal.getviewcontext.md) @@ -331,7 +331,7 @@ Get View Context. -[init](./browser-rum-core.rumpublicapi.init.md) +[init](./browser-rum.rumglobal.init.md) @@ -339,7 +339,7 @@ Get View Context. -(initConfiguration: [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md)) => void +(initConfiguration: [RumInitConfiguration](./browser-rum.ruminitconfiguration.md)) => void @@ -350,7 +350,7 @@ Init the RUM browser SDK. -[removeAccountProperty](./browser-rum-core.rumpublicapi.removeaccountproperty.md) +[removeAccountProperty](./browser-rum.rumglobal.removeaccountproperty.md) @@ -369,7 +369,7 @@ Remove an account property -[removeGlobalContextProperty](./browser-rum-core.rumpublicapi.removeglobalcontextproperty.md) +[removeGlobalContextProperty](./browser-rum.rumglobal.removeglobalcontextproperty.md) @@ -390,7 +390,7 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser -[removeUserProperty](./browser-rum-core.rumpublicapi.removeuserproperty.md) +[removeUserProperty](./browser-rum.rumglobal.removeuserproperty.md) @@ -411,7 +411,7 @@ See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/a -[setAccount](./browser-rum-core.rumpublicapi.setaccount.md) +[setAccount](./browser-rum.rumglobal.setaccount.md) @@ -430,7 +430,7 @@ Set account information to all events, stored in `@account` -[setAccountProperty](./browser-rum-core.rumpublicapi.setaccountproperty.md) +[setAccountProperty](./browser-rum.rumglobal.setaccountproperty.md) @@ -449,7 +449,7 @@ Set or update the account property, stored in `@account.` -[setGlobalContext](./browser-rum-core.rumpublicapi.setglobalcontext.md) +[setGlobalContext](./browser-rum.rumglobal.setglobalcontext.md) @@ -468,7 +468,7 @@ Set the global context information to all events, stored in `@context` -[setGlobalContextProperty](./browser-rum-core.rumpublicapi.setglobalcontextproperty.md) +[setGlobalContextProperty](./browser-rum.rumglobal.setglobalcontextproperty.md) @@ -487,7 +487,7 @@ Set or update a global context property, stored in `@context.` -[setTrackingConsent](./browser-rum-core.rumpublicapi.settrackingconsent.md) +[setTrackingConsent](./browser-rum.rumglobal.settrackingconsent.md) @@ -506,7 +506,7 @@ Set the tracking consent of the current user. -[setUserProperty](./browser-rum-core.rumpublicapi.setuserproperty.md) +[setUserProperty](./browser-rum.rumglobal.setuserproperty.md) @@ -525,7 +525,7 @@ Set or update the user property, stored in `@usr.` -[setViewContext](./browser-rum-core.rumpublicapi.setviewcontext.md) +[setViewContext](./browser-rum.rumglobal.setviewcontext.md) @@ -546,7 +546,7 @@ Enable to manually set the context of the current view. -[setViewContextProperty](./browser-rum-core.rumpublicapi.setviewcontextproperty.md) +[setViewContextProperty](./browser-rum.rumglobal.setviewcontextproperty.md) @@ -567,7 +567,7 @@ Enable to manually set a property of the context of the current view. -[setViewName](./browser-rum-core.rumpublicapi.setviewname.md) +[setViewName](./browser-rum.rumglobal.setviewname.md) @@ -588,7 +588,7 @@ Enable to manually change the name of the current view. -[startDurationVital](./browser-rum-core.rumpublicapi.startdurationvital.md) +[startDurationVital](./browser-rum.rumglobal.startdurationvital.md) @@ -609,7 +609,7 @@ If you plan to have multiple durations for the same vital, you should use the re -[startSessionReplayRecording](./browser-rum-core.rumpublicapi.startsessionreplayrecording.md) +[startSessionReplayRecording](./browser-rum.rumglobal.startsessionreplayrecording.md) @@ -617,7 +617,7 @@ If you plan to have multiple durations for the same vital, you should use the re -(options?: [StartRecordingOptions](./browser-rum-core.startrecordingoptions.md)) => void +(options?: StartRecordingOptions) => void @@ -630,7 +630,7 @@ See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring -[startView](./browser-rum-core.rumpublicapi.startview.md) +[startView](./browser-rum.rumglobal.startview.md) @@ -649,7 +649,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -[stopDurationVital](./browser-rum-core.rumpublicapi.stopdurationvital.md) +[stopDurationVital](./browser-rum.rumglobal.stopdurationvital.md) @@ -668,7 +668,7 @@ Stop a custom duration vital -[stopSession](./browser-rum-core.rumpublicapi.stopsession.md) +[stopSession](./browser-rum.rumglobal.stopsession.md) @@ -687,7 +687,7 @@ Stop the session. A new session will start at the next user interaction with the -[stopSessionReplayRecording](./browser-rum-core.rumpublicapi.stopsessionreplayrecording.md) +[stopSessionReplayRecording](./browser-rum.rumglobal.stopsessionreplayrecording.md) @@ -723,7 +723,7 @@ Description -[setUser(newUser)](./browser-rum-core.rumpublicapi.setuser.md) +[setUser(newUser)](./browser-rum.rumglobal.setuser.md) @@ -736,7 +736,7 @@ See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/a -[setUser(newUser)](./browser-rum-core.rumpublicapi.setuser_1.md) +[setUser(newUser)](./browser-rum.rumglobal.setuser_1.md) diff --git a/docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md new file mode 100644 index 0000000000..b25a09766a --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeAccountProperty](./browser-rum.rumglobal.removeaccountproperty.md) + +## RumGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.removeglobalcontextproperty.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md rename to docs/api-reference/rum/browser-rum.rumglobal.removeglobalcontextproperty.md index 487a3b190a..a03e7ea84f 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeglobalcontextproperty.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeGlobalContextProperty](./browser-rum-core.rumpublicapi.removeglobalcontextproperty.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeGlobalContextProperty](./browser-rum.rumglobal.removeglobalcontextproperty.md) -## RumPublicApi.removeGlobalContextProperty property +## RumGlobal.removeGlobalContextProperty property Remove a global context property diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.removeuserproperty.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md rename to docs/api-reference/rum/browser-rum.rumglobal.removeuserproperty.md index 6d04db69d6..8a0c8487ad 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.removeuserproperty.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.removeuserproperty.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [removeUserProperty](./browser-rum-core.rumpublicapi.removeuserproperty.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeUserProperty](./browser-rum.rumglobal.removeuserproperty.md) -## RumPublicApi.removeUserProperty property +## RumGlobal.removeUserProperty property Remove a user property diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setaccount.md b/docs/api-reference/rum/browser-rum.rumglobal.setaccount.md new file mode 100644 index 0000000000..12926738fb --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setaccount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setAccount](./browser-rum.rumglobal.setaccount.md) + +## RumGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md new file mode 100644 index 0000000000..6ec0626be0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setAccountProperty](./browser-rum.rumglobal.setaccountproperty.md) + +## RumGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md new file mode 100644 index 0000000000..342239b8c6 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setGlobalContext](./browser-rum.rumglobal.setglobalcontext.md) + +## RumGlobal.setGlobalContext property + +Set the global context information to all events, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md new file mode 100644 index 0000000000..10f1898f4a --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setGlobalContextProperty](./browser-rum.rumglobal.setglobalcontextproperty.md) + +## RumGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md b/docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md new file mode 100644 index 0000000000..9fcfe4cbff --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setTrackingConsent](./browser-rum.rumglobal.settrackingconsent.md) + +## RumGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md b/docs/api-reference/rum/browser-rum.rumglobal.setuser.md similarity index 68% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md rename to docs/api-reference/rum/browser-rum.rumglobal.setuser.md index 4a1029dc43..bcac763970 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.setuser.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUser](./browser-rum-core.rumpublicapi.setuser.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUser](./browser-rum.rumglobal.setuser.md) -## RumPublicApi.setUser() method +## RumGlobal.setUser() method Set user information to all events, stored in `@usr` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md b/docs/api-reference/rum/browser-rum.rumglobal.setuser_1.md similarity index 63% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md rename to docs/api-reference/rum/browser-rum.rumglobal.setuser_1.md index 892eea7293..28ba53adc8 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.setuser_1.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.setuser_1.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [setUser](./browser-rum-core.rumpublicapi.setuser_1.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUser](./browser-rum.rumglobal.setuser_1.md) -## RumPublicApi.setUser() method +## RumGlobal.setUser() method > Warning: This API is now obsolete. > diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md new file mode 100644 index 0000000000..2f1ad618a8 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUserProperty](./browser-rum.rumglobal.setuserproperty.md) + +## RumGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md b/docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md new file mode 100644 index 0000000000..b63864e8b3 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewContext](./browser-rum.rumglobal.setviewcontext.md) + +## RumGlobal.setViewContext property + +Set View Context. + +Enable to manually set the context of the current view. + +**Signature:** + +```typescript +setViewContext: (context: Context) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md b/docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md new file mode 100644 index 0000000000..15c0a7095c --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewContextProperty](./browser-rum.rumglobal.setviewcontextproperty.md) + +## RumGlobal.setViewContextProperty property + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + +**Signature:** + +```typescript +setViewContextProperty: (key: string, value: any) => void; +``` diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewname.md b/docs/api-reference/rum/browser-rum.rumglobal.setviewname.md new file mode 100644 index 0000000000..9e3e7e7075 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.setviewname.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewName](./browser-rum.rumglobal.setviewname.md) + +## RumGlobal.setViewName property + +Set View Name. + +Enable to manually change the name of the current view. + +**Signature:** + +```typescript +setViewName: (name: string) => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md b/docs/api-reference/rum/browser-rum.rumglobal.startdurationvital.md similarity index 59% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md rename to docs/api-reference/rum/browser-rum.rumglobal.startdurationvital.md index 1c93445920..44d61e8a2e 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startdurationvital.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.startdurationvital.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startDurationVital](./browser-rum-core.rumpublicapi.startdurationvital.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startDurationVital](./browser-rum.rumglobal.startdurationvital.md) -## RumPublicApi.startDurationVital property +## RumGlobal.startDurationVital property Start a custom duration vital. diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md b/docs/api-reference/rum/browser-rum.rumglobal.startsessionreplayrecording.md similarity index 62% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md rename to docs/api-reference/rum/browser-rum.rumglobal.startsessionreplayrecording.md index 209e9304c0..3c85c33bab 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startsessionreplayrecording.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startSessionReplayRecording](./browser-rum-core.rumpublicapi.startsessionreplayrecording.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startSessionReplayRecording](./browser-rum.rumglobal.startsessionreplayrecording.md) -## RumPublicApi.startSessionReplayRecording property +## RumGlobal.startSessionReplayRecording property Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md b/docs/api-reference/rum/browser-rum.rumglobal.startview.md similarity index 63% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md rename to docs/api-reference/rum/browser-rum.rumglobal.startview.md index 147d1ac594..5e12d064fd 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.startview.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.startview.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [startView](./browser-rum-core.rumpublicapi.startview.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startView](./browser-rum.rumglobal.startview.md) -## RumPublicApi.startView property +## RumGlobal.startView property Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md b/docs/api-reference/rum/browser-rum.rumglobal.stopdurationvital.md similarity index 52% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md rename to docs/api-reference/rum/browser-rum.rumglobal.stopdurationvital.md index dcfebfb861..dee60011f9 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopdurationvital.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.stopdurationvital.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopDurationVital](./browser-rum-core.rumpublicapi.stopdurationvital.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopDurationVital](./browser-rum.rumglobal.stopdurationvital.md) -## RumPublicApi.stopDurationVital property +## RumGlobal.stopDurationVital property Stop a custom duration vital diff --git a/docs/api-reference/rum/browser-rum.rumglobal.stopsession.md b/docs/api-reference/rum/browser-rum.rumglobal.stopsession.md new file mode 100644 index 0000000000..434079b019 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumglobal.stopsession.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopSession](./browser-rum.rumglobal.stopsession.md) + +## RumGlobal.stopSession property + +Stop the session. A new session will start at the next user interaction with the page. + +**Signature:** + +```typescript +stopSession: () => void; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md b/docs/api-reference/rum/browser-rum.rumglobal.stopsessionreplayrecording.md similarity index 52% rename from docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md rename to docs/api-reference/rum/browser-rum.rumglobal.stopsessionreplayrecording.md index 740a2fc823..9481671665 100644 --- a/docs/api-reference/rum/browser-rum-core.rumpublicapi.stopsessionreplayrecording.md +++ b/docs/api-reference/rum/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumPublicApi](./browser-rum-core.rumpublicapi.md) > [stopSessionReplayRecording](./browser-rum-core.rumpublicapi.stopsessionreplayrecording.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopSessionReplayRecording](./browser-rum.rumglobal.stopsessionreplayrecording.md) -## RumPublicApi.stopSessionReplayRecording property +## RumGlobal.stopSessionReplayRecording property Stop Session Replay recording. diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.actionnameattribute.md similarity index 64% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.actionnameattribute.md index 1b9e7621a3..19ef4fe19f 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.actionnameattribute.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [actionNameAttribute](./browser-rum-core.ruminitconfiguration.actionnameattribute.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [actionNameAttribute](./browser-rum.ruminitconfiguration.actionnameattribute.md) ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.allowedtracingurls.md similarity index 64% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.allowedtracingurls.md index d4225adcea..f84c9de780 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.allowedtracingurls.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [allowedTracingUrls](./browser-rum-core.ruminitconfiguration.allowedtracingurls.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [allowedTracingUrls](./browser-rum.ruminitconfiguration.allowedtracingurls.md) ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md new file mode 100644 index 0000000000..35cafa5e87 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [applicationId](./browser-rum.ruminitconfiguration.applicationid.md) + +## RumInitConfiguration.applicationId property + +The RUM application ID. + +**Signature:** + +```typescript +applicationId: string; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.beforesend.md similarity index 75% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.beforesend.md index 2e44d39f6f..bafc949bd9 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.beforesend.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [beforeSend](./browser-rum-core.ruminitconfiguration.beforesend.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [beforeSend](./browser-rum.ruminitconfiguration.beforesend.md) ## RumInitConfiguration.beforeSend property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.compressintakerequests.md similarity index 69% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.compressintakerequests.md index 2d81d5cbbd..edab3ce0d7 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.compressintakerequests.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [compressIntakeRequests](./browser-rum-core.ruminitconfiguration.compressintakerequests.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [compressIntakeRequests](./browser-rum.ruminitconfiguration.compressintakerequests.md) ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.defaultprivacylevel.md similarity index 65% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.defaultprivacylevel.md index 0dd344b1e1..b120958027 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [defaultPrivacyLevel](./browser-rum-core.ruminitconfiguration.defaultprivacylevel.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [defaultPrivacyLevel](./browser-rum.ruminitconfiguration.defaultprivacylevel.md) ## RumInitConfiguration.defaultPrivacyLevel property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.enableprivacyforactionname.md similarity index 50% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index f32823dfdd..12e8a75470 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [enablePrivacyForActionName](./browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [enablePrivacyForActionName](./browser-rum.ruminitconfiguration.enableprivacyforactionname.md) ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.excludedactivityurls.md similarity index 65% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.excludedactivityurls.md index 9c8991258d..32c76d31dc 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.excludedactivityurls.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [excludedActivityUrls](./browser-rum-core.ruminitconfiguration.excludedactivityurls.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [excludedActivityUrls](./browser-rum.ruminitconfiguration.excludedactivityurls.md) ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.md similarity index 71% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.md index 86986bf71d..0a6f376c65 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) ## RumInitConfiguration interface @@ -36,7 +36,7 @@ Description -[actionNameAttribute?](./browser-rum-core.ruminitconfiguration.actionnameattribute.md) +[actionNameAttribute?](./browser-rum.ruminitconfiguration.actionnameattribute.md) @@ -55,7 +55,7 @@ _(Optional)_ Specify your own attribute to use to name actions. See \[Declare a -[allowedTracingUrls?](./browser-rum-core.ruminitconfiguration.allowedtracingurls.md) +[allowedTracingUrls?](./browser-rum.ruminitconfiguration.allowedtracingurls.md) @@ -74,7 +74,7 @@ _(Optional)_ A list of request URLs used to inject tracing headers. See \[Connec -[applicationId](./browser-rum-core.ruminitconfiguration.applicationid.md) +[applicationId](./browser-rum.ruminitconfiguration.applicationid.md) @@ -93,7 +93,7 @@ The RUM application ID. -[beforeSend?](./browser-rum-core.ruminitconfiguration.beforesend.md) +[beforeSend?](./browser-rum.ruminitconfiguration.beforesend.md) @@ -101,7 +101,7 @@ The RUM application ID. -((event: [RumEvent](./browser-rum-core.rumevent.md), context: [RumEventDomainContext](./browser-rum-core.rumeventdomaincontext.md)) => boolean) \| undefined +((event: [RumEvent](./browser-rum.rumevent.md), context: [RumEventDomainContext](./browser-rum.rumeventdomaincontext.md)) => boolean) \| undefined @@ -114,7 +114,7 @@ See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadog -[compressIntakeRequests?](./browser-rum-core.ruminitconfiguration.compressintakerequests.md) +[compressIntakeRequests?](./browser-rum.ruminitconfiguration.compressintakerequests.md) @@ -133,7 +133,7 @@ _(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth us -[defaultPrivacyLevel?](./browser-rum-core.ruminitconfiguration.defaultprivacylevel.md) +[defaultPrivacyLevel?](./browser-rum.ruminitconfiguration.defaultprivacylevel.md) @@ -152,7 +152,7 @@ _(Optional)_ Allow to protect end user privacy and prevent sensitive organizatio -[enablePrivacyForActionName?](./browser-rum-core.ruminitconfiguration.enableprivacyforactionname.md) +[enablePrivacyForActionName?](./browser-rum.ruminitconfiguration.enableprivacyforactionname.md) @@ -171,7 +171,7 @@ _(Optional)_ Enables privacy control for action names. -[excludedActivityUrls?](./browser-rum-core.ruminitconfiguration.excludedactivityurls.md) +[excludedActivityUrls?](./browser-rum.ruminitconfiguration.excludedactivityurls.md) @@ -190,7 +190,7 @@ _(Optional)_ A list of request origins ignored when computing the page activity. -[plugins?](./browser-rum-core.ruminitconfiguration.plugins.md) +[plugins?](./browser-rum.ruminitconfiguration.plugins.md) @@ -198,7 +198,7 @@ _(Optional)_ A list of request origins ignored when computing the page activity. -[RumPlugin](./browser-rum-core.rumplugin.md)\[\] \| undefined +RumPlugin\[\] \| undefined @@ -209,7 +209,7 @@ _(Optional)_ List of plugins to enable. The plugins API is unstable and experime -[profilingSampleRate?](./browser-rum-core.ruminitconfiguration.profilingsamplerate.md) +[profilingSampleRate?](./browser-rum.ruminitconfiguration.profilingsamplerate.md) @@ -228,7 +228,7 @@ _(Optional)_ Not ready for production. The percentage of users profiled. A value -[propagateTraceBaggage?](./browser-rum-core.ruminitconfiguration.propagatetracebaggage.md) +[propagateTraceBaggage?](./browser-rum.ruminitconfiguration.propagatetracebaggage.md) @@ -247,7 +247,7 @@ _(Optional)_ Whether to propagate user and account IDs in the baggage header of -[remoteConfigurationId?](./browser-rum-core.ruminitconfiguration.remoteconfigurationid.md) +[remoteConfigurationId?](./browser-rum.ruminitconfiguration.remoteconfigurationid.md) @@ -266,7 +266,7 @@ _(Optional)_ -[sessionReplaySampleRate?](./browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md) +[sessionReplaySampleRate?](./browser-rum.ruminitconfiguration.sessionreplaysamplerate.md) @@ -285,7 +285,7 @@ _(Optional)_ The percentage of tracked sessions with \[Browser RUM & Session -[startSessionReplayRecordingManually?](./browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md) +[startSessionReplayRecordingManually?](./browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md) @@ -304,7 +304,7 @@ _(Optional)_ If the session is sampled for Session Replay, only start the record -[subdomain?](./browser-rum-core.ruminitconfiguration.subdomain.md) +[subdomain?](./browser-rum.ruminitconfiguration.subdomain.md) @@ -323,7 +323,7 @@ _(Optional)_ If you are accessing Datadog through a custom subdomain, you can se -[traceContextInjection?](./browser-rum-core.ruminitconfiguration.tracecontextinjection.md) +[traceContextInjection?](./browser-rum.ruminitconfiguration.tracecontextinjection.md) @@ -342,7 +342,7 @@ _(Optional)_ If you set a `traceSampleRate`, to ensure backend services' -[traceSampleRate?](./browser-rum-core.ruminitconfiguration.tracesamplerate.md) +[traceSampleRate?](./browser-rum.ruminitconfiguration.tracesamplerate.md) @@ -361,7 +361,26 @@ _(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \ -[trackFeatureFlagsForEvents?](./browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md) +[trackBfcacheViews?](./browser-rum.ruminitconfiguration.trackbfcacheviews.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enable the creation of dedicated views for pages restored from the Back-Forward cache. false + + + + + +[trackFeatureFlagsForEvents?](./browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md) @@ -380,7 +399,7 @@ _(Optional)_ Enables collection of features flags in chosen events. -[trackLongTasks?](./browser-rum-core.ruminitconfiguration.tracklongtasks.md) +[trackLongTasks?](./browser-rum.ruminitconfiguration.tracklongtasks.md) @@ -399,7 +418,7 @@ _(Optional)_ Enables collection of long task events. true -[trackResources?](./browser-rum-core.ruminitconfiguration.trackresources.md) +[trackResources?](./browser-rum.ruminitconfiguration.trackresources.md) @@ -418,7 +437,7 @@ _(Optional)_ Enables collection of resource events. true -[trackUserInteractions?](./browser-rum-core.ruminitconfiguration.trackuserinteractions.md) +[trackUserInteractions?](./browser-rum.ruminitconfiguration.trackuserinteractions.md) @@ -437,7 +456,7 @@ _(Optional)_ Enables automatic collection of users actions. See \[Tracking User -[trackViewsManually?](./browser-rum-core.ruminitconfiguration.trackviewsmanually.md) +[trackViewsManually?](./browser-rum.ruminitconfiguration.trackviewsmanually.md) @@ -456,7 +475,7 @@ _(Optional)_ Allows you to control RUM views creation. See \[Override default RU -[workerUrl?](./browser-rum-core.ruminitconfiguration.workerurl.md) +[workerUrl?](./browser-rum.ruminitconfiguration.workerurl.md) diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.plugins.md similarity index 63% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.plugins.md index 659dabd909..fc42fa068c 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.plugins.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.plugins.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [plugins](./browser-rum-core.ruminitconfiguration.plugins.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [plugins](./browser-rum.ruminitconfiguration.plugins.md) ## RumInitConfiguration.plugins property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.profilingsamplerate.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.profilingsamplerate.md index 76ec1f5fe4..64546acf42 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.profilingsamplerate.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [profilingSampleRate](./browser-rum-core.ruminitconfiguration.profilingsamplerate.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [profilingSampleRate](./browser-rum.ruminitconfiguration.profilingsamplerate.md) ## RumInitConfiguration.profilingSampleRate property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.propagatetracebaggage.md similarity index 54% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 0fefbb7633..1fece4fb24 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [propagateTraceBaggage](./browser-rum-core.ruminitconfiguration.propagatetracebaggage.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [propagateTraceBaggage](./browser-rum.ruminitconfiguration.propagatetracebaggage.md) ## RumInitConfiguration.propagateTraceBaggage property diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md new file mode 100644 index 0000000000..00d9a7186b --- /dev/null +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [remoteConfigurationId](./browser-rum.ruminitconfiguration.remoteconfigurationid.md) + +## RumInitConfiguration.remoteConfigurationId property + +**Signature:** + +```typescript +remoteConfigurationId?: string | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md similarity index 71% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 5592157cbb..a8c590f8ff 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [sessionReplaySampleRate](./browser-rum-core.ruminitconfiguration.sessionreplaysamplerate.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [sessionReplaySampleRate](./browser-rum.ruminitconfiguration.sessionreplaysamplerate.md) ## RumInitConfiguration.sessionReplaySampleRate property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md similarity index 68% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 820f78e546..c04dcaa3a7 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum-core.ruminitconfiguration.startsessionreplayrecordingmanually.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md) ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.subdomain.md similarity index 69% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.subdomain.md index afbf85809b..2b79f229cc 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.subdomain.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.subdomain.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [subdomain](./browser-rum-core.ruminitconfiguration.subdomain.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [subdomain](./browser-rum.ruminitconfiguration.subdomain.md) ## RumInitConfiguration.subdomain property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracecontextinjection.md similarity index 69% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.tracecontextinjection.md index 8c9c1f3dbf..7491c88d76 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracecontextinjection.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [traceContextInjection](./browser-rum-core.ruminitconfiguration.tracecontextinjection.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [traceContextInjection](./browser-rum.ruminitconfiguration.tracecontextinjection.md) ## RumInitConfiguration.traceContextInjection property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracesamplerate.md similarity index 63% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.tracesamplerate.md index a9ae78693e..139deb33dc 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracesamplerate.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [traceSampleRate](./browser-rum-core.ruminitconfiguration.tracesamplerate.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [traceSampleRate](./browser-rum.ruminitconfiguration.tracesamplerate.md) ## RumInitConfiguration.traceSampleRate property diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md new file mode 100644 index 0000000000..a2cb56a145 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackBfcacheViews](./browser-rum.ruminitconfiguration.trackbfcacheviews.md) + +## RumInitConfiguration.trackBfcacheViews property + +Enable the creation of dedicated views for pages restored from the Back-Forward cache. false + +**Signature:** + +```typescript +trackBfcacheViews?: boolean | undefined; +``` diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md similarity index 52% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 74ed0d60f6..d66ede8caf 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum-core.ruminitconfiguration.trackfeatureflagsforevents.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md) ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracklongtasks.md similarity index 51% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.tracklongtasks.md index 32177ef664..93950406bd 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.tracklongtasks.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackLongTasks](./browser-rum-core.ruminitconfiguration.tracklongtasks.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackLongTasks](./browser-rum.ruminitconfiguration.tracklongtasks.md) ## RumInitConfiguration.trackLongTasks property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackresources.md similarity index 50% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.trackresources.md index 54d47a32be..e8309153e4 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackresources.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackresources.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackResources](./browser-rum-core.ruminitconfiguration.trackresources.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackResources](./browser-rum.ruminitconfiguration.trackresources.md) ## RumInitConfiguration.trackResources property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackuserinteractions.md similarity index 61% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.trackuserinteractions.md index 6f27947593..79608750be 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackuserinteractions.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackUserInteractions](./browser-rum-core.ruminitconfiguration.trackuserinteractions.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackUserInteractions](./browser-rum.ruminitconfiguration.trackuserinteractions.md) ## RumInitConfiguration.trackUserInteractions property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackviewsmanually.md similarity index 64% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.trackviewsmanually.md index 2928e87950..b20b5228fa 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.trackviewsmanually.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [trackViewsManually](./browser-rum-core.ruminitconfiguration.trackviewsmanually.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackViewsManually](./browser-rum.ruminitconfiguration.trackviewsmanually.md) ## RumInitConfiguration.trackViewsManually property diff --git a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md b/docs/api-reference/rum/browser-rum.ruminitconfiguration.workerurl.md similarity index 70% rename from docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md rename to docs/api-reference/rum/browser-rum.ruminitconfiguration.workerurl.md index d3b13b7211..ea013500d4 100644 --- a/docs/api-reference/rum/browser-rum-core.ruminitconfiguration.workerurl.md +++ b/docs/api-reference/rum/browser-rum.ruminitconfiguration.workerurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumInitConfiguration](./browser-rum-core.ruminitconfiguration.md) > [workerUrl](./browser-rum-core.ruminitconfiguration.workerurl.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [workerUrl](./browser-rum.ruminitconfiguration.workerurl.md) ## RumInitConfiguration.workerUrl property diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md b/docs/api-reference/rum/browser-rum.rumlongtaskevent.md similarity index 85% rename from docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md rename to docs/api-reference/rum/browser-rum.rumlongtaskevent.md index a708f093dc..2efb7c65a7 100644 --- a/docs/api-reference/rum/browser-rum-core.rumlongtaskevent.md +++ b/docs/api-reference/rum/browser-rum.rumlongtaskevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEvent](./browser-rum-core.rumlongtaskevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md) ## RumLongTaskEvent type @@ -44,5 +44,5 @@ export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewCo [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.md similarity index 59% rename from docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.md index a9aadfcd91..33852ee909 100644 --- a/docs/api-reference/rum/browser-rum-core.rumlongtaskeventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumLongTaskEventDomainContext](./browser-rum-core.rumlongtaskeventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) ## RumLongTaskEventDomainContext interface @@ -35,7 +35,7 @@ Description -[performanceEntry](./browser-rum-core.rumlongtaskeventdomaincontext.performanceentry.md) +[performanceEntry](./browser-rum.rumlongtaskeventdomaincontext.performanceentry.md) diff --git a/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..609c2b8327 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) > [performanceEntry](./browser-rum.rumlongtaskeventdomaincontext.performanceentry.md) + +## RumLongTaskEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.md similarity index 58% rename from docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.md index 028b90810d..ec14c014cd 100644 --- a/docs/api-reference/rum/browser-rum-core.rumotherresourceeventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumOtherResourceEventDomainContext](./browser-rum-core.rumotherresourceeventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) ## RumOtherResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -[performanceEntry](./browser-rum-core.rumotherresourceeventdomaincontext.performanceentry.md) +[performanceEntry](./browser-rum.rumotherresourceeventdomaincontext.performanceentry.md) diff --git a/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..b12942a1a0 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumotherresourceeventdomaincontext.performanceentry.md) + +## RumOtherResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumresourceevent.md b/docs/api-reference/rum/browser-rum.rumresourceevent.md similarity index 90% rename from docs/api-reference/rum/browser-rum-core.rumresourceevent.md rename to docs/api-reference/rum/browser-rum.rumresourceevent.md index 4407d7d8b2..b7b966cdd1 100644 --- a/docs/api-reference/rum/browser-rum-core.rumresourceevent.md +++ b/docs/api-reference/rum/browser-rum.rumresourceevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumResourceEvent](./browser-rum-core.rumresourceevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumResourceEvent](./browser-rum.rumresourceevent.md) ## RumResourceEvent type @@ -85,5 +85,5 @@ export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewCo [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum-core.rumviewevent.md b/docs/api-reference/rum/browser-rum.rumviewevent.md similarity index 93% rename from docs/api-reference/rum/browser-rum-core.rumviewevent.md rename to docs/api-reference/rum/browser-rum.rumviewevent.md index 6374efce04..dd95d402c9 100644 --- a/docs/api-reference/rum/browser-rum-core.rumviewevent.md +++ b/docs/api-reference/rum/browser-rum.rumviewevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEvent](./browser-rum-core.rumviewevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEvent](./browser-rum.rumviewevent.md) ## RumViewEvent type @@ -139,5 +139,5 @@ export type RumViewEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md b/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md new file mode 100644 index 0000000000..fb6927d85e --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) > [location](./browser-rum.rumvieweventdomaincontext.location.md) + +## RumViewEventDomainContext.location property + +**Signature:** + +```typescript +location: Readonly; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.md similarity index 61% rename from docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.md index 9cf75d7501..79ad47bc2c 100644 --- a/docs/api-reference/rum/browser-rum-core.rumvieweventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumViewEventDomainContext](./browser-rum-core.rumvieweventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) ## RumViewEventDomainContext interface @@ -35,7 +35,7 @@ Description -[location](./browser-rum-core.rumvieweventdomaincontext.location.md) +[location](./browser-rum.rumvieweventdomaincontext.location.md) diff --git a/docs/api-reference/rum/browser-rum-core.rumvitalevent.md b/docs/api-reference/rum/browser-rum.rumvitalevent.md similarity index 76% rename from docs/api-reference/rum/browser-rum-core.rumvitalevent.md rename to docs/api-reference/rum/browser-rum.rumvitalevent.md index 4b05a338ca..da26b59401 100644 --- a/docs/api-reference/rum/browser-rum-core.rumvitalevent.md +++ b/docs/api-reference/rum/browser-rum.rumvitalevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumVitalEvent](./browser-rum-core.rumvitalevent.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumVitalEvent](./browser-rum.rumvitalevent.md) ## RumVitalEvent type @@ -32,5 +32,5 @@ export type RumVitalEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** [CommonProperties](./browser-rum-core.commonproperties.md) +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md new file mode 100644 index 0000000000..7c02e28fa4 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [handlingStack](./browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md) + +## RumXhrResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md new file mode 100644 index 0000000000..06c183b80a --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [isAborted](./browser-rum.rumxhrresourceeventdomaincontext.isaborted.md) + +## RumXhrResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.md similarity index 53% rename from docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md rename to docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.md index 072c0f9c92..ad8540e2de 100644 --- a/docs/api-reference/rum/browser-rum-core.rumxhrresourceeventdomaincontext.md +++ b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-core](./browser-rum-core.md) > [RumXhrResourceEventDomainContext](./browser-rum-core.rumxhrresourceeventdomaincontext.md) +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) ## RumXhrResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -[handlingStack?](./browser-rum-core.rumxhrresourceeventdomaincontext.handlingstack.md) +[handlingStack?](./browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md) @@ -54,7 +54,7 @@ _(Optional)_ -[isAborted](./browser-rum-core.rumxhrresourceeventdomaincontext.isaborted.md) +[isAborted](./browser-rum.rumxhrresourceeventdomaincontext.isaborted.md) @@ -71,7 +71,7 @@ boolean -[performanceEntry?](./browser-rum-core.rumxhrresourceeventdomaincontext.performanceentry.md) +[performanceEntry?](./browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md) @@ -90,7 +90,7 @@ _(Optional)_ -[xhr](./browser-rum-core.rumxhrresourceeventdomaincontext.xhr.md) +[xhr](./browser-rum.rumxhrresourceeventdomaincontext.xhr.md) diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md new file mode 100644 index 0000000000..df31aba736 --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md) + +## RumXhrResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md new file mode 100644 index 0000000000..1eb2d6f8ab --- /dev/null +++ b/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [xhr](./browser-rum.rumxhrresourceeventdomaincontext.xhr.md) + +## RumXhrResourceEventDomainContext.xhr property + +**Signature:** + +```typescript +xhr: XMLHttpRequest; +``` diff --git a/docs/api-reference/rum/index.md b/docs/api-reference/rum/index.md index 58f50b67fc..3b3651148c 100644 --- a/docs/api-reference/rum/index.md +++ b/docs/api-reference/rum/index.md @@ -34,15 +34,6 @@ Description - - - -[@datadog/browser-rum-core](./browser-rum-core.md) - - - - - diff --git a/etc/browser-rum-core.api.json b/etc/browser-rum-core.api.json deleted file mode 100644 index 4727278894..0000000000 --- a/etc/browser-rum-core.api.json +++ /dev/null @@ -1,10481 +0,0 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum-core!", - "docComment": "", - "name": "@datadog/browser-rum-core", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum-core!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!ActionType:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare const enum ActionType " - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "ActionType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!ActionType.CLICK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CLICK = " - }, - { - "kind": "Content", - "text": "\"click\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CLICK" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!ActionType.CUSTOM:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CUSTOM = " - }, - { - "kind": "Content", - "text": "\"custom\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CUSTOM" - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!CENSORED_IMG_MARK:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CENSORED_IMG_MARK = " - }, - { - "kind": "Content", - "text": "\"data:image/gif;base64,R0lGODlhAQABAIAAAMLCwgAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "CENSORED_IMG_MARK", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!CENSORED_STRING_MARK:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CENSORED_STRING_MARK = " - }, - { - "kind": "Content", - "text": "\"***\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "CENSORED_STRING_MARK", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!censorText:var", - "docComment": "/**\n * Text censoring non-destructively maintains whitespace characters in order to preserve text shape during replay.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "censorText: " - }, - { - "kind": "Content", - "text": "(text: string) => string" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "censorText", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface", - "docComment": "/**\n * Schema of common properties of RUM events\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CommonProperties " - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "CommonProperties", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#_dd:member", - "docComment": "/**\n * Internal properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly _dd: " - }, - { - "kind": "Content", - "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "_dd", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#account:member", - "docComment": "/**\n * Account properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly account?: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "account", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#application:member", - "docComment": "/**\n * Application properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly application: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "application", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#build_id:member", - "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#build_version:member", - "docComment": "/**\n * The build version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#ci_test:member", - "docComment": "/**\n * CI Visibility properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly ci_test?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "ci_test", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#connectivity:member", - "docComment": "/**\n * Device connectivity properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "connectivity?: " - }, - { - "kind": "Content", - "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "connectivity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#context:member", - "docComment": "/**\n * User provided context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Content", - "text": "{\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#date:member", - "docComment": "/**\n * Start of the event in ms from epoch\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly date: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#device:member", - "docComment": "/**\n * Device properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "device?: " - }, - { - "kind": "Content", - "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "device", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#display:member", - "docComment": "/**\n * Display properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "display?: " - }, - { - "kind": "Content", - "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "display", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#os:member", - "docComment": "/**\n * Operating system properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "os?: " - }, - { - "kind": "Content", - "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "os", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#service:member", - "docComment": "/**\n * The service name for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#session:member", - "docComment": "/**\n * Session properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly session: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "session", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#source:member", - "docComment": "/**\n * The source of this event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly source?: " - }, - { - "kind": "Content", - "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "source", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#synthetics:member", - "docComment": "/**\n * Synthetics properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly synthetics?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "synthetics", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#usr:member", - "docComment": "/**\n * User properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly usr?: " - }, - { - "kind": "Content", - "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "usr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#version:member", - "docComment": "/**\n * The version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties#view:member", - "docComment": "/**\n * View properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly view: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE:var", - "docComment": "/**\n * Get the action name from the attribute 'data-dd-action-name' on the element or any of its parent. It can also be retrieved from a user defined attribute.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE = " - }, - { - "kind": "Content", - "text": "\"data-dd-action-name\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/action/getActionNameFromElement.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!forEachChildNodes:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function forEachChildNodes(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ", callback: " - }, - { - "kind": "Content", - "text": "(child: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "callback", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "isOptional": false - } - ], - "name": "forEachChildNodes" - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!FORM_PRIVATE_TAG_NAMES:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FORM_PRIVATE_TAG_NAMES: " - }, - { - "kind": "Content", - "text": "{\n [tagName: string]: true;\n}" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "FORM_PRIVATE_TAG_NAMES", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!FrustrationType:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare const enum FrustrationType " - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "FrustrationType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!FrustrationType.DEAD_CLICK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DEAD_CLICK = " - }, - { - "kind": "Content", - "text": "\"dead_click\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DEAD_CLICK" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!FrustrationType.ERROR_CLICK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ERROR_CLICK = " - }, - { - "kind": "Content", - "text": "\"error_click\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ERROR_CLICK" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!FrustrationType.RAGE_CLICK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RAGE_CLICK = " - }, - { - "kind": "Content", - "text": "\"rage_click\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RAGE_CLICK" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getMutationObserverConstructor:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getMutationObserverConstructor(): " - }, - { - "kind": "Reference", - "text": "MutationObserverConstructor", - "canonicalReference": "@datadog/browser-rum-core!~MutationObserverConstructor:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/domMutationObservable.d.ts", - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getMutationObserverConstructor" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getNodePrivacyLevel:function(1)", - "docComment": "/**\n * Get node privacy level by iterating over its ancestors. When the direct parent privacy level is know, it is best to use something like:\n *\n * derivePrivacyLevelGivenParent(getNodeSelfPrivacyLevel(node), parentNodePrivacyLevel)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getNodePrivacyLevel(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ", defaultPrivacyLevel: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": ", cache?: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevelCache", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevelCache:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "defaultPrivacyLevel", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "cache", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "getNodePrivacyLevel" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getNodeSelfPrivacyLevel:function(1)", - "docComment": "/**\n * Determines the node's own privacy level without checking for ancestors.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getNodeSelfPrivacyLevel(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "getNodeSelfPrivacyLevel" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getParentNode:function(1)", - "docComment": "/**\n * Return `host` in case if the current node is a shadow root otherwise will return the `parentNode`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getParentNode(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "getParentNode" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getPrivacySelector:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getPrivacySelector(privacyLevel: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "privacyLevel", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "getPrivacySelector" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getScrollX:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getScrollX(): " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/scroll.d.ts", - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getScrollX" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getScrollY:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getScrollY(): " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/scroll.d.ts", - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getScrollY" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getSessionReplayUrl:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getSessionReplayUrl(configuration: " - }, - { - "kind": "Reference", - "text": "RumConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" - }, - { - "kind": "Content", - "text": ", { session, viewContext, errorType, }: " - }, - { - "kind": "Content", - "text": "{\n session?: " - }, - { - "kind": "Reference", - "text": "RumSession", - "canonicalReference": "@datadog/browser-rum-core!RumSession:type" - }, - { - "kind": "Content", - "text": ";\n viewContext?: " - }, - { - "kind": "Reference", - "text": "ViewHistoryEntry", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface" - }, - { - "kind": "Content", - "text": ";\n errorType?: string;\n}" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/getSessionReplayUrl.d.ts", - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "configuration", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "{ session, viewContext, errorType, }", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 8 - }, - "isOptional": false - } - ], - "name": "getSessionReplayUrl" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getTextContent:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getTextContent(textNode: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ", ignoreWhiteSpace: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ", parentNodePrivacyLevel: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "textNode", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "ignoreWhiteSpace", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "parentNodePrivacyLevel", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - } - ], - "name": "getTextContent" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!getViewportDimension:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function getViewportDimension(): " - }, - { - "kind": "Reference", - "text": "ViewportDimension", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getViewportDimension" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!hasChildNodes:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function hasChildNodes(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "hasChildNodes" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!initViewportObservable:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function initViewportObservable(configuration: " - }, - { - "kind": "Reference", - "text": "RumConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Observable", - "canonicalReference": "@datadog/browser-core!Observable:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ViewportDimension", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "configuration", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "initViewportObservable" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isCommentNode:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isCommentNode(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "node", - "canonicalReference": "@datadog/browser-rum-core!~node" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Comment", - "canonicalReference": "!Comment:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isCommentNode" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isElementNode:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isElementNode(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "node", - "canonicalReference": "@datadog/browser-rum-core!~node" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Element", - "canonicalReference": "!Element:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isElementNode" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isLongDataUrl:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isLongDataUrl(url: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "url", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isLongDataUrl" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isNodeShadowHost:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isNodeShadowHost(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "node", - "canonicalReference": "@datadog/browser-rum-core!~node" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Element", - "canonicalReference": "!Element:interface" - }, - { - "kind": "Content", - "text": " & {\n shadowRoot: " - }, - { - "kind": "Reference", - "text": "ShadowRoot", - "canonicalReference": "!ShadowRoot:interface" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 9 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isNodeShadowHost" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isNodeShadowRoot:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isNodeShadowRoot(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "node", - "canonicalReference": "@datadog/browser-rum-core!~node" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "ShadowRoot", - "canonicalReference": "!ShadowRoot:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isNodeShadowRoot" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!isTextNode:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isTextNode(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "node", - "canonicalReference": "@datadog/browser-rum-core!~node" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Text", - "canonicalReference": "!Text:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/htmlDomUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isTextNode" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type LifeCycle = " - }, - { - "kind": "Reference", - "text": "AbstractLifeCycle", - "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "LifeCycleEventMap", - "canonicalReference": "@datadog/browser-rum-core!~LifeCycleEventMap:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", - "releaseTag": "Public", - "name": "LifeCycle", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!LifeCycle:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LifeCycle: " - }, - { - "kind": "Content", - "text": "{\n new (): " - }, - { - "kind": "Reference", - "text": "AbstractLifeCycle", - "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "LifeCycleEventMap", - "canonicalReference": "@datadog/browser-rum-core!~LifeCycleEventMap:interface" - }, - { - "kind": "Content", - "text": ">;\n}" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "LifeCycle", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare const enum LifeCycleEventType " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", - "releaseTag": "Public", - "name": "LifeCycleEventType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.AFTER_VIEW_ENDED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "AFTER_VIEW_ENDED = " - }, - { - "kind": "Content", - "text": "6" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "AFTER_VIEW_ENDED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.AUTO_ACTION_COMPLETED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "AUTO_ACTION_COMPLETED = " - }, - { - "kind": "Content", - "text": "0" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "AUTO_ACTION_COMPLETED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.BEFORE_VIEW_CREATED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "BEFORE_VIEW_CREATED = " - }, - { - "kind": "Content", - "text": "1" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "BEFORE_VIEW_CREATED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.BEFORE_VIEW_UPDATED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "BEFORE_VIEW_UPDATED = " - }, - { - "kind": "Content", - "text": "3" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "BEFORE_VIEW_UPDATED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.PAGE_MAY_EXIT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PAGE_MAY_EXIT = " - }, - { - "kind": "Content", - "text": "11" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PAGE_MAY_EXIT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RAW_ERROR_COLLECTED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RAW_ERROR_COLLECTED = " - }, - { - "kind": "Content", - "text": "14" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RAW_ERROR_COLLECTED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RAW_RUM_EVENT_COLLECTED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RAW_RUM_EVENT_COLLECTED = " - }, - { - "kind": "Content", - "text": "12" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RAW_RUM_EVENT_COLLECTED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.REQUEST_COMPLETED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "REQUEST_COMPLETED = " - }, - { - "kind": "Content", - "text": "8" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "REQUEST_COMPLETED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.REQUEST_STARTED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "REQUEST_STARTED = " - }, - { - "kind": "Content", - "text": "7" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "REQUEST_STARTED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.RUM_EVENT_COLLECTED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RUM_EVENT_COLLECTED = " - }, - { - "kind": "Content", - "text": "13" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RUM_EVENT_COLLECTED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.SESSION_EXPIRED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "SESSION_EXPIRED = " - }, - { - "kind": "Content", - "text": "9" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "SESSION_EXPIRED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.SESSION_RENEWED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "SESSION_RENEWED = " - }, - { - "kind": "Content", - "text": "10" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "SESSION_RENEWED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_CREATED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VIEW_CREATED = " - }, - { - "kind": "Content", - "text": "2" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VIEW_CREATED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_ENDED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VIEW_ENDED = " - }, - { - "kind": "Content", - "text": "5" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VIEW_ENDED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!LifeCycleEventType.VIEW_UPDATED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VIEW_UPDATED = " - }, - { - "kind": "Content", - "text": "4" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VIEW_UPDATED" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!makeRumPublicApi:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function makeRumPublicApi(startRumImpl: " - }, - { - "kind": "Reference", - "text": "StartRum", - "canonicalReference": "@datadog/browser-rum-core!StartRum:type" - }, - { - "kind": "Content", - "text": ", recorderApi: " - }, - { - "kind": "Reference", - "text": "RecorderApi", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface" - }, - { - "kind": "Content", - "text": ", profilerApi: " - }, - { - "kind": "Reference", - "text": "ProfilerApi", - "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface" - }, - { - "kind": "Content", - "text": ", options?: " - }, - { - "kind": "Reference", - "text": "RumPublicApiOptions", - "canonicalReference": "@datadog/browser-rum-core!~RumPublicApiOptions:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "startRumImpl", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "recorderApi", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "profilerApi", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "name": "makeRumPublicApi" - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!MAX_ATTRIBUTE_VALUE_CHAR_LENGTH:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "MAX_ATTRIBUTE_VALUE_CHAR_LENGTH = " - }, - { - "kind": "Content", - "text": "24000" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "MAX_ATTRIBUTE_VALUE_CHAR_LENGTH", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!MouseEventOnElement:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type MouseEventOnElement = " - }, - { - "kind": "Reference", - "text": "PointerEvent", - "canonicalReference": "!PointerEvent:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ExtraPointerEventFields", - "canonicalReference": "@datadog/browser-rum-core!~ExtraPointerEventFields:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/action/listenActionEvents.d.ts", - "releaseTag": "Public", - "name": "MouseEventOnElement", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type NodePrivacyLevel = " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var" - }, - { - "kind": "Content", - "text": ")[keyof typeof " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var" - }, - { - "kind": "Content", - "text": "]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "releaseTag": "Public", - "name": "NodePrivacyLevel", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "NodePrivacyLevel: " - }, - { - "kind": "Content", - "text": "{\n readonly IGNORE: \"ignore\";\n readonly HIDDEN: \"hidden\";\n readonly ALLOW: \"allow\";\n readonly MASK: \"mask\";\n readonly MASK_USER_INPUT: \"mask-user-input\";\n}" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "NodePrivacyLevel", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevelCache:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type NodePrivacyLevelCache = " - }, - { - "kind": "Reference", - "text": "Map", - "canonicalReference": "!Map:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "releaseTag": "Public", - "name": "NodePrivacyLevelCache", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_NAME:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_ATTR_NAME = " - }, - { - "kind": "Content", - "text": "\"data-dd-privacy\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_ATTR_NAME", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_ALLOW:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_ATTR_VALUE_ALLOW = " - }, - { - "kind": "Content", - "text": "\"allow\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_ATTR_VALUE_ALLOW", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_HIDDEN:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_ATTR_VALUE_HIDDEN = " - }, - { - "kind": "Content", - "text": "\"hidden\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_ATTR_VALUE_HIDDEN", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_MASK_USER_INPUT:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_ATTR_VALUE_MASK_USER_INPUT = " - }, - { - "kind": "Content", - "text": "\"mask-user-input\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_ATTR_VALUE_MASK_USER_INPUT", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_ATTR_VALUE_MASK:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_ATTR_VALUE_MASK = " - }, - { - "kind": "Content", - "text": "\"mask\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_ATTR_VALUE_MASK", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!PRIVACY_CLASS_PREFIX:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVACY_CLASS_PREFIX = " - }, - { - "kind": "Content", - "text": "\"dd-privacy-\"" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "PRIVACY_CLASS_PREFIX", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ProfilerApi " - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "ProfilerApi", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ProfilerApi#onRumStart:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "onRumStart: " - }, - { - "kind": "Content", - "text": "(lifeCycle: " - }, - { - "kind": "Reference", - "text": "LifeCycle", - "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" - }, - { - "kind": "Content", - "text": ", configuration: " - }, - { - "kind": "Reference", - "text": "RumConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" - }, - { - "kind": "Content", - "text": ", sessionManager: " - }, - { - "kind": "Reference", - "text": "RumSessionManager", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" - }, - { - "kind": "Content", - "text": ", viewHistory: " - }, - { - "kind": "Reference", - "text": "ViewHistory", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "onRumStart", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ProfilerApi#stop:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "stop: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stop", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RawRumActionEvent " - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RawRumActionEvent", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#_dd:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "_dd?: " - }, - { - "kind": "Content", - "text": "{\n action?: {\n target?: {\n selector?: string;\n width?: number;\n height?: number;\n };\n name_source?: string;\n position?: {\n x: number;\n y: number;\n };\n pointer_up_delay?: " - }, - { - "kind": "Reference", - "text": "Duration", - "canonicalReference": "@datadog/browser-core!Duration:type" - }, - { - "kind": "Content", - "text": ";\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "_dd", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#action:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "action: " - }, - { - "kind": "Content", - "text": "{\n id: string;\n type: " - }, - { - "kind": "Reference", - "text": "ActionType", - "canonicalReference": "@datadog/browser-rum-core!ActionType:enum" - }, - { - "kind": "Content", - "text": ";\n loading_time?: " - }, - { - "kind": "Reference", - "text": "ServerDuration", - "canonicalReference": "@datadog/browser-core!ServerDuration:type" - }, - { - "kind": "Content", - "text": ";\n frustration?: {\n type: " - }, - { - "kind": "Reference", - "text": "FrustrationType", - "canonicalReference": "@datadog/browser-rum-core!FrustrationType:enum" - }, - { - "kind": "Content", - "text": "[];\n };\n error?: " - }, - { - "kind": "Reference", - "text": "Count", - "canonicalReference": "@datadog/browser-rum-core!~Count:interface" - }, - { - "kind": "Content", - "text": ";\n long_task?: " - }, - { - "kind": "Reference", - "text": "Count", - "canonicalReference": "@datadog/browser-rum-core!~Count:interface" - }, - { - "kind": "Content", - "text": ";\n resource?: " - }, - { - "kind": "Reference", - "text": "Count", - "canonicalReference": "@datadog/browser-rum-core!~Count:interface" - }, - { - "kind": "Content", - "text": ";\n target: {\n name: string;\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "action", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 14 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#date:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "date: " - }, - { - "kind": "Reference", - "text": "TimeStamp", - "canonicalReference": "@datadog/browser-core!TimeStamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "RumEventType.ACTION", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent#view:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "view?: " - }, - { - "kind": "Content", - "text": "{\n in_foreground: boolean;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RawRumEvent:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RawRumEvent = " - }, - { - "kind": "Reference", - "text": "RawRumErrorEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumErrorEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumResourceEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumResourceEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumViewEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumViewEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumLongTaskEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumLongTaskEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumLongAnimationFrameEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumLongAnimationFrameEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumActionEvent", - "canonicalReference": "@datadog/browser-rum-core!RawRumActionEvent:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RawRumVitalEvent", - "canonicalReference": "@datadog/browser-rum-core!~RawRumVitalEvent:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RawRumEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 14 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RawRumEventCollectedData " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/lifeCycle.d.ts", - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "E", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "RawRumEventCollectedData", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#customerContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "customerContext?: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "customerContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#domainContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "domainContext: " - }, - { - "kind": "Reference", - "text": "RumEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "domainContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#duration:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "duration?: " - }, - { - "kind": "Reference", - "text": "Duration", - "canonicalReference": "@datadog/browser-core!Duration:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "duration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#rawRumEvent:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "rawRumEvent: " - }, - { - "kind": "Content", - "text": "E" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "rawRumEvent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RawRumEventCollectedData#startTime:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startTime: " - }, - { - "kind": "Reference", - "text": "RelativeTime", - "canonicalReference": "@datadog/browser-core!RelativeTime:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startTime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RecorderApi " - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "RecorderApi", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#getReplayStats:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getReplayStats: " - }, - { - "kind": "Content", - "text": "(viewId: string) => " - }, - { - "kind": "Reference", - "text": "ReplayStats", - "canonicalReference": "@datadog/browser-rum-core!ReplayStats:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getReplayStats", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#getSessionReplayLink:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getSessionReplayLink: " - }, - { - "kind": "Content", - "text": "() => string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getSessionReplayLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#isRecording:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isRecording: " - }, - { - "kind": "Content", - "text": "() => boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#onRumStart:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "onRumStart: " - }, - { - "kind": "Content", - "text": "(lifeCycle: " - }, - { - "kind": "Reference", - "text": "LifeCycle", - "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" - }, - { - "kind": "Content", - "text": ", configuration: " - }, - { - "kind": "Reference", - "text": "RumConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" - }, - { - "kind": "Content", - "text": ", sessionManager: " - }, - { - "kind": "Reference", - "text": "RumSessionManager", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" - }, - { - "kind": "Content", - "text": ", viewHistory: " - }, - { - "kind": "Reference", - "text": "ViewHistory", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" - }, - { - "kind": "Content", - "text": ", deflateWorker: " - }, - { - "kind": "Reference", - "text": "DeflateWorker", - "canonicalReference": "@datadog/browser-core!DeflateWorker:interface" - }, - { - "kind": "Content", - "text": " | undefined) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "onRumStart", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 12 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#start:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "start: " - }, - { - "kind": "Content", - "text": "(options?: " - }, - { - "kind": "Reference", - "text": "StartRecordingOptions", - "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "start", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi#stop:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "stop: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stop", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!reducePrivacyLevel:function(1)", - "docComment": "/**\n * Reduces the next privacy level based on self + parent privacy levels\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function reducePrivacyLevel(childPrivacyLevel: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ", parentNodePrivacyLevel: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "childPrivacyLevel", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - }, - { - "parameterName": "parentNodePrivacyLevel", - "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "isOptional": false - } - ], - "name": "reducePrivacyLevel" - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ReplayStats:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ReplayStats " - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "ReplayStats", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ReplayStats#records_count:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "records_count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "records_count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ReplayStats#segments_count:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "segments_count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "segments_count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ReplayStats#segments_total_raw_size:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "segments_total_raw_size: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "segments_total_raw_size", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumActionEvent:type", - "docComment": "/**\n * Schema of all properties of an Action event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumActionEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumActionEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext#events:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "events?: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "!Event:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "events", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumConfiguration extends " - }, - { - "kind": "Reference", - "text": "Configuration", - "canonicalReference": "@datadog/browser-core!Configuration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/configuration/configuration.d.ts", - "releaseTag": "Public", - "name": "RumConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#actionNameAttribute:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "actionNameAttribute: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "actionNameAttribute", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#allowedTracingUrls:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "allowedTracingUrls: " - }, - { - "kind": "Reference", - "text": "TracingOption", - "canonicalReference": "@datadog/browser-rum-core!~TracingOption:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "allowedTracingUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#applicationId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "applicationId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "applicationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#compressIntakeRequests:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "compressIntakeRequests: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "compressIntakeRequests", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#customerDataTelemetrySampleRate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "customerDataTelemetrySampleRate: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "customerDataTelemetrySampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#defaultPrivacyLevel:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "defaultPrivacyLevel: " - }, - { - "kind": "Reference", - "text": "DefaultPrivacyLevel", - "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "defaultPrivacyLevel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#enablePrivacyForActionName:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "enablePrivacyForActionName: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "enablePrivacyForActionName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#excludedActivityUrls:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "excludedActivityUrls: " - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "excludedActivityUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#plugins:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "plugins: " - }, - { - "kind": "Reference", - "text": "RumPlugin", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "plugins", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#profilingSampleRate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "profilingSampleRate: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "profilingSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#propagateTraceBaggage:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "propagateTraceBaggage: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "propagateTraceBaggage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#rulePsr:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "rulePsr: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "rulePsr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#sessionReplaySampleRate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "sessionReplaySampleRate: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "sessionReplaySampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#startSessionReplayRecordingManually:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecordingManually: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startSessionReplayRecordingManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#subdomain:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "subdomain?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "subdomain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#traceContextInjection:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceContextInjection: " - }, - { - "kind": "Reference", - "text": "TraceContextInjection", - "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "traceContextInjection", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#traceSampleRate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceSampleRate: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "traceSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackFeatureFlagsForEvents:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackFeatureFlagsForEvents: " - }, - { - "kind": "Reference", - "text": "FeatureFlagsForEvents", - "canonicalReference": "@datadog/browser-rum-core!~FeatureFlagsForEvents:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "trackFeatureFlagsForEvents", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackLongTasks:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackLongTasks: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "trackLongTasks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackResources:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackResources: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "trackResources", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackUserInteractions:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackUserInteractions: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "trackUserInteractions", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#trackViewsManually:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackViewsManually: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "trackViewsManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#version:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration#workerUrl:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "workerUrl: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "workerUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEvent:type", - "docComment": "/**\n * Schema of all properties of an Error event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumErrorEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumErrorEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumEvent:type", - "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEvent = " - }, - { - "kind": "Reference", - "text": "RumActionEvent", - "canonicalReference": "@datadog/browser-rum-core!RumActionEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumErrorEvent", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumLongTaskEvent", - "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumResourceEvent", - "canonicalReference": "@datadog/browser-rum-core!RumResourceEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumViewEvent", - "canonicalReference": "@datadog/browser-rum-core!RumViewEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumVitalEvent", - "canonicalReference": "@datadog/browser-rum-core!RumVitalEvent:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 12 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEventDomainContext = " - }, - { - "kind": "Content", - "text": "T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VIEW", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.VIEW:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumViewEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ACTION", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumActionEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumActionEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.RESOURCE", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.RESOURCE:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumFetchResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumXhrResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumOtherResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ERROR", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.ERROR:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumErrorEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumErrorEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.LONG_TASK", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.LONG_TASK:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumLongTaskEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VITAL", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.VITAL:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumVitalEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!~RumVitalEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : never" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumEventDomainContext", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 34 - } - }, - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!RumEventType:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare const enum RumEventType " - } - ], - "fileUrlPath": "packages/rum-core/esm/rawRumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumEventType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.ACTION:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ACTION = " - }, - { - "kind": "Content", - "text": "\"action\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ACTION" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.ERROR:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ERROR = " - }, - { - "kind": "Content", - "text": "\"error\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ERROR" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.LONG_TASK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LONG_TASK = " - }, - { - "kind": "Content", - "text": "\"long_task\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "LONG_TASK" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.RESOURCE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RESOURCE = " - }, - { - "kind": "Content", - "text": "\"resource\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RESOURCE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.VIEW:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VIEW = " - }, - { - "kind": "Content", - "text": "\"view\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VIEW" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumEventType.VITAL:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VITAL = " - }, - { - "kind": "Content", - "text": "\"vital\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VITAL" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumFetchResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumFetchResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#requestInit:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInit?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "requestInit", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#requestInput:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInput: " - }, - { - "kind": "Reference", - "text": "RequestInfo", - "canonicalReference": "!RequestInfo:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "requestInput", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumFetchResourceEventDomainContext#response:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "response?: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "!Response:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "response", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumInitConfiguration extends " - }, - { - "kind": "Reference", - "text": "InitConfiguration", - "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/configuration/configuration.d.ts", - "releaseTag": "Public", - "name": "RumInitConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#actionNameAttribute:member", - "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "actionNameAttribute?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "actionNameAttribute", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#allowedTracingUrls:member", - "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "allowedTracingUrls?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "TracingOption", - "canonicalReference": "@datadog/browser-rum-core!~TracingOption:type" - }, - { - "kind": "Content", - "text": "> | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "allowedTracingUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#applicationId:member", - "docComment": "/**\n * The RUM application ID.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "applicationId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "applicationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#beforeSend:member", - "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "beforeSend?: " - }, - { - "kind": "Content", - "text": "((event: " - }, - { - "kind": "Reference", - "text": "RumEvent", - "canonicalReference": "@datadog/browser-rum-core!RumEvent:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "RumEventDomainContext", - "canonicalReference": "@datadog/browser-rum-core!RumEventDomainContext:type" - }, - { - "kind": "Content", - "text": ") => boolean) | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "beforeSend", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#compressIntakeRequests:member", - "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "compressIntakeRequests?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "compressIntakeRequests", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#defaultPrivacyLevel:member", - "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "defaultPrivacyLevel?: " - }, - { - "kind": "Reference", - "text": "DefaultPrivacyLevel", - "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "defaultPrivacyLevel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#enablePrivacyForActionName:member", - "docComment": "/**\n * Enables privacy control for action names.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "enablePrivacyForActionName?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "enablePrivacyForActionName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#excludedActivityUrls:member", - "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "excludedActivityUrls?: " - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "excludedActivityUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#plugins:member", - "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "plugins?: " - }, - { - "kind": "Reference", - "text": "RumPlugin", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "plugins", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#profilingSampleRate:member", - "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "profilingSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "profilingSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#propagateTraceBaggage:member", - "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "propagateTraceBaggage?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "propagateTraceBaggage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#remoteConfigurationId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "remoteConfigurationId?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "remoteConfigurationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#sessionReplaySampleRate:member", - "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "sessionReplaySampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "sessionReplaySampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#startSessionReplayRecordingManually:member", - "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecordingManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "startSessionReplayRecordingManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#subdomain:member", - "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "subdomain?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "subdomain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#traceContextInjection:member", - "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceContextInjection?: " - }, - { - "kind": "Reference", - "text": "TraceContextInjection", - "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceContextInjection", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#traceSampleRate:member", - "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackFeatureFlagsForEvents:member", - "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackFeatureFlagsForEvents?: " - }, - { - "kind": "Reference", - "text": "FeatureFlagsForEvents", - "canonicalReference": "@datadog/browser-rum-core!~FeatureFlagsForEvents:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackFeatureFlagsForEvents", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackLongTasks:member", - "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackLongTasks?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackLongTasks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackResources:member", - "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackResources?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackResources", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackUserInteractions:member", - "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackUserInteractions?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackUserInteractions", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#trackViewsManually:member", - "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackViewsManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackViewsManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration#workerUrl:member", - "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "workerUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "workerUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEvent:type", - "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumLongTaskEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumLongTaskEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumLongTaskEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumOtherResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumOtherResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumOtherResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare enum RumPerformanceEntryType " - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/performanceObservable.d.ts", - "releaseTag": "Public", - "name": "RumPerformanceEntryType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.EVENT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "EVENT = " - }, - { - "kind": "Content", - "text": "\"event\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "EVENT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.FIRST_INPUT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FIRST_INPUT = " - }, - { - "kind": "Content", - "text": "\"first-input\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FIRST_INPUT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LARGEST_CONTENTFUL_PAINT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LARGEST_CONTENTFUL_PAINT = " - }, - { - "kind": "Content", - "text": "\"largest-contentful-paint\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "LARGEST_CONTENTFUL_PAINT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LAYOUT_SHIFT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LAYOUT_SHIFT = " - }, - { - "kind": "Content", - "text": "\"layout-shift\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "LAYOUT_SHIFT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LONG_ANIMATION_FRAME:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LONG_ANIMATION_FRAME = " - }, - { - "kind": "Content", - "text": "\"long-animation-frame\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "LONG_ANIMATION_FRAME" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.LONG_TASK:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "LONG_TASK = " - }, - { - "kind": "Content", - "text": "\"longtask\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "LONG_TASK" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.NAVIGATION:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "NAVIGATION = " - }, - { - "kind": "Content", - "text": "\"navigation\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "NAVIGATION" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.PAINT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PAINT = " - }, - { - "kind": "Content", - "text": "\"paint\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PAINT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.RESOURCE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "RESOURCE = " - }, - { - "kind": "Content", - "text": "\"resource\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RESOURCE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType.VISIBILITY_STATE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VISIBILITY_STATE = " - }, - { - "kind": "Content", - "text": "\"visibility-state\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VISIBILITY_STATE" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumPlugin " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/plugins.d.ts", - "releaseTag": "Public", - "name": "RumPlugin", - "preserveMemberOrder": false, - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin#getConfigurationTelemetry:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getConfigurationTelemetry?(): " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getConfigurationTelemetry" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin#name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin#onInit:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "onInit?(options: " - }, - { - "kind": "Content", - "text": "{\n initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ";\n publicApi: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isOptional": false - } - ], - "name": "onInit" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum-core!RumPlugin#onRumStart:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "onRumStart?(options: " - }, - { - "kind": "Content", - "text": "{\n strategy: " - }, - { - "kind": "Reference", - "text": "Strategy", - "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": true, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isOptional": false - } - ], - "name": "onRumStart" - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumPublicApi extends " - }, - { - "kind": "Reference", - "text": "PublicApi", - "canonicalReference": "@datadog/browser-core!PublicApi:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "RumPublicApi", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addAction:member", - "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addAction: " - }, - { - "kind": "Content", - "text": "(name: string, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addAction", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addDurationVital:member", - "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addError:member", - "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addError: " - }, - { - "kind": "Content", - "text": "(error: unknown, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addFeatureFlagEvaluation:member", - "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addFeatureFlagEvaluation: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addFeatureFlagEvaluation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#addTiming:member", - "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addTiming: " - }, - { - "kind": "Content", - "text": "(name: string, time?: number) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addTiming", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearAccount:member", - "docComment": "/**\n * Clear all account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearAccount: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearGlobalContext:member", - "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearGlobalContext: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#clearUser:member", - "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearUser: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getAccount:member", - "docComment": "/**\n * Get account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAccount: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getGlobalContext:member", - "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getGlobalContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getInitConfiguration:member", - "docComment": "/**\n * Get the init configuration\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInitConfiguration: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInitConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getInternalContext:member", - "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Content", - "text": "(startTime?: number) => " - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-rum-core!~InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getSessionReplayLink:member", - "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getSessionReplayLink: " - }, - { - "kind": "Content", - "text": "() => string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getSessionReplayLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getUser:member", - "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getUser: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#getViewContext:member", - "docComment": "/**\n * Get View Context.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getViewContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#init:member", - "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeAccountProperty:member", - "docComment": "/**\n * Remove an account property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeGlobalContextProperty:member", - "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#removeUserProperty:member", - "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setAccount:member", - "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccount: " - }, - { - "kind": "Content", - "text": "(newAccount: " - }, - { - "kind": "Reference", - "text": "Account", - "canonicalReference": "@datadog/browser-core!Account:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setAccountProperty:member", - "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setGlobalContext:member", - "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContext: " - }, - { - "kind": "Content", - "text": "(context: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setGlobalContextProperty:member", - "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setTrackingConsent:member", - "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTrackingConsent: " - }, - { - "kind": "Content", - "text": "(trackingConsent: " - }, - { - "kind": "Reference", - "text": "TrackingConsent", - "canonicalReference": "@datadog/browser-core!TrackingConsent:type" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setTrackingConsent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUser:member(1)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": " & {\n id: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUser:member(2)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setUserProperty:member", - "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewContext:member", - "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContext: " - }, - { - "kind": "Content", - "text": "(context: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewContextProperty:member", - "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContextProperty: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#setViewName:member", - "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewName: " - }, - { - "kind": "Content", - "text": "(name: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startDurationVital:member", - "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startSessionReplayRecording:member", - "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "(options?: " - }, - { - "kind": "Reference", - "text": "StartRecordingOptions", - "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#startView:member", - "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startView: " - }, - { - "kind": "Content", - "text": "{\n (name?: string): void;\n (options: " - }, - { - "kind": "Reference", - "text": "ViewOptions", - "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" - }, - { - "kind": "Content", - "text": "): void;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startView", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopDurationVital:member", - "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopDurationVital: " - }, - { - "kind": "Content", - "text": "(nameOrRef: string | " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopSession:member", - "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSession: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSession", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi#stopSessionReplayRecording:member", - "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumResourceEvent:type", - "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumResourceEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum-core!~ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumResourceEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumSession:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumSession = " - }, - { - "kind": "Content", - "text": "{\n id: string;\n sessionReplay: " - }, - { - "kind": "Reference", - "text": "SessionReplayState", - "canonicalReference": "@datadog/browser-rum-core!SessionReplayState:enum" - }, - { - "kind": "Content", - "text": ";\n anonymousId?: string;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", - "releaseTag": "Public", - "name": "RumSession", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumSessionManager " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", - "releaseTag": "Public", - "name": "RumSessionManager", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#expire:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expire: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "expire", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#expireObservable:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expireObservable: " - }, - { - "kind": "Reference", - "text": "Observable", - "canonicalReference": "@datadog/browser-core!Observable:class" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "expireObservable", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#findTrackedSession:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "findTrackedSession: " - }, - { - "kind": "Content", - "text": "(startTime?: " - }, - { - "kind": "Reference", - "text": "RelativeTime", - "canonicalReference": "@datadog/browser-core!RelativeTime:type" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "RumSession", - "canonicalReference": "@datadog/browser-rum-core!RumSession:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "findTrackedSession", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager#setForcedReplay:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setForcedReplay: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setForcedReplay", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumViewEvent:type", - "docComment": "/**\n * Schema of all properties of a View event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumViewEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n flutter_raster_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n js_refresh_rate?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum-core!~RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n performance?: " - }, - { - "kind": "Reference", - "text": "ViewPerformanceData", - "canonicalReference": "@datadog/browser-rum-core!~ViewPerformanceData:interface" - }, - { - "kind": "Content", - "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 13 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumViewEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumViewEventDomainContext#location:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "location: " - }, - { - "kind": "Reference", - "text": "Readonly", - "canonicalReference": "!Readonly:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Location", - "canonicalReference": "!Location:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "location", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!RumVitalEvent:type", - "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumVitalEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum-core!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum-core!~ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumVitalEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumXhrResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumXhrResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!RumXhrResourceEventDomainContext#xhr:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "xhr: " - }, - { - "kind": "Reference", - "text": "XMLHttpRequest", - "canonicalReference": "!XMLHttpRequest:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "xhr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!sanitizeDataUrl:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function sanitizeDataUrl(url: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/resource/resourceUtils.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "url", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "sanitizeDataUrl" - }, - { - "kind": "Enum", - "canonicalReference": "@datadog/browser-rum-core!SessionReplayState:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare const enum SessionReplayState " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/rumSessionManager.d.ts", - "releaseTag": "Public", - "name": "SessionReplayState", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.FORCED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FORCED = " - }, - { - "kind": "Content", - "text": "2" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FORCED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.OFF:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "OFF = " - }, - { - "kind": "Content", - "text": "0" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "OFF" - }, - { - "kind": "EnumMember", - "canonicalReference": "@datadog/browser-rum-core!SessionReplayState.SAMPLED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "SAMPLED = " - }, - { - "kind": "Content", - "text": "1" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "SAMPLED" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!shouldIgnoreElement:function(1)", - "docComment": "/**\n * TODO: Preserve CSS element order, and record the presence of the tag, just don't render We don't need this logic on the recorder side. For security related meta's, customer can mask themmanually given they are easy to identify in the HEAD tag.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function shouldIgnoreElement(element: " - }, - { - "kind": "Reference", - "text": "Element", - "canonicalReference": "!Element:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "element", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "shouldIgnoreElement" - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!shouldMaskNode:function(1)", - "docComment": "/**\n * Helper aiming to unify `mask` and `mask-user-input` privacy levels:\n *\n * In the `mask` case, it is trivial: we should mask the element.\n *\n * In the `mask-user-input` case, we should mask the element only if it is a \"form\" element or the direct parent is a form element for text nodes).\n *\n * Other `shouldMaskNode` cases are edge cases that should not matter too much (ex: should we mask a node if it is ignored or hidden? it doesn't matter since it won't be serialized).\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function shouldMaskNode(node: " - }, - { - "kind": "Reference", - "text": "Node", - "canonicalReference": "!Node:interface" - }, - { - "kind": "Content", - "text": ", privacyLevel: " - }, - { - "kind": "Reference", - "text": "NodePrivacyLevel", - "canonicalReference": "@datadog/browser-rum-core!NodePrivacyLevel:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/privacy.d.ts", - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "node", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "privacyLevel", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "name": "shouldMaskNode" - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-core!STABLE_ATTRIBUTES:var", - "docComment": "/**\n * Stable attributes are attributes that are commonly used to identify parts of a UI (ex: component). Those attribute values should not be generated randomly (hardcoded most of the time) and stay the same across deploys. They are not necessarily unique across the document.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "STABLE_ATTRIBUTES: " - }, - { - "kind": "Content", - "text": "string[]" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/getSelectorFromElement.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "STABLE_ATTRIBUTES", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface StartRecordingOptions " - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "StartRecordingOptions", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!StartRecordingOptions#force:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "force: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "force", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!startRum:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function startRum(configuration: " - }, - { - "kind": "Reference", - "text": "RumConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumConfiguration:interface" - }, - { - "kind": "Content", - "text": ", recorderApi: " - }, - { - "kind": "Reference", - "text": "RecorderApi", - "canonicalReference": "@datadog/browser-rum-core!RecorderApi:interface" - }, - { - "kind": "Content", - "text": ", profilerApi: " - }, - { - "kind": "Reference", - "text": "ProfilerApi", - "canonicalReference": "@datadog/browser-rum-core!ProfilerApi:interface" - }, - { - "kind": "Content", - "text": ", initialViewOptions: " - }, - { - "kind": "Reference", - "text": "ViewOptions", - "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ", createEncoder: " - }, - { - "kind": "Content", - "text": "(streamId: " - }, - { - "kind": "Reference", - "text": "DeflateEncoderStreamId", - "canonicalReference": "@datadog/browser-core!DeflateEncoderStreamId:enum" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "Encoder", - "canonicalReference": "@datadog/browser-core!Encoder:interface" - }, - { - "kind": "Content", - "text": ", trackingConsentState: " - }, - { - "kind": "Reference", - "text": "TrackingConsentState", - "canonicalReference": "@datadog/browser-core!TrackingConsentState:interface" - }, - { - "kind": "Content", - "text": ", customVitalsState: " - }, - { - "kind": "Reference", - "text": "CustomVitalsState", - "canonicalReference": "@datadog/browser-rum-core!~CustomVitalsState:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "{\n addAction: (action: import(\"../domain/action/actionCollection\")." - }, - { - "kind": "Reference", - "text": "CustomAction", - "canonicalReference": "@datadog/browser-rum-core!~CustomAction:interface" - }, - { - "kind": "Content", - "text": ") => void;\n addError: ({ error, handlingStack, componentStack, startClocks, " - }, - { - "kind": "Reference", - "text": "context", - "canonicalReference": "@datadog/browser-rum-core!~ProvidedError#context" - }, - { - "kind": "Content", - "text": ": customerContext }: import(\"../domain/error/errorCollection\")." - }, - { - "kind": "Reference", - "text": "ProvidedError", - "canonicalReference": "@datadog/browser-rum-core!~ProvidedError:interface" - }, - { - "kind": "Content", - "text": ") => void;\n addTiming: (name: string, time?: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "RelativeTime", - "canonicalReference": "@datadog/browser-core!RelativeTime:type" - }, - { - "kind": "Content", - "text": " | import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "TimeStamp", - "canonicalReference": "@datadog/browser-core!TimeStamp:type" - }, - { - "kind": "Content", - "text": ") => void;\n addFeatureFlagEvaluation: (key: string, value: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "ContextValue", - "canonicalReference": "@datadog/browser-core!ContextValue:type" - }, - { - "kind": "Content", - "text": ") => void;\n startView: (options?: " - }, - { - "kind": "Reference", - "text": "ViewOptions", - "canonicalReference": "@datadog/browser-rum-core!~ViewOptions:interface" - }, - { - "kind": "Content", - "text": ", startClocks?: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "ClocksState", - "canonicalReference": "@datadog/browser-core!ClocksState:type" - }, - { - "kind": "Content", - "text": ") => void;\n setViewContext: (context: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ") => void;\n setViewContextProperty: (key: string, value: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "ContextValue", - "canonicalReference": "@datadog/browser-core!ContextValue:type" - }, - { - "kind": "Content", - "text": ") => void;\n getViewContext: () => import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";\n setViewName: (name: string) => void;\n lifeCycle: import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "AbstractLifeCycle", - "canonicalReference": "@datadog/browser-core!AbstractLifeCycle:class" - }, - { - "kind": "Content", - "text": ";\n viewHistory: import(\"../domain/contexts/viewHistory\")." - }, - { - "kind": "Reference", - "text": "ViewHistory", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" - }, - { - "kind": "Content", - "text": ";\n session: import(\"../domain/rumSessionManager\")." - }, - { - "kind": "Reference", - "text": "RumSessionManager", - "canonicalReference": "@datadog/browser-rum-core!RumSessionManager:interface" - }, - { - "kind": "Content", - "text": ";\n stopSession: () => void;\n getInternalContext: (startTime?: number) => import(\"../domain/contexts/internalContext\")." - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-rum-core!~InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined;\n startDurationVital: (name: string, options?: import(\"../domain/vital/vitalCollection\")." - }, - { - "kind": "Reference", - "text": "DurationVitalOptions", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalOptions:interface" - }, - { - "kind": "Content", - "text": ") => import(\"../domain/vital/vitalCollection\")." - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ";\n stopDurationVital: (nameOrRef: string | import(\"../domain/vital/vitalCollection\")." - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ", options?: import(\"../domain/vital/vitalCollection\")." - }, - { - "kind": "Reference", - "text": "DurationVitalOptions", - "canonicalReference": "@datadog/browser-rum-core!~DurationVitalOptions:interface" - }, - { - "kind": "Content", - "text": ") => void;\n addDurationVital: (vital: import(\"../domain/vital/vitalCollection\")." - }, - { - "kind": "Reference", - "text": "DurationVital", - "canonicalReference": "@datadog/browser-rum-core!~DurationVital:interface" - }, - { - "kind": "Content", - "text": ") => void;\n globalContext: {\n getContext: () => import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " - }, - { - "kind": "Reference", - "text": "Observable", - "canonicalReference": "@datadog/browser-core!Observable:class" - }, - { - "kind": "Content", - "text": ";\n };\n userContext: {\n getContext: () => import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " - }, - { - "kind": "Reference", - "text": "Observable", - "canonicalReference": "@datadog/browser-core!Observable:class" - }, - { - "kind": "Content", - "text": ";\n };\n accountContext: {\n getContext: () => import(\"@datadog/browser-core\")." - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";\n setContext: (newContext: unknown) => void;\n setContextProperty: (key: string, property: any) => void;\n removeContextProperty: (key: string) => void;\n clearContext: () => void;\n changeObservable: " - }, - { - "kind": "Reference", - "text": "Observable", - "canonicalReference": "@datadog/browser-core!Observable:class" - }, - { - "kind": "Content", - "text": ";\n };\n stop: () => void;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/startRum.d.ts", - "returnTypeTokenRange": { - "startIndex": 19, - "endIndex": 74 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "configuration", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "recorderApi", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "profilerApi", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "initialViewOptions", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 9 - }, - "isOptional": false - }, - { - "parameterName": "createEncoder", - "parameterTypeTokenRange": { - "startIndex": 10, - "endIndex": 14 - }, - "isOptional": false - }, - { - "parameterName": "trackingConsentState", - "parameterTypeTokenRange": { - "startIndex": 15, - "endIndex": 16 - }, - "isOptional": false - }, - { - "parameterName": "customVitalsState", - "parameterTypeTokenRange": { - "startIndex": 17, - "endIndex": 18 - }, - "isOptional": false - } - ], - "name": "startRum" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum-core!StartRum:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type StartRum = " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "startRum", - "canonicalReference": "@datadog/browser-rum-core!startRum:function" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/startRum.d.ts", - "releaseTag": "Public", - "name": "StartRum", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!startViewHistory:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function startViewHistory(lifeCycle: " - }, - { - "kind": "Reference", - "text": "LifeCycle", - "canonicalReference": "@datadog/browser-rum-core!LifeCycle:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ViewHistory", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "lifeCycle", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "startViewHistory" - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!Strategy:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Strategy " - } - ], - "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "Strategy", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#accountContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "accountContext: " - }, - { - "kind": "Reference", - "text": "ContextManager", - "canonicalReference": "@datadog/browser-core!ContextManager:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "accountContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#addAction:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addAction: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['addAction']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addAction", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#addDurationVital:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addDurationVital: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['addDurationVital']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#addError:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addError: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['addError']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#addFeatureFlagEvaluation:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addFeatureFlagEvaluation: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['addFeatureFlagEvaluation']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addFeatureFlagEvaluation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#addTiming:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addTiming: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['addTiming']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addTiming", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#getInternalContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['getInternalContext']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#getViewContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getViewContext: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['getViewContext']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#globalContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "globalContext: " - }, - { - "kind": "Reference", - "text": "ContextManager", - "canonicalReference": "@datadog/browser-core!ContextManager:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "globalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#init:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ", publicApi: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#initConfiguration:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "initConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContext: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['setViewContext']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewContextProperty:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContextProperty: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['setViewContextProperty']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#setViewName:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewName: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['setViewName']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#startDurationVital:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startDurationVital: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['startDurationVital']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#startView:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startView: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['startView']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startView", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#stopDurationVital:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopDurationVital: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['stopDurationVital']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#stopSession:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSession: " - }, - { - "kind": "Reference", - "text": "StartRumResult", - "canonicalReference": "@datadog/browser-rum-core!~StartRumResult:type" - }, - { - "kind": "Content", - "text": "['stopSession']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSession", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!Strategy#userContext:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "userContext: " - }, - { - "kind": "Reference", - "text": "ContextManager", - "canonicalReference": "@datadog/browser-core!ContextManager:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "userContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-core!supportPerformanceTimingEvent:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function supportPerformanceTimingEvent(entryType: " - }, - { - "kind": "Reference", - "text": "RumPerformanceEntryType", - "canonicalReference": "@datadog/browser-rum-core!RumPerformanceEntryType:enum" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/performanceObservable.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "entryType", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "supportPerformanceTimingEvent" - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ViewCreatedEvent " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/view/trackViews.d.ts", - "releaseTag": "Public", - "name": "ViewCreatedEvent", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#service:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#startClocks:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startClocks: " - }, - { - "kind": "Reference", - "text": "ClocksState", - "canonicalReference": "@datadog/browser-core!ClocksState:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startClocks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewCreatedEvent#version:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ViewHistory " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", - "releaseTag": "Public", - "name": "ViewHistory", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory#findView:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "findView: " - }, - { - "kind": "Content", - "text": "(startTime?: " - }, - { - "kind": "Reference", - "text": "RelativeTime", - "canonicalReference": "@datadog/browser-core!RelativeTime:type" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "ViewHistoryEntry", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "findView", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistory#stop:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "stop: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stop", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ViewHistoryEntry " - } - ], - "fileUrlPath": "packages/rum-core/esm/domain/contexts/viewHistory.d.ts", - "releaseTag": "Public", - "name": "ViewHistoryEntry", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#service:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#sessionIsActive:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "sessionIsActive?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "sessionIsActive", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#startClocks:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "startClocks: " - }, - { - "kind": "Reference", - "text": "ClocksState", - "canonicalReference": "@datadog/browser-core!ClocksState:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startClocks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewHistoryEntry#version:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ViewportDimension " - } - ], - "fileUrlPath": "packages/rum-core/esm/browser/viewportObservable.d.ts", - "releaseTag": "Public", - "name": "ViewportDimension", - "preserveMemberOrder": false, - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension#height:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "height: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "height", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum-core!ViewportDimension#width:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "width: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "width", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - } - ] - } - ] -} diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index dc3519f0d5..f36409f11a 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -172,6 +172,581 @@ "name": "", "preserveMemberOrder": false, "members": [ + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface", + "docComment": "/**\n * Schema of common properties of RUM events\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CommonProperties " + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "CommonProperties", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#_dd:member", + "docComment": "/**\n * Internal properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly _dd: " + }, + { + "kind": "Content", + "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "_dd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#account:member", + "docComment": "/**\n * Account properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly account?: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "account", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#application:member", + "docComment": "/**\n * Application properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly application: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_id:member", + "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_version:member", + "docComment": "/**\n * The build version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#ci_test:member", + "docComment": "/**\n * CI Visibility properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly ci_test?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "ci_test", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#connectivity:member", + "docComment": "/**\n * Device connectivity properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "connectivity?: " + }, + { + "kind": "Content", + "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "connectivity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#context:member", + "docComment": "/**\n * User provided context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "{\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#date:member", + "docComment": "/**\n * Start of the event in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#device:member", + "docComment": "/**\n * Device properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "device?: " + }, + { + "kind": "Content", + "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "device", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#display:member", + "docComment": "/**\n * Display properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "display?: " + }, + { + "kind": "Content", + "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "display", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#os:member", + "docComment": "/**\n * Operating system properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "os?: " + }, + { + "kind": "Content", + "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "os", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#service:member", + "docComment": "/**\n * The service name for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly session: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#source:member", + "docComment": "/**\n * The source of this event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly source?: " + }, + { + "kind": "Content", + "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "source", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#synthetics:member", + "docComment": "/**\n * Synthetics properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly synthetics?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "synthetics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#usr:member", + "docComment": "/**\n * User properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly usr?: " + }, + { + "kind": "Content", + "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "usr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#version:member", + "docComment": "/**\n * The version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly view: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, { "kind": "Variable", "canonicalReference": "@datadog/browser-rum!datadogRum:var", @@ -184,7 +759,7 @@ { "kind": "Reference", "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface" } ], "fileUrlPath": "packages/rum/esm/entries/main.d.ts", @@ -195,6 +770,3101 @@ "startIndex": 1, "endIndex": 2 } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type", + "docComment": "/**\n * Schema of all properties of an Action event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumActionEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumActionEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "events?: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "!Event:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "events", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type", + "docComment": "/**\n * Schema of all properties of an Error event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumErrorEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumErrorEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEvent:type", + "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEvent = " + }, + { + "kind": "Reference", + "text": "RumActionEvent", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumErrorEvent", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumLongTaskEvent", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumResourceEvent", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumViewEvent", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumVitalEvent", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VIEW", + "canonicalReference": "@datadog/browser-rum!RumEventType.VIEW:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumViewEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ACTION", + "canonicalReference": "@datadog/browser-rum!RumEventType.ACTION:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumActionEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.RESOURCE", + "canonicalReference": "@datadog/browser-rum!RumEventType.RESOURCE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumFetchResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumXhrResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumOtherResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ERROR", + "canonicalReference": "@datadog/browser-rum!RumEventType.ERROR:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumErrorEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.LONG_TASK", + "canonicalReference": "@datadog/browser-rum!RumEventType.LONG_TASK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumLongTaskEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VITAL", + "canonicalReference": "@datadog/browser-rum!RumEventType.VITAL:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumVitalEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 34 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumFetchResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumFetchResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInit?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "requestInit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInput: " + }, + { + "kind": "Reference", + "text": "RequestInfo", + "canonicalReference": "!RequestInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "requestInput", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "response?: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "response", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "RumGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addAction:member", + "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addAction: " + }, + { + "kind": "Content", + "text": "(name: string, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addDurationVital:member", + "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addError:member", + "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addError: " + }, + { + "kind": "Content", + "text": "(error: unknown, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addFeatureFlagEvaluation:member", + "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addFeatureFlagEvaluation: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addFeatureFlagEvaluation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addTiming:member", + "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addTiming: " + }, + { + "kind": "Content", + "text": "(name: string, time?: number) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addTiming", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-rum!InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getSessionReplayLink:member", + "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSessionReplayLink: " + }, + { + "kind": "Content", + "text": "() => string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getSessionReplayLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getViewContext:member", + "docComment": "/**\n * Get View Context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getViewContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#init:member", + "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContext:member", + "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContext: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContextProperty:member", + "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContextProperty: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewName:member", + "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewName: " + }, + { + "kind": "Content", + "text": "(name: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startDurationVital:member", + "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startSessionReplayRecording:member", + "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "(options?: " + }, + { + "kind": "Reference", + "text": "StartRecordingOptions", + "canonicalReference": "@datadog/browser-rum!StartRecordingOptions:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", + "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startView: " + }, + { + "kind": "Content", + "text": "{\n (name?: string): void;\n (options: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum!ViewOptions:interface" + }, + { + "kind": "Content", + "text": "): void;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopDurationVital:member", + "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopDurationVital: " + }, + { + "kind": "Content", + "text": "(nameOrRef: string | " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSession:member", + "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSession: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSessionReplayRecording:member", + "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", + "releaseTag": "Public", + "name": "RumInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#actionNameAttribute:member", + "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionNameAttribute?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "actionNameAttribute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#allowedTracingUrls:member", + "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "allowedTracingUrls?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "TracingOption", + "canonicalReference": "@datadog/browser-rum!TracingOption:type" + }, + { + "kind": "Content", + "text": "> | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "allowedTracingUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#applicationId:member", + "docComment": "/**\n * The RUM application ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applicationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "RumEvent", + "canonicalReference": "@datadog/browser-rum!RumEvent:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "RumEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#compressIntakeRequests:member", + "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "compressIntakeRequests?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "compressIntakeRequests", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#defaultPrivacyLevel:member", + "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPrivacyLevel?: " + }, + { + "kind": "Reference", + "text": "DefaultPrivacyLevel", + "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "defaultPrivacyLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#enablePrivacyForActionName:member", + "docComment": "/**\n * Enables privacy control for action names.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enablePrivacyForActionName?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "enablePrivacyForActionName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#excludedActivityUrls:member", + "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "excludedActivityUrls?: " + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "excludedActivityUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#plugins:member", + "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "plugins?: " + }, + { + "kind": "Reference", + "text": "RumPlugin", + "canonicalReference": "@datadog/browser-rum!RumPlugin:interface" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "plugins", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#profilingSampleRate:member", + "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "profilingSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "profilingSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#propagateTraceBaggage:member", + "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propagateTraceBaggage?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "propagateTraceBaggage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#remoteConfigurationId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "remoteConfigurationId?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "remoteConfigurationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#sessionReplaySampleRate:member", + "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionReplaySampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "sessionReplaySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#startSessionReplayRecordingManually:member", + "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecordingManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "startSessionReplayRecordingManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#subdomain:member", + "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subdomain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "subdomain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceContextInjection:member", + "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceContextInjection?: " + }, + { + "kind": "Reference", + "text": "TraceContextInjection", + "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceContextInjection", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceSampleRate:member", + "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackBfcacheViews:member", + "docComment": "/**\n * Enable the creation of dedicated views for pages restored from the Back-Forward cache. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackBfcacheViews?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackBfcacheViews", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackFeatureFlagsForEvents:member", + "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackFeatureFlagsForEvents?: " + }, + { + "kind": "Reference", + "text": "FeatureFlagsForEvents", + "canonicalReference": "@datadog/browser-rum!FeatureFlagsForEvents:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackFeatureFlagsForEvents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackLongTasks:member", + "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackLongTasks?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackLongTasks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackResources:member", + "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackResources?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackUserInteractions:member", + "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackUserInteractions?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackUserInteractions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackViewsManually:member", + "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackViewsManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackViewsManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#workerUrl:member", + "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workerUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "workerUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type", + "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumLongTaskEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumLongTaskEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumOtherResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumOtherResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type", + "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumResourceEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumResourceEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type", + "docComment": "/**\n * Schema of all properties of a View event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumViewEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n flutter_raster_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n js_refresh_rate?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n performance?: " + }, + { + "kind": "Reference", + "text": "ViewPerformanceData", + "canonicalReference": "@datadog/browser-rum!ViewPerformanceData:interface" + }, + { + "kind": "Content", + "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 13 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumViewEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Location", + "canonicalReference": "!Location:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type", + "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumVitalEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumVitalEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumXhrResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumXhrResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "xhr: " + }, + { + "kind": "Reference", + "text": "XMLHttpRequest", + "canonicalReference": "!XMLHttpRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "xhr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] } ] } diff --git a/package.json b/package.json index 40477c37d4..837dc5a460 100644 --- a/package.json +++ b/package.json @@ -36,12 +36,7 @@ "size": "node scripts/show-bundle-size.js", "woke": "scripts/cli woke", "build:types": "lerna run build:esm --stream", - "docs:api:rum": "api-extractor run --local --config packages/rum/api-extractor.json", - "docs:api:logs": "api-extractor run --local --config packages/logs/api-extractor.json", - "docs:api:rum-slim": "api-extractor run --local --config packages/rum-slim/api-extractor.json", - "docs:api:rum-react": "api-extractor run --local --config packages/rum-react/api-extractor.json", - "docs:api:rum-core": "api-extractor run --local --config packages/rum-core/api-extractor.json", - "docs:api": "yarn build:types && yarn docs:api:rum && yarn docs:api:logs && yarn docs:api:rum-slim && yarn docs:api:rum-react && yarn docs:api:rum-core" + "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs/api-reference/rum" }, "devDependencies": { "@eslint/js": "9.26.0", diff --git a/packages/logs/api-extractor.json b/packages/logs/api-extractor.json index 5465924218..78d8fc9925 100644 --- a/packages/logs/api-extractor.json +++ b/packages/logs/api-extractor.json @@ -10,6 +10,7 @@ "apiReport": { "enabled": false }, + "bundledPackages": ["@datadog/browser-logs"], "docModel": { "enabled": true, "apiJsonFilePath": "/etc/.api.json" diff --git a/packages/rum-react/api-extractor.json b/packages/rum-react/api-extractor.json index 5465924218..2fbdfa699b 100644 --- a/packages/rum-react/api-extractor.json +++ b/packages/rum-react/api-extractor.json @@ -10,6 +10,7 @@ "apiReport": { "enabled": false }, + "bundledPackages": ["@datadog/browser-rum-react"], "docModel": { "enabled": true, "apiJsonFilePath": "/etc/.api.json" diff --git a/packages/rum-slim/api-extractor.json b/packages/rum-slim/api-extractor.json index 5465924218..63502c1b6c 100644 --- a/packages/rum-slim/api-extractor.json +++ b/packages/rum-slim/api-extractor.json @@ -10,6 +10,7 @@ "apiReport": { "enabled": false }, + "bundledPackages": ["@datadog/browser-rum-slim"], "docModel": { "enabled": true, "apiJsonFilePath": "/etc/.api.json" diff --git a/packages/rum/api-extractor.json b/packages/rum/api-extractor.json index 5465924218..4ae766e76f 100644 --- a/packages/rum/api-extractor.json +++ b/packages/rum/api-extractor.json @@ -10,6 +10,7 @@ "apiReport": { "enabled": false }, + "bundledPackages": ["@datadog/browser-rum-core"], "docModel": { "enabled": true, "apiJsonFilePath": "/etc/.api.json" From d2d9f1eed16dfff2878b05a98dd2c2038bfc9497 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 11:17:30 +0200 Subject: [PATCH 04/21] move file --- docs/{api-reference/rum => }/browser-logs.datadoglogs.md | 0 docs/{api-reference/rum => }/browser-logs.handlertype.md | 0 docs/{api-reference/rum => }/browser-logs.logger._constructor_.md | 0 docs/{api-reference/rum => }/browser-logs.logger.alert.md | 0 docs/{api-reference/rum => }/browser-logs.logger.clearcontext.md | 0 docs/{api-reference/rum => }/browser-logs.logger.critical.md | 0 docs/{api-reference/rum => }/browser-logs.logger.debug.md | 0 docs/{api-reference/rum => }/browser-logs.logger.emerg.md | 0 docs/{api-reference/rum => }/browser-logs.logger.error.md | 0 docs/{api-reference/rum => }/browser-logs.logger.getcontext.md | 0 docs/{api-reference/rum => }/browser-logs.logger.gethandler.md | 0 docs/{api-reference/rum => }/browser-logs.logger.getlevel.md | 0 docs/{api-reference/rum => }/browser-logs.logger.info.md | 0 docs/{api-reference/rum => }/browser-logs.logger.log.md | 0 .../rum => }/browser-logs.logger.logimplementation.md | 0 docs/{api-reference/rum => }/browser-logs.logger.md | 0 docs/{api-reference/rum => }/browser-logs.logger.notice.md | 0 docs/{api-reference/rum => }/browser-logs.logger.ok.md | 0 .../rum => }/browser-logs.logger.removecontextproperty.md | 0 docs/{api-reference/rum => }/browser-logs.logger.setcontext.md | 0 .../rum => }/browser-logs.logger.setcontextproperty.md | 0 docs/{api-reference/rum => }/browser-logs.logger.sethandler.md | 0 docs/{api-reference/rum => }/browser-logs.logger.setlevel.md | 0 docs/{api-reference/rum => }/browser-logs.logger.warn.md | 0 .../rum => }/browser-logs.loggerconfiguration.context.md | 0 .../rum => }/browser-logs.loggerconfiguration.handler.md | 0 .../rum => }/browser-logs.loggerconfiguration.level.md | 0 docs/{api-reference/rum => }/browser-logs.loggerconfiguration.md | 0 .../rum => }/browser-logs.logsevent.application_id.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.date.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.error.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.http.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.logger.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.message.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.origin.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.service.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.session.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.session_id.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.status.md | 0 docs/{api-reference/rum => }/browser-logs.logsevent.view.md | 0 .../rum => }/browser-logs.logseventdomaincontext.md | 0 .../rum => }/browser-logs.logsglobal.clearaccount.md | 0 .../rum => }/browser-logs.logsglobal.clearglobalcontext.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.clearuser.md | 0 .../rum => }/browser-logs.logsglobal.createlogger.md | 0 .../{api-reference/rum => }/browser-logs.logsglobal.getaccount.md | 0 .../rum => }/browser-logs.logsglobal.getglobalcontext.md | 0 .../rum => }/browser-logs.logsglobal.getinitconfiguration.md | 0 .../rum => }/browser-logs.logsglobal.getinternalcontext.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.getlogger.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.getuser.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.init.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.logger.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.md | 0 .../rum => }/browser-logs.logsglobal.removeaccountproperty.md | 0 .../browser-logs.logsglobal.removeglobalcontextproperty.md | 0 .../rum => }/browser-logs.logsglobal.removeuserproperty.md | 0 .../{api-reference/rum => }/browser-logs.logsglobal.setaccount.md | 0 .../rum => }/browser-logs.logsglobal.setaccountproperty.md | 0 .../rum => }/browser-logs.logsglobal.setglobalcontext.md | 0 .../rum => }/browser-logs.logsglobal.setglobalcontextproperty.md | 0 .../rum => }/browser-logs.logsglobal.settrackingconsent.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.setuser.md | 0 docs/{api-reference/rum => }/browser-logs.logsglobal.setuser_1.md | 0 .../rum => }/browser-logs.logsglobal.setuserproperty.md | 0 .../rum => }/browser-logs.logsinitconfiguration.beforesend.md | 0 .../browser-logs.logsinitconfiguration.forwardconsolelogs.md | 0 .../browser-logs.logsinitconfiguration.forwarderrorstologs.md | 0 .../rum => }/browser-logs.logsinitconfiguration.forwardreports.md | 0 .../{api-reference/rum => }/browser-logs.logsinitconfiguration.md | 0 .../rum => }/browser-logs.logsinitconfiguration.usepciintake.md | 0 docs/{api-reference/rum => }/browser-logs.logsmessage.context.md | 0 docs/{api-reference/rum => }/browser-logs.logsmessage.md | 0 docs/{api-reference/rum => }/browser-logs.logsmessage.message.md | 0 docs/{api-reference/rum => }/browser-logs.logsmessage.status.md | 0 docs/{api-reference/rum => }/browser-logs.md | 0 docs/{api-reference/rum => }/browser-logs.statustype.md | 0 docs/{api-reference/rum => }/browser-rum-react.addreacterror.md | 0 .../rum => }/browser-rum-react.errorboundary._constructor_.md | 0 .../rum => }/browser-rum-react.errorboundary.componentdidcatch.md | 0 .../browser-rum-react.errorboundary.getderivedstatefromerror.md | 0 docs/{api-reference/rum => }/browser-rum-react.errorboundary.md | 0 .../rum => }/browser-rum-react.errorboundary.render.md | 0 .../rum => }/browser-rum-react.errorboundary.reseterror.md | 0 docs/{api-reference/rum => }/browser-rum-react.md | 0 docs/{api-reference/rum => }/browser-rum-react.reactplugin.md | 0 .../rum => }/browser-rum-react.unstable_reactcomponenttracker.md | 0 docs/{api-reference/rum => }/browser-rum-slim.datadogrum.md | 0 docs/{api-reference/rum => }/browser-rum-slim.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties._dd.md | 0 .../rum => }/browser-rum.commonproperties.account.md | 0 .../rum => }/browser-rum.commonproperties.application.md | 0 .../rum => }/browser-rum.commonproperties.build_id.md | 0 .../rum => }/browser-rum.commonproperties.build_version.md | 0 .../rum => }/browser-rum.commonproperties.ci_test.md | 0 .../rum => }/browser-rum.commonproperties.connectivity.md | 0 .../rum => }/browser-rum.commonproperties.context.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties.date.md | 0 .../rum => }/browser-rum.commonproperties.device.md | 0 .../rum => }/browser-rum.commonproperties.display.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties.os.md | 0 .../rum => }/browser-rum.commonproperties.service.md | 0 .../rum => }/browser-rum.commonproperties.session.md | 0 .../rum => }/browser-rum.commonproperties.source.md | 0 .../rum => }/browser-rum.commonproperties.synthetics.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties.usr.md | 0 .../rum => }/browser-rum.commonproperties.version.md | 0 docs/{api-reference/rum => }/browser-rum.commonproperties.view.md | 0 docs/{api-reference/rum => }/browser-rum.datadogrum.md | 0 docs/{api-reference/rum => }/browser-rum.md | 0 docs/{api-reference/rum => }/browser-rum.rumactionevent.md | 0 .../rum => }/browser-rum.rumactioneventdomaincontext.events.md | 0 .../browser-rum.rumactioneventdomaincontext.handlingstack.md | 0 .../rum => }/browser-rum.rumactioneventdomaincontext.md | 0 docs/{api-reference/rum => }/browser-rum.rumerrorevent.md | 0 .../rum => }/browser-rum.rumerroreventdomaincontext.error.md | 0 .../browser-rum.rumerroreventdomaincontext.handlingstack.md | 0 .../rum => }/browser-rum.rumerroreventdomaincontext.md | 0 docs/{api-reference/rum => }/browser-rum.rumevent.md | 0 docs/{api-reference/rum => }/browser-rum.rumeventdomaincontext.md | 0 .../browser-rum.rumfetchresourceeventdomaincontext.error.md | 0 ...rowser-rum.rumfetchresourceeventdomaincontext.handlingstack.md | 0 .../browser-rum.rumfetchresourceeventdomaincontext.isaborted.md | 0 .../rum => }/browser-rum.rumfetchresourceeventdomaincontext.md | 0 ...ser-rum.rumfetchresourceeventdomaincontext.performanceentry.md | 0 .../browser-rum.rumfetchresourceeventdomaincontext.requestinit.md | 0 ...browser-rum.rumfetchresourceeventdomaincontext.requestinput.md | 0 .../browser-rum.rumfetchresourceeventdomaincontext.response.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.addaction.md | 0 .../rum => }/browser-rum.rumglobal.adddurationvital.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.adderror.md | 0 .../rum => }/browser-rum.rumglobal.addfeatureflagevaluation.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.addtiming.md | 0 .../{api-reference/rum => }/browser-rum.rumglobal.clearaccount.md | 0 .../rum => }/browser-rum.rumglobal.clearglobalcontext.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.clearuser.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.getaccount.md | 0 .../rum => }/browser-rum.rumglobal.getglobalcontext.md | 0 .../rum => }/browser-rum.rumglobal.getinitconfiguration.md | 0 .../rum => }/browser-rum.rumglobal.getinternalcontext.md | 0 .../rum => }/browser-rum.rumglobal.getsessionreplaylink.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.getuser.md | 0 .../rum => }/browser-rum.rumglobal.getviewcontext.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.init.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.md | 0 .../rum => }/browser-rum.rumglobal.removeaccountproperty.md | 0 .../rum => }/browser-rum.rumglobal.removeglobalcontextproperty.md | 0 .../rum => }/browser-rum.rumglobal.removeuserproperty.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.setaccount.md | 0 .../rum => }/browser-rum.rumglobal.setaccountproperty.md | 0 .../rum => }/browser-rum.rumglobal.setglobalcontext.md | 0 .../rum => }/browser-rum.rumglobal.setglobalcontextproperty.md | 0 .../rum => }/browser-rum.rumglobal.settrackingconsent.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.setuser.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.setuser_1.md | 0 .../rum => }/browser-rum.rumglobal.setuserproperty.md | 0 .../rum => }/browser-rum.rumglobal.setviewcontext.md | 0 .../rum => }/browser-rum.rumglobal.setviewcontextproperty.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.setviewname.md | 0 .../rum => }/browser-rum.rumglobal.startdurationvital.md | 0 .../rum => }/browser-rum.rumglobal.startsessionreplayrecording.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.startview.md | 0 .../rum => }/browser-rum.rumglobal.stopdurationvital.md | 0 docs/{api-reference/rum => }/browser-rum.rumglobal.stopsession.md | 0 .../rum => }/browser-rum.rumglobal.stopsessionreplayrecording.md | 0 .../browser-rum.ruminitconfiguration.actionnameattribute.md | 0 .../browser-rum.ruminitconfiguration.allowedtracingurls.md | 0 .../rum => }/browser-rum.ruminitconfiguration.applicationid.md | 0 .../rum => }/browser-rum.ruminitconfiguration.beforesend.md | 0 .../browser-rum.ruminitconfiguration.compressintakerequests.md | 0 .../browser-rum.ruminitconfiguration.defaultprivacylevel.md | 0 ...browser-rum.ruminitconfiguration.enableprivacyforactionname.md | 0 .../browser-rum.ruminitconfiguration.excludedactivityurls.md | 0 docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.md | 0 .../rum => }/browser-rum.ruminitconfiguration.plugins.md | 0 .../browser-rum.ruminitconfiguration.profilingsamplerate.md | 0 .../browser-rum.ruminitconfiguration.propagatetracebaggage.md | 0 .../browser-rum.ruminitconfiguration.remoteconfigurationid.md | 0 .../browser-rum.ruminitconfiguration.sessionreplaysamplerate.md | 0 ...um.ruminitconfiguration.startsessionreplayrecordingmanually.md | 0 .../rum => }/browser-rum.ruminitconfiguration.subdomain.md | 0 .../browser-rum.ruminitconfiguration.tracecontextinjection.md | 0 .../rum => }/browser-rum.ruminitconfiguration.tracesamplerate.md | 0 .../browser-rum.ruminitconfiguration.trackbfcacheviews.md | 0 ...browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md | 0 .../rum => }/browser-rum.ruminitconfiguration.tracklongtasks.md | 0 .../rum => }/browser-rum.ruminitconfiguration.trackresources.md | 0 .../browser-rum.ruminitconfiguration.trackuserinteractions.md | 0 .../browser-rum.ruminitconfiguration.trackviewsmanually.md | 0 .../rum => }/browser-rum.ruminitconfiguration.workerurl.md | 0 docs/{api-reference/rum => }/browser-rum.rumlongtaskevent.md | 0 .../rum => }/browser-rum.rumlongtaskeventdomaincontext.md | 0 .../browser-rum.rumlongtaskeventdomaincontext.performanceentry.md | 0 .../rum => }/browser-rum.rumotherresourceeventdomaincontext.md | 0 ...ser-rum.rumotherresourceeventdomaincontext.performanceentry.md | 0 docs/{api-reference/rum => }/browser-rum.rumresourceevent.md | 0 docs/{api-reference/rum => }/browser-rum.rumviewevent.md | 0 .../rum => }/browser-rum.rumvieweventdomaincontext.location.md | 0 .../rum => }/browser-rum.rumvieweventdomaincontext.md | 0 docs/{api-reference/rum => }/browser-rum.rumvitalevent.md | 0 .../browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md | 0 .../browser-rum.rumxhrresourceeventdomaincontext.isaborted.md | 0 .../rum => }/browser-rum.rumxhrresourceeventdomaincontext.md | 0 ...owser-rum.rumxhrresourceeventdomaincontext.performanceentry.md | 0 .../rum => }/browser-rum.rumxhrresourceeventdomaincontext.xhr.md | 0 docs/{api-reference/rum => }/index.md | 0 208 files changed, 0 insertions(+), 0 deletions(-) rename docs/{api-reference/rum => }/browser-logs.datadoglogs.md (100%) rename docs/{api-reference/rum => }/browser-logs.handlertype.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger._constructor_.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.alert.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.clearcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.critical.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.debug.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.emerg.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.error.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.getcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.gethandler.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.getlevel.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.info.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.log.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.logimplementation.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.notice.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.ok.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.removecontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.setcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.setcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.sethandler.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.setlevel.md (100%) rename docs/{api-reference/rum => }/browser-logs.logger.warn.md (100%) rename docs/{api-reference/rum => }/browser-logs.loggerconfiguration.context.md (100%) rename docs/{api-reference/rum => }/browser-logs.loggerconfiguration.handler.md (100%) rename docs/{api-reference/rum => }/browser-logs.loggerconfiguration.level.md (100%) rename docs/{api-reference/rum => }/browser-logs.loggerconfiguration.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.application_id.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.date.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.error.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.http.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.logger.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.message.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.origin.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.service.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.session.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.session_id.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.status.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsevent.view.md (100%) rename docs/{api-reference/rum => }/browser-logs.logseventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.clearaccount.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.clearglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.clearuser.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.createlogger.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getaccount.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getinitconfiguration.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getinternalcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getlogger.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.getuser.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.init.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.logger.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.removeaccountproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.removeglobalcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.removeuserproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setaccount.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setaccountproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setglobalcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.settrackingconsent.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setuser.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setuser_1.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsglobal.setuserproperty.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.beforesend.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.forwardconsolelogs.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.forwarderrorstologs.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.forwardreports.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsinitconfiguration.usepciintake.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsmessage.context.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsmessage.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsmessage.message.md (100%) rename docs/{api-reference/rum => }/browser-logs.logsmessage.status.md (100%) rename docs/{api-reference/rum => }/browser-logs.md (100%) rename docs/{api-reference/rum => }/browser-logs.statustype.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.addreacterror.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary._constructor_.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary.componentdidcatch.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary.getderivedstatefromerror.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary.render.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.errorboundary.reseterror.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.reactplugin.md (100%) rename docs/{api-reference/rum => }/browser-rum-react.unstable_reactcomponenttracker.md (100%) rename docs/{api-reference/rum => }/browser-rum-slim.datadogrum.md (100%) rename docs/{api-reference/rum => }/browser-rum-slim.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties._dd.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.account.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.application.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.build_id.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.build_version.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.ci_test.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.connectivity.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.context.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.date.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.device.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.display.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.os.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.service.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.session.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.source.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.synthetics.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.usr.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.version.md (100%) rename docs/{api-reference/rum => }/browser-rum.commonproperties.view.md (100%) rename docs/{api-reference/rum => }/browser-rum.datadogrum.md (100%) rename docs/{api-reference/rum => }/browser-rum.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumactionevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumactioneventdomaincontext.events.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumactioneventdomaincontext.handlingstack.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumactioneventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumerrorevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumerroreventdomaincontext.error.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumerroreventdomaincontext.handlingstack.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumerroreventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumeventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.error.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumfetchresourceeventdomaincontext.response.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.addaction.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.adddurationvital.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.adderror.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.addfeatureflagevaluation.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.addtiming.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.clearaccount.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.clearglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.clearuser.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getaccount.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getinitconfiguration.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getinternalcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getsessionreplaylink.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getuser.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.getviewcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.init.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.removeaccountproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.removeglobalcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.removeuserproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setaccount.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setaccountproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setglobalcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setglobalcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.settrackingconsent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setuser.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setuser_1.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setuserproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setviewcontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setviewcontextproperty.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.setviewname.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.startdurationvital.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.startsessionreplayrecording.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.startview.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.stopdurationvital.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.stopsession.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumglobal.stopsessionreplayrecording.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.actionnameattribute.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.allowedtracingurls.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.applicationid.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.beforesend.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.compressintakerequests.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.defaultprivacylevel.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.enableprivacyforactionname.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.excludedactivityurls.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.plugins.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.profilingsamplerate.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.propagatetracebaggage.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.remoteconfigurationid.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.subdomain.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.tracecontextinjection.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.tracesamplerate.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.trackbfcacheviews.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.tracklongtasks.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.trackresources.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.trackuserinteractions.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.trackviewsmanually.md (100%) rename docs/{api-reference/rum => }/browser-rum.ruminitconfiguration.workerurl.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumlongtaskevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumlongtaskeventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumotherresourceeventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumresourceevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumviewevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumvieweventdomaincontext.location.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumvieweventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumvitalevent.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumxhrresourceeventdomaincontext.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md (100%) rename docs/{api-reference/rum => }/browser-rum.rumxhrresourceeventdomaincontext.xhr.md (100%) rename docs/{api-reference/rum => }/index.md (100%) diff --git a/docs/api-reference/rum/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md similarity index 100% rename from docs/api-reference/rum/browser-logs.datadoglogs.md rename to docs/browser-logs.datadoglogs.md diff --git a/docs/api-reference/rum/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md similarity index 100% rename from docs/api-reference/rum/browser-logs.handlertype.md rename to docs/browser-logs.handlertype.md diff --git a/docs/api-reference/rum/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger._constructor_.md rename to docs/browser-logs.logger._constructor_.md diff --git a/docs/api-reference/rum/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.alert.md rename to docs/browser-logs.logger.alert.md diff --git a/docs/api-reference/rum/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.clearcontext.md rename to docs/browser-logs.logger.clearcontext.md diff --git a/docs/api-reference/rum/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.critical.md rename to docs/browser-logs.logger.critical.md diff --git a/docs/api-reference/rum/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.debug.md rename to docs/browser-logs.logger.debug.md diff --git a/docs/api-reference/rum/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.emerg.md rename to docs/browser-logs.logger.emerg.md diff --git a/docs/api-reference/rum/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.error.md rename to docs/browser-logs.logger.error.md diff --git a/docs/api-reference/rum/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.getcontext.md rename to docs/browser-logs.logger.getcontext.md diff --git a/docs/api-reference/rum/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.gethandler.md rename to docs/browser-logs.logger.gethandler.md diff --git a/docs/api-reference/rum/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.getlevel.md rename to docs/browser-logs.logger.getlevel.md diff --git a/docs/api-reference/rum/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.info.md rename to docs/browser-logs.logger.info.md diff --git a/docs/api-reference/rum/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.log.md rename to docs/browser-logs.logger.log.md diff --git a/docs/api-reference/rum/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.logimplementation.md rename to docs/browser-logs.logger.logimplementation.md diff --git a/docs/api-reference/rum/browser-logs.logger.md b/docs/browser-logs.logger.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.md rename to docs/browser-logs.logger.md diff --git a/docs/api-reference/rum/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.notice.md rename to docs/browser-logs.logger.notice.md diff --git a/docs/api-reference/rum/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.ok.md rename to docs/browser-logs.logger.ok.md diff --git a/docs/api-reference/rum/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.removecontextproperty.md rename to docs/browser-logs.logger.removecontextproperty.md diff --git a/docs/api-reference/rum/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.setcontext.md rename to docs/browser-logs.logger.setcontext.md diff --git a/docs/api-reference/rum/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.setcontextproperty.md rename to docs/browser-logs.logger.setcontextproperty.md diff --git a/docs/api-reference/rum/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.sethandler.md rename to docs/browser-logs.logger.sethandler.md diff --git a/docs/api-reference/rum/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.setlevel.md rename to docs/browser-logs.logger.setlevel.md diff --git a/docs/api-reference/rum/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logger.warn.md rename to docs/browser-logs.logger.warn.md diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md similarity index 100% rename from docs/api-reference/rum/browser-logs.loggerconfiguration.context.md rename to docs/browser-logs.loggerconfiguration.context.md diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md similarity index 100% rename from docs/api-reference/rum/browser-logs.loggerconfiguration.handler.md rename to docs/browser-logs.loggerconfiguration.handler.md diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md similarity index 100% rename from docs/api-reference/rum/browser-logs.loggerconfiguration.level.md rename to docs/browser-logs.loggerconfiguration.level.md diff --git a/docs/api-reference/rum/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md similarity index 100% rename from docs/api-reference/rum/browser-logs.loggerconfiguration.md rename to docs/browser-logs.loggerconfiguration.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.application_id.md rename to docs/browser-logs.logsevent.application_id.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.date.md rename to docs/browser-logs.logsevent.date.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.error.md rename to docs/browser-logs.logsevent.error.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.http.md rename to docs/browser-logs.logsevent.http.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.logger.md rename to docs/browser-logs.logsevent.logger.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.md rename to docs/browser-logs.logsevent.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.message.md rename to docs/browser-logs.logsevent.message.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.origin.md rename to docs/browser-logs.logsevent.origin.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.service.md rename to docs/browser-logs.logsevent.service.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.session.md rename to docs/browser-logs.logsevent.session.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.session_id.md rename to docs/browser-logs.logsevent.session_id.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.status.md rename to docs/browser-logs.logsevent.status.md diff --git a/docs/api-reference/rum/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsevent.view.md rename to docs/browser-logs.logsevent.view.md diff --git a/docs/api-reference/rum/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logseventdomaincontext.md rename to docs/browser-logs.logseventdomaincontext.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.clearaccount.md rename to docs/browser-logs.logsglobal.clearaccount.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.clearglobalcontext.md rename to docs/browser-logs.logsglobal.clearglobalcontext.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.clearuser.md rename to docs/browser-logs.logsglobal.clearuser.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.createlogger.md rename to docs/browser-logs.logsglobal.createlogger.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getaccount.md rename to docs/browser-logs.logsglobal.getaccount.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getglobalcontext.md rename to docs/browser-logs.logsglobal.getglobalcontext.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getinitconfiguration.md rename to docs/browser-logs.logsglobal.getinitconfiguration.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getinternalcontext.md rename to docs/browser-logs.logsglobal.getinternalcontext.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getlogger.md rename to docs/browser-logs.logsglobal.getlogger.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.getuser.md rename to docs/browser-logs.logsglobal.getuser.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.init.md rename to docs/browser-logs.logsglobal.init.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.logger.md rename to docs/browser-logs.logsglobal.logger.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.md rename to docs/browser-logs.logsglobal.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.removeaccountproperty.md rename to docs/browser-logs.logsglobal.removeaccountproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.removeglobalcontextproperty.md rename to docs/browser-logs.logsglobal.removeglobalcontextproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.removeuserproperty.md rename to docs/browser-logs.logsglobal.removeuserproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setaccount.md rename to docs/browser-logs.logsglobal.setaccount.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setaccountproperty.md rename to docs/browser-logs.logsglobal.setaccountproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setglobalcontext.md rename to docs/browser-logs.logsglobal.setglobalcontext.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setglobalcontextproperty.md rename to docs/browser-logs.logsglobal.setglobalcontextproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.settrackingconsent.md rename to docs/browser-logs.logsglobal.settrackingconsent.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setuser.md rename to docs/browser-logs.logsglobal.setuser.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setuser_1.md rename to docs/browser-logs.logsglobal.setuser_1.md diff --git a/docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsglobal.setuserproperty.md rename to docs/browser-logs.logsglobal.setuserproperty.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.beforesend.md rename to docs/browser-logs.logsinitconfiguration.beforesend.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardconsolelogs.md rename to docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.forwarderrorstologs.md rename to docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.forwardreports.md rename to docs/browser-logs.logsinitconfiguration.forwardreports.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.md rename to docs/browser-logs.logsinitconfiguration.md diff --git a/docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsinitconfiguration.usepciintake.md rename to docs/browser-logs.logsinitconfiguration.usepciintake.md diff --git a/docs/api-reference/rum/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsmessage.context.md rename to docs/browser-logs.logsmessage.context.md diff --git a/docs/api-reference/rum/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsmessage.md rename to docs/browser-logs.logsmessage.md diff --git a/docs/api-reference/rum/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsmessage.message.md rename to docs/browser-logs.logsmessage.message.md diff --git a/docs/api-reference/rum/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md similarity index 100% rename from docs/api-reference/rum/browser-logs.logsmessage.status.md rename to docs/browser-logs.logsmessage.status.md diff --git a/docs/api-reference/rum/browser-logs.md b/docs/browser-logs.md similarity index 100% rename from docs/api-reference/rum/browser-logs.md rename to docs/browser-logs.md diff --git a/docs/api-reference/rum/browser-logs.statustype.md b/docs/browser-logs.statustype.md similarity index 100% rename from docs/api-reference/rum/browser-logs.statustype.md rename to docs/browser-logs.statustype.md diff --git a/docs/api-reference/rum/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.addreacterror.md rename to docs/browser-rum-react.addreacterror.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary._constructor_.md rename to docs/browser-rum-react.errorboundary._constructor_.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary.componentdidcatch.md rename to docs/browser-rum-react.errorboundary.componentdidcatch.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary.getderivedstatefromerror.md rename to docs/browser-rum-react.errorboundary.getderivedstatefromerror.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary.md rename to docs/browser-rum-react.errorboundary.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary.render.md rename to docs/browser-rum-react.errorboundary.render.md diff --git a/docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.errorboundary.reseterror.md rename to docs/browser-rum-react.errorboundary.reseterror.md diff --git a/docs/api-reference/rum/browser-rum-react.md b/docs/browser-rum-react.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.md rename to docs/browser-rum-react.md diff --git a/docs/api-reference/rum/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.reactplugin.md rename to docs/browser-rum-react.reactplugin.md diff --git a/docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md similarity index 100% rename from docs/api-reference/rum/browser-rum-react.unstable_reactcomponenttracker.md rename to docs/browser-rum-react.unstable_reactcomponenttracker.md diff --git a/docs/api-reference/rum/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md similarity index 100% rename from docs/api-reference/rum/browser-rum-slim.datadogrum.md rename to docs/browser-rum-slim.datadogrum.md diff --git a/docs/api-reference/rum/browser-rum-slim.md b/docs/browser-rum-slim.md similarity index 100% rename from docs/api-reference/rum/browser-rum-slim.md rename to docs/browser-rum-slim.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties._dd.md rename to docs/browser-rum.commonproperties._dd.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.account.md rename to docs/browser-rum.commonproperties.account.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.application.md rename to docs/browser-rum.commonproperties.application.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.build_id.md rename to docs/browser-rum.commonproperties.build_id.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.build_version.md rename to docs/browser-rum.commonproperties.build_version.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.ci_test.md rename to docs/browser-rum.commonproperties.ci_test.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.connectivity.md rename to docs/browser-rum.commonproperties.connectivity.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.context.md rename to docs/browser-rum.commonproperties.context.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.date.md rename to docs/browser-rum.commonproperties.date.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.device.md rename to docs/browser-rum.commonproperties.device.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.display.md rename to docs/browser-rum.commonproperties.display.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.md rename to docs/browser-rum.commonproperties.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.os.md rename to docs/browser-rum.commonproperties.os.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.service.md rename to docs/browser-rum.commonproperties.service.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.session.md rename to docs/browser-rum.commonproperties.session.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.source.md rename to docs/browser-rum.commonproperties.source.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.synthetics.md rename to docs/browser-rum.commonproperties.synthetics.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.usr.md rename to docs/browser-rum.commonproperties.usr.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.version.md rename to docs/browser-rum.commonproperties.version.md diff --git a/docs/api-reference/rum/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md similarity index 100% rename from docs/api-reference/rum/browser-rum.commonproperties.view.md rename to docs/browser-rum.commonproperties.view.md diff --git a/docs/api-reference/rum/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md similarity index 100% rename from docs/api-reference/rum/browser-rum.datadogrum.md rename to docs/browser-rum.datadogrum.md diff --git a/docs/api-reference/rum/browser-rum.md b/docs/browser-rum.md similarity index 100% rename from docs/api-reference/rum/browser-rum.md rename to docs/browser-rum.md diff --git a/docs/api-reference/rum/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumactionevent.md rename to docs/browser-rum.rumactionevent.md diff --git a/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.events.md rename to docs/browser-rum.rumactioneventdomaincontext.events.md diff --git a/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.handlingstack.md rename to docs/browser-rum.rumactioneventdomaincontext.handlingstack.md diff --git a/docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumactioneventdomaincontext.md rename to docs/browser-rum.rumactioneventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumerrorevent.md rename to docs/browser-rum.rumerrorevent.md diff --git a/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.error.md rename to docs/browser-rum.rumerroreventdomaincontext.error.md diff --git a/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.handlingstack.md rename to docs/browser-rum.rumerroreventdomaincontext.handlingstack.md diff --git a/docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumerroreventdomaincontext.md rename to docs/browser-rum.rumerroreventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumevent.md rename to docs/browser-rum.rumevent.md diff --git a/docs/api-reference/rum/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumeventdomaincontext.md rename to docs/browser-rum.rumeventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.error.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.error.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md diff --git a/docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumfetchresourceeventdomaincontext.response.md rename to docs/browser-rum.rumfetchresourceeventdomaincontext.response.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.addaction.md rename to docs/browser-rum.rumglobal.addaction.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.adddurationvital.md rename to docs/browser-rum.rumglobal.adddurationvital.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.adderror.md rename to docs/browser-rum.rumglobal.adderror.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.addfeatureflagevaluation.md rename to docs/browser-rum.rumglobal.addfeatureflagevaluation.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.addtiming.md rename to docs/browser-rum.rumglobal.addtiming.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.clearaccount.md rename to docs/browser-rum.rumglobal.clearaccount.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.clearglobalcontext.md rename to docs/browser-rum.rumglobal.clearglobalcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.clearuser.md rename to docs/browser-rum.rumglobal.clearuser.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getaccount.md rename to docs/browser-rum.rumglobal.getaccount.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getglobalcontext.md rename to docs/browser-rum.rumglobal.getglobalcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getinitconfiguration.md rename to docs/browser-rum.rumglobal.getinitconfiguration.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getinternalcontext.md rename to docs/browser-rum.rumglobal.getinternalcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getsessionreplaylink.md rename to docs/browser-rum.rumglobal.getsessionreplaylink.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getuser.md rename to docs/browser-rum.rumglobal.getuser.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.getviewcontext.md rename to docs/browser-rum.rumglobal.getviewcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.init.md rename to docs/browser-rum.rumglobal.init.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.md rename to docs/browser-rum.rumglobal.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.removeaccountproperty.md rename to docs/browser-rum.rumglobal.removeaccountproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.removeglobalcontextproperty.md rename to docs/browser-rum.rumglobal.removeglobalcontextproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.removeuserproperty.md rename to docs/browser-rum.rumglobal.removeuserproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setaccount.md rename to docs/browser-rum.rumglobal.setaccount.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setaccountproperty.md rename to docs/browser-rum.rumglobal.setaccountproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setglobalcontext.md rename to docs/browser-rum.rumglobal.setglobalcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setglobalcontextproperty.md rename to docs/browser-rum.rumglobal.setglobalcontextproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.settrackingconsent.md rename to docs/browser-rum.rumglobal.settrackingconsent.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setuser.md rename to docs/browser-rum.rumglobal.setuser.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setuser_1.md rename to docs/browser-rum.rumglobal.setuser_1.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setuserproperty.md rename to docs/browser-rum.rumglobal.setuserproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setviewcontext.md rename to docs/browser-rum.rumglobal.setviewcontext.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setviewcontextproperty.md rename to docs/browser-rum.rumglobal.setviewcontextproperty.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.setviewname.md rename to docs/browser-rum.rumglobal.setviewname.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.startdurationvital.md rename to docs/browser-rum.rumglobal.startdurationvital.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.startsessionreplayrecording.md rename to docs/browser-rum.rumglobal.startsessionreplayrecording.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.startview.md rename to docs/browser-rum.rumglobal.startview.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.stopdurationvital.md rename to docs/browser-rum.rumglobal.stopdurationvital.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.stopsession.md rename to docs/browser-rum.rumglobal.stopsession.md diff --git a/docs/api-reference/rum/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumglobal.stopsessionreplayrecording.md rename to docs/browser-rum.rumglobal.stopsessionreplayrecording.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.actionnameattribute.md rename to docs/browser-rum.ruminitconfiguration.actionnameattribute.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.allowedtracingurls.md rename to docs/browser-rum.ruminitconfiguration.allowedtracingurls.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.applicationid.md rename to docs/browser-rum.ruminitconfiguration.applicationid.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.beforesend.md rename to docs/browser-rum.ruminitconfiguration.beforesend.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.compressintakerequests.md rename to docs/browser-rum.ruminitconfiguration.compressintakerequests.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.defaultprivacylevel.md rename to docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.enableprivacyforactionname.md rename to docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.excludedactivityurls.md rename to docs/browser-rum.ruminitconfiguration.excludedactivityurls.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.md rename to docs/browser-rum.ruminitconfiguration.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.plugins.md rename to docs/browser-rum.ruminitconfiguration.plugins.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.profilingsamplerate.md rename to docs/browser-rum.ruminitconfiguration.profilingsamplerate.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.propagatetracebaggage.md rename to docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.remoteconfigurationid.md rename to docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md rename to docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md rename to docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.subdomain.md rename to docs/browser-rum.ruminitconfiguration.subdomain.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.tracecontextinjection.md rename to docs/browser-rum.ruminitconfiguration.tracecontextinjection.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.tracesamplerate.md rename to docs/browser-rum.ruminitconfiguration.tracesamplerate.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.trackbfcacheviews.md rename to docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md rename to docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.tracklongtasks.md rename to docs/browser-rum.ruminitconfiguration.tracklongtasks.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.trackresources.md rename to docs/browser-rum.ruminitconfiguration.trackresources.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.trackuserinteractions.md rename to docs/browser-rum.ruminitconfiguration.trackuserinteractions.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.trackviewsmanually.md rename to docs/browser-rum.ruminitconfiguration.trackviewsmanually.md diff --git a/docs/api-reference/rum/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md similarity index 100% rename from docs/api-reference/rum/browser-rum.ruminitconfiguration.workerurl.md rename to docs/browser-rum.ruminitconfiguration.workerurl.md diff --git a/docs/api-reference/rum/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumlongtaskevent.md rename to docs/browser-rum.rumlongtaskevent.md diff --git a/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.md rename to docs/browser-rum.rumlongtaskeventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md rename to docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md diff --git a/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.md rename to docs/browser-rum.rumotherresourceeventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md rename to docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md diff --git a/docs/api-reference/rum/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumresourceevent.md rename to docs/browser-rum.rumresourceevent.md diff --git a/docs/api-reference/rum/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumviewevent.md rename to docs/browser-rum.rumviewevent.md diff --git a/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.location.md rename to docs/browser-rum.rumvieweventdomaincontext.location.md diff --git a/docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumvieweventdomaincontext.md rename to docs/browser-rum.rumvieweventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumvitalevent.md rename to docs/browser-rum.rumvitalevent.md diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md rename to docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md rename to docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.md rename to docs/browser-rum.rumxhrresourceeventdomaincontext.md diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md rename to docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md diff --git a/docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md similarity index 100% rename from docs/api-reference/rum/browser-rum.rumxhrresourceeventdomaincontext.xhr.md rename to docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md diff --git a/docs/api-reference/rum/index.md b/docs/index.md similarity index 100% rename from docs/api-reference/rum/index.md rename to docs/index.md From 4f58cd7560af67e48d397cbb1a2a07c3c359cb29 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 11:21:19 +0200 Subject: [PATCH 05/21] test update --- docs/index.md | 74 ++++++++++++++++++--------------------------------- 1 file changed, 26 insertions(+), 48 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3b3651148c..87cd2583bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,51 +6,29 @@ ## Packages - - - - - -
- -Package - - - - -Description - - -
- -[@datadog/browser-logs](./browser-logs.md) - - - - - -
- -[@datadog/browser-rum](./browser-rum.md) - - - - - -
- -[@datadog/browser-rum-react](./browser-rum-react.md) - - - - - -
- -[@datadog/browser-rum-slim](./browser-rum-slim.md) - - - - - -
+ + + + + + + + + + + + + + + + + + + + + + + + + +
PackageDescription
@datadog/browser-logsLogs collection package for browser applications
@datadog/browser-rumMain RUM package for collecting user monitoring data
@datadog/browser-rum-reactReact-specific extensions for RUM
@datadog/browser-rum-slimLightweight version of the RUM package
From 70720ac2d5f79f3b6dd2769dcf9c151e9921a177 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 11:36:07 +0200 Subject: [PATCH 06/21] Add Jekyll configuration and deployment workflow for GitHub Pages --- .github/workflows/pages.yml | 67 +++++++++++++++++++++++++++++++++++++ docs/Gemfile | 16 +++++++++ docs/_config.yml | 34 +++++++++++++++++++ 3 files changed, 117 insertions(+) create mode 100644 .github/workflows/pages.yml create mode 100644 docs/Gemfile create mode 100644 docs/_config.yml diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000000..28db842e10 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,67 @@ +name: Deploy Jekyll site to Pages + +on: + push: + branches: ['romanG/api-reference'] + pull_request: + branches: ['romanG/api-reference'] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: 'pages' + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.2' + bundler-cache: true + working-directory: ./docs + + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + + - name: Install dependencies + run: | + cd docs + gem install bundler jekyll + bundle init --force + bundle add jekyll minima + bundle install + + - name: Build with Jekyll + run: | + cd docs + bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/_site + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + if: github.ref == 'refs/heads/romanG/api-reference' + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000000..2c368aae8a --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,16 @@ +source "https://rubygems.org" + +gem "jekyll", "~> 4.3" +gem "minima", "~> 2.5" + +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" + gem "jekyll-relative-links" +end + +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", ">= 1", "< 3" + gem "tzinfo-data" +end + +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000000..a257b954b3 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,34 @@ +title: 'Datadog Browser SDK API Reference' +description: 'API documentation for Datadog Browser SDK packages' + +markdown: kramdown +highlighter: rouge +theme: minima + +baseurl: '/browser-sdk' +url: 'https://datadoghq.dev' + +plugins: + - jekyll-relative-links + +relative_links: + enabled: true + collections: false + +include: + - '*.md' + +exclude: + - README.md + - LICENSE + - CHANGELOG.md + - node_modules/ + - package.json + - yarn.lock + +kramdown: + input: GFM + syntax_highlighter: rouge + syntax_highlighter_opts: + block: + line_numbers: false From 1a08b0f5614b2f915af0cdaec134b7a7ee6997c2 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 11:40:35 +0200 Subject: [PATCH 07/21] Remove unnecessary Jekyll setup commands and update configuration for cleaner deployment --- .github/workflows/pages.yml | 3 --- docs/Gemfile | 4 ++-- docs/_config.yml | 14 +++++++++----- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 28db842e10..42e9c57dbf 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -37,9 +37,6 @@ jobs: - name: Install dependencies run: | cd docs - gem install bundler jekyll - bundle init --force - bundle add jekyll minima bundle install - name: Build with Jekyll diff --git a/docs/Gemfile b/docs/Gemfile index 2c368aae8a..652a011139 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -5,7 +5,6 @@ gem "minima", "~> 2.5" group :jekyll_plugins do gem "jekyll-feed", "~> 0.12" - gem "jekyll-relative-links" end platforms :mingw, :x64_mingw, :mswin, :jruby do @@ -13,4 +12,5 @@ platforms :mingw, :x64_mingw, :mswin, :jruby do gem "tzinfo-data" end -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] \ No newline at end of file +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] +gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index a257b954b3..77b9b0ecdf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,23 +1,24 @@ title: 'Datadog Browser SDK API Reference' description: 'API documentation for Datadog Browser SDK packages' +# Build settings markdown: kramdown highlighter: rouge theme: minima +# GitHub Pages settings baseurl: '/browser-sdk' url: 'https://datadoghq.dev' +# Plugins plugins: - - jekyll-relative-links - -relative_links: - enabled: true - collections: false + - jekyll-feed +# Include markdown files include: - '*.md' +# Exclude files from processing exclude: - README.md - LICENSE @@ -25,7 +26,10 @@ exclude: - node_modules/ - package.json - yarn.lock + - Gemfile + - Gemfile.lock +# Kramdown settings kramdown: input: GFM syntax_highlighter: rouge From 151a34d2ce95bd0d46bbb23a178f4bec7ba5d601 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 12:01:08 +0200 Subject: [PATCH 08/21] Refactor Jekyll setup: remove unused gems, update configuration, and add default layout --- .github/workflows/pages.yml | 9 + docs/Gemfile | 9 +- docs/_config.yml | 27 +- docs/_layouts/default.html | 62 ++++ docs/assets/css/style.scss | 1 + docs/browser-logs.datadoglogs.md | 2 +- docs/browser-logs.handlertype.md | 2 +- docs/browser-logs.logger._constructor_.md | 13 +- docs/browser-logs.logger.alert.md | 2 +- docs/browser-logs.logger.clearcontext.md | 2 +- docs/browser-logs.logger.critical.md | 2 +- docs/browser-logs.logger.debug.md | 2 +- docs/browser-logs.logger.emerg.md | 2 +- docs/browser-logs.logger.error.md | 2 +- docs/browser-logs.logger.getcontext.md | 2 +- docs/browser-logs.logger.gethandler.md | 2 +- docs/browser-logs.logger.getlevel.md | 2 +- docs/browser-logs.logger.info.md | 2 +- docs/browser-logs.logger.log.md | 9 +- docs/browser-logs.logger.logimplementation.md | 9 +- docs/browser-logs.logger.md | 65 +--- docs/browser-logs.logger.notice.md | 2 +- docs/browser-logs.logger.ok.md | 2 +- ...owser-logs.logger.removecontextproperty.md | 2 +- docs/browser-logs.logger.setcontext.md | 2 +- .../browser-logs.logger.setcontextproperty.md | 2 +- docs/browser-logs.logger.sethandler.md | 4 +- docs/browser-logs.logger.setlevel.md | 9 +- docs/browser-logs.logger.warn.md | 2 +- ...rowser-logs.loggerconfiguration.context.md | 2 +- ...rowser-logs.loggerconfiguration.handler.md | 2 +- .../browser-logs.loggerconfiguration.level.md | 2 +- docs/browser-logs.loggerconfiguration.md | 32 +- docs/browser-logs.logsevent.application_id.md | 2 +- docs/browser-logs.logsevent.date.md | 2 +- docs/browser-logs.logsevent.error.md | 2 +- docs/browser-logs.logsevent.http.md | 2 +- docs/browser-logs.logsevent.logger.md | 2 +- docs/browser-logs.logsevent.md | 86 +----- docs/browser-logs.logsevent.message.md | 2 +- docs/browser-logs.logsevent.origin.md | 2 +- docs/browser-logs.logsevent.service.md | 2 +- docs/browser-logs.logsevent.session.md | 2 +- docs/browser-logs.logsevent.session_id.md | 2 +- docs/browser-logs.logsevent.status.md | 2 +- docs/browser-logs.logsevent.view.md | 2 +- docs/browser-logs.logseventdomaincontext.md | 2 +- docs/browser-logs.logsglobal.clearaccount.md | 2 +- ...wser-logs.logsglobal.clearglobalcontext.md | 2 +- docs/browser-logs.logsglobal.clearuser.md | 2 +- docs/browser-logs.logsglobal.createlogger.md | 2 +- docs/browser-logs.logsglobal.getaccount.md | 2 +- ...rowser-logs.logsglobal.getglobalcontext.md | 2 +- ...er-logs.logsglobal.getinitconfiguration.md | 2 +- ...wser-logs.logsglobal.getinternalcontext.md | 2 +- docs/browser-logs.logsglobal.getlogger.md | 2 +- docs/browser-logs.logsglobal.getuser.md | 2 +- docs/browser-logs.logsglobal.init.md | 2 +- docs/browser-logs.logsglobal.logger.md | 2 +- docs/browser-logs.logsglobal.md | 198 +++---------- ...r-logs.logsglobal.removeaccountproperty.md | 2 +- ....logsglobal.removeglobalcontextproperty.md | 2 +- ...wser-logs.logsglobal.removeuserproperty.md | 2 +- docs/browser-logs.logsglobal.setaccount.md | 2 +- ...wser-logs.logsglobal.setaccountproperty.md | 2 +- ...rowser-logs.logsglobal.setglobalcontext.md | 2 +- ...ogs.logsglobal.setglobalcontextproperty.md | 2 +- ...wser-logs.logsglobal.settrackingconsent.md | 2 +- docs/browser-logs.logsglobal.setuser.md | 2 +- docs/browser-logs.logsglobal.setuser_1.md | 2 +- ...browser-logs.logsglobal.setuserproperty.md | 2 +- ...r-logs.logsinitconfiguration.beforesend.md | 2 +- ...ogsinitconfiguration.forwardconsolelogs.md | 2 +- ...gsinitconfiguration.forwarderrorstologs.md | 2 +- ...gs.logsinitconfiguration.forwardreports.md | 2 +- docs/browser-logs.logsinitconfiguration.md | 43 +-- ...logs.logsinitconfiguration.usepciintake.md | 2 +- docs/browser-logs.logsmessage.context.md | 2 +- docs/browser-logs.logsmessage.md | 30 +- docs/browser-logs.logsmessage.message.md | 2 +- docs/browser-logs.logsmessage.status.md | 2 +- docs/browser-logs.md | 93 +----- docs/browser-logs.statustype.md | 2 +- docs/browser-rum-react.addreacterror.md | 2 +- ...r-rum-react.errorboundary._constructor_.md | 2 +- ...m-react.errorboundary.componentdidcatch.md | 2 +- ....errorboundary.getderivedstatefromerror.md | 2 +- docs/browser-rum-react.errorboundary.md | 37 +-- .../browser-rum-react.errorboundary.render.md | 2 +- ...wser-rum-react.errorboundary.reseterror.md | 2 +- docs/browser-rum-react.md | 30 +- docs/browser-rum-react.reactplugin.md | 2 +- ...um-react.unstable_reactcomponenttracker.md | 2 +- docs/browser-rum-slim.datadogrum.md | 2 +- docs/browser-rum-slim.md | 9 +- docs/browser-rum.commonproperties._dd.md | 2 +- docs/browser-rum.commonproperties.account.md | 2 +- ...rowser-rum.commonproperties.application.md | 2 +- docs/browser-rum.commonproperties.build_id.md | 2 +- ...wser-rum.commonproperties.build_version.md | 2 +- docs/browser-rum.commonproperties.ci_test.md | 2 +- ...owser-rum.commonproperties.connectivity.md | 2 +- docs/browser-rum.commonproperties.context.md | 2 +- docs/browser-rum.commonproperties.date.md | 2 +- docs/browser-rum.commonproperties.device.md | 2 +- docs/browser-rum.commonproperties.display.md | 2 +- docs/browser-rum.commonproperties.md | 135 ++------- docs/browser-rum.commonproperties.os.md | 2 +- docs/browser-rum.commonproperties.service.md | 2 +- docs/browser-rum.commonproperties.session.md | 2 +- docs/browser-rum.commonproperties.source.md | 2 +- ...browser-rum.commonproperties.synthetics.md | 2 +- docs/browser-rum.commonproperties.usr.md | 2 +- docs/browser-rum.commonproperties.version.md | 2 +- docs/browser-rum.commonproperties.view.md | 2 +- docs/browser-rum.datadogrum.md | 2 +- docs/browser-rum.md | 135 ++------- docs/browser-rum.rumactionevent.md | 2 +- ...-rum.rumactioneventdomaincontext.events.md | 2 +- ...mactioneventdomaincontext.handlingstack.md | 2 +- ...browser-rum.rumactioneventdomaincontext.md | 16 +- docs/browser-rum.rumerrorevent.md | 2 +- ...er-rum.rumerroreventdomaincontext.error.md | 2 +- ...umerroreventdomaincontext.handlingstack.md | 2 +- .../browser-rum.rumerroreventdomaincontext.md | 16 +- docs/browser-rum.rumevent.md | 2 +- docs/browser-rum.rumeventdomaincontext.md | 2 +- ...umfetchresourceeventdomaincontext.error.md | 2 +- ...esourceeventdomaincontext.handlingstack.md | 2 +- ...tchresourceeventdomaincontext.isaborted.md | 2 +- ...-rum.rumfetchresourceeventdomaincontext.md | 51 +--- ...urceeventdomaincontext.performanceentry.md | 2 +- ...hresourceeventdomaincontext.requestinit.md | 2 +- ...resourceeventdomaincontext.requestinput.md | 2 +- ...etchresourceeventdomaincontext.response.md | 2 +- docs/browser-rum.rumglobal.addaction.md | 2 +- .../browser-rum.rumglobal.adddurationvital.md | 2 +- docs/browser-rum.rumglobal.adderror.md | 2 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 2 +- docs/browser-rum.rumglobal.addtiming.md | 2 +- docs/browser-rum.rumglobal.clearaccount.md | 2 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 2 +- docs/browser-rum.rumglobal.clearuser.md | 2 +- docs/browser-rum.rumglobal.getaccount.md | 2 +- .../browser-rum.rumglobal.getglobalcontext.md | 2 +- ...wser-rum.rumglobal.getinitconfiguration.md | 2 +- ...rowser-rum.rumglobal.getinternalcontext.md | 2 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 2 +- docs/browser-rum.rumglobal.getuser.md | 2 +- docs/browser-rum.rumglobal.getviewcontext.md | 2 +- docs/browser-rum.rumglobal.init.md | 2 +- docs/browser-rum.rumglobal.md | 278 +++--------------- ...ser-rum.rumglobal.removeaccountproperty.md | 2 +- ...m.rumglobal.removeglobalcontextproperty.md | 2 +- ...rowser-rum.rumglobal.removeuserproperty.md | 2 +- docs/browser-rum.rumglobal.setaccount.md | 2 +- ...rowser-rum.rumglobal.setaccountproperty.md | 2 +- .../browser-rum.rumglobal.setglobalcontext.md | 2 +- ...-rum.rumglobal.setglobalcontextproperty.md | 2 +- ...rowser-rum.rumglobal.settrackingconsent.md | 2 +- docs/browser-rum.rumglobal.setuser.md | 2 +- docs/browser-rum.rumglobal.setuser_1.md | 2 +- docs/browser-rum.rumglobal.setuserproperty.md | 2 +- docs/browser-rum.rumglobal.setviewcontext.md | 2 +- ...er-rum.rumglobal.setviewcontextproperty.md | 2 +- docs/browser-rum.rumglobal.setviewname.md | 2 +- ...rowser-rum.rumglobal.startdurationvital.md | 2 +- ...m.rumglobal.startsessionreplayrecording.md | 2 +- docs/browser-rum.rumglobal.startview.md | 2 +- ...browser-rum.rumglobal.stopdurationvital.md | 2 +- docs/browser-rum.rumglobal.stopsession.md | 2 +- ...um.rumglobal.stopsessionreplayrecording.md | 2 +- ...uminitconfiguration.actionnameattribute.md | 2 +- ...ruminitconfiguration.allowedtracingurls.md | 2 +- ...-rum.ruminitconfiguration.applicationid.md | 2 +- ...ser-rum.ruminitconfiguration.beforesend.md | 2 +- ...nitconfiguration.compressintakerequests.md | 2 +- ...uminitconfiguration.defaultprivacylevel.md | 2 +- ...onfiguration.enableprivacyforactionname.md | 2 +- ...minitconfiguration.excludedactivityurls.md | 2 +- docs/browser-rum.ruminitconfiguration.md | 200 +++---------- ...rowser-rum.ruminitconfiguration.plugins.md | 2 +- ...uminitconfiguration.profilingsamplerate.md | 2 +- ...initconfiguration.propagatetracebaggage.md | 2 +- ...initconfiguration.remoteconfigurationid.md | 2 +- ...itconfiguration.sessionreplaysamplerate.md | 2 +- ...ion.startsessionreplayrecordingmanually.md | 2 +- ...wser-rum.ruminitconfiguration.subdomain.md | 2 +- ...initconfiguration.tracecontextinjection.md | 2 +- ...um.ruminitconfiguration.tracesamplerate.md | 2 +- ....ruminitconfiguration.trackbfcacheviews.md | 2 +- ...onfiguration.trackfeatureflagsforevents.md | 2 +- ...rum.ruminitconfiguration.tracklongtasks.md | 2 +- ...rum.ruminitconfiguration.trackresources.md | 2 +- ...initconfiguration.trackuserinteractions.md | 2 +- ...ruminitconfiguration.trackviewsmanually.md | 2 +- ...wser-rum.ruminitconfiguration.workerurl.md | 2 +- docs/browser-rum.rumlongtaskevent.md | 2 +- ...owser-rum.rumlongtaskeventdomaincontext.md | 9 +- ...taskeventdomaincontext.performanceentry.md | 2 +- ...-rum.rumotherresourceeventdomaincontext.md | 9 +- ...urceeventdomaincontext.performanceentry.md | 2 +- docs/browser-rum.rumresourceevent.md | 2 +- docs/browser-rum.rumviewevent.md | 2 +- ...-rum.rumvieweventdomaincontext.location.md | 2 +- docs/browser-rum.rumvieweventdomaincontext.md | 9 +- docs/browser-rum.rumvitalevent.md | 2 +- ...esourceeventdomaincontext.handlingstack.md | 2 +- ...xhrresourceeventdomaincontext.isaborted.md | 2 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 30 +- ...urceeventdomaincontext.performanceentry.md | 2 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 2 +- docs/index.md | 50 ++-- scripts/fix-api-docs.js | 83 ++++++ 214 files changed, 643 insertions(+), 1515 deletions(-) create mode 100644 docs/_layouts/default.html create mode 100644 docs/assets/css/style.scss create mode 100644 scripts/fix-api-docs.js diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 42e9c57dbf..374ccbc97d 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -23,6 +23,15 @@ jobs: - name: Checkout uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '18' + + - name: Fix API documentation links + run: | + node scripts/fix-api-docs.js + - name: Setup Ruby uses: ruby/setup-ruby@v1 with: diff --git a/docs/Gemfile b/docs/Gemfile index 652a011139..8ed6929a67 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,12 +1,9 @@ source "https://rubygems.org" -gem "jekyll", "~> 4.3" -gem "minima", "~> 2.5" - -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.12" -end +# GitHub Pages gem - inclut Jekyll et tous les plugins supportés +gem "github-pages", group: :jekyll_plugins +# Windows et JRuby support platforms :mingw, :x64_mingw, :mswin, :jruby do gem "tzinfo", ">= 1", "< 3" gem "tzinfo-data" diff --git a/docs/_config.yml b/docs/_config.yml index 77b9b0ecdf..6db53f5667 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,8 +3,6 @@ description: 'API documentation for Datadog Browser SDK packages' # Build settings markdown: kramdown -highlighter: rouge -theme: minima # GitHub Pages settings baseurl: '/browser-sdk' @@ -14,25 +12,12 @@ url: 'https://datadoghq.dev' plugins: - jekyll-feed -# Include markdown files -include: - - '*.md' - -# Exclude files from processing -exclude: - - README.md - - LICENSE - - CHANGELOG.md - - node_modules/ - - package.json - - yarn.lock - - Gemfile - - Gemfile.lock - # Kramdown settings kramdown: input: GFM - syntax_highlighter: rouge - syntax_highlighter_opts: - block: - line_numbers: false + hard_wrap: false + parse_block_html: true + parse_span_html: true + html_to_native: true + enable_coderay: false + math_engine: null diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 0000000000..1cd5e0e7e9 --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,62 @@ + + + + + + {{ page.title | default: site.title }} + + + +
+ {{ content }} +
+ + \ No newline at end of file diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss new file mode 100644 index 0000000000..0519ecba6e --- /dev/null +++ b/docs/assets/css/style.scss @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index d63ae48180..f064cea50f 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [datadogLogs](./browser-logs.datadoglogs.md) +[Home](index.html) > @datadog/browser-logs > datadogLogs ## datadogLogs variable diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index b70f91c4f4..7a0bf98754 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [HandlerType](./browser-logs.handlertype.md) +[Home](index.html) > @datadog/browser-logs > HandlerType ## HandlerType variable diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 6f5726d63f..0b99e50081 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [(constructor)](./browser-logs.logger._constructor_.md) +[Home](index.html) > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -37,7 +37,7 @@ handleLogStrategy -(logsMessage: [LogsMessage](./browser-logs.logsmessage.md), logger: [Logger](./browser-logs.logger.md), handlingStack?: string) => void +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void @@ -67,7 +67,7 @@ handlerType -[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] +HandlerType \| HandlerType\[\] @@ -81,12 +81,7 @@ _(Optional)_ level - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType _(Optional)_ diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 4eafe97085..4e5dcbe317 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [alert](./browser-logs.logger.alert.md) +[Home](index.html) > @datadog/browser-logs > Logger > alert ## Logger.alert() method diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 1ef0e01199..65de673baa 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [clearContext](./browser-logs.logger.clearcontext.md) +[Home](index.html) > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 54eb8d73af..f11c919acf 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [critical](./browser-logs.logger.critical.md) +[Home](index.html) > @datadog/browser-logs > Logger > critical ## Logger.critical() method diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 436c88e31b..bc2f820f06 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [debug](./browser-logs.logger.debug.md) +[Home](index.html) > @datadog/browser-logs > Logger > debug ## Logger.debug() method diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index a36c11273f..4108a72ff4 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [emerg](./browser-logs.logger.emerg.md) +[Home](index.html) > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 908171b4bd..60a4094c4f 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [error](./browser-logs.logger.error.md) +[Home](index.html) > @datadog/browser-logs > Logger > error ## Logger.error() method diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index e9091d9050..4d42aa1069 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getContext](./browser-logs.logger.getcontext.md) +[Home](index.html) > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index bdd9e498bb..7967e87831 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getHandler](./browser-logs.logger.gethandler.md) +[Home](index.html) > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 11cec704b2..684b236f0e 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [getLevel](./browser-logs.logger.getlevel.md) +[Home](index.html) > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index 4266726e4c..cae086b467 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [info](./browser-logs.logger.info.md) +[Home](index.html) > @datadog/browser-logs > Logger > info ## Logger.info() method diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 502feca884..8035a63031 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [log](./browser-logs.logger.log.md) +[Home](index.html) > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -63,12 +63,7 @@ _(Optional)_ status - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType _(Optional)_ diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 394b65ed34..cff6883ec2 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [logImplementation](./browser-logs.logger.logimplementation.md) +[Home](index.html) > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -63,12 +63,7 @@ _(Optional)_ status - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType _(Optional)_ diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 48935adfd3..fd5419dbdd 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) +[Home](index.html) > @datadog/browser-logs > Logger ## Logger interface @@ -23,84 +23,39 @@ Description - - -[alert(message, messageContext, error)](./browser-logs.logger.alert.md) - - - +alert(message, messageContext, error) - - -[critical(message, messageContext, error)](./browser-logs.logger.critical.md) - - - +critical(message, messageContext, error) - - -[debug(message, messageContext, error)](./browser-logs.logger.debug.md) - - - +debug(message, messageContext, error) - - -[emerg(message, messageContext, error)](./browser-logs.logger.emerg.md) - - - +emerg(message, messageContext, error) - - -[error(message, messageContext, error)](./browser-logs.logger.error.md) - - - +error(message, messageContext, error) - - -[info(message, messageContext, error)](./browser-logs.logger.info.md) - - - +info(message, messageContext, error) - - -[notice(message, messageContext, error)](./browser-logs.logger.notice.md) - - - +notice(message, messageContext, error) - - -[ok(message, messageContext, error)](./browser-logs.logger.ok.md) - - - +ok(message, messageContext, error) - - -[warn(message, messageContext, error)](./browser-logs.logger.warn.md) - - - +warn(message, messageContext, error) diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index 2ed3948168..d41f62a5f5 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [notice](./browser-logs.logger.notice.md) +[Home](index.html) > @datadog/browser-logs > Logger > notice ## Logger.notice() method diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index a3fff4e0e2..994958db2c 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [ok](./browser-logs.logger.ok.md) +[Home](index.html) > @datadog/browser-logs > Logger > ok ## Logger.ok() method diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index a77c4005c6..94d462f402 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [removeContextProperty](./browser-logs.logger.removecontextproperty.md) +[Home](index.html) > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index a180b803da..8c73b7df2b 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setContext](./browser-logs.logger.setcontext.md) +[Home](index.html) > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index d2c87ba949..1c1d24f86e 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setContextProperty](./browser-logs.logger.setcontextproperty.md) +[Home](index.html) > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index 429b82f9f0..9cde2ba30c 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setHandler](./browser-logs.logger.sethandler.md) +[Home](index.html) > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -35,7 +35,7 @@ handler -[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index faf313ca77..e46b79cfcf 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [setLevel](./browser-logs.logger.setlevel.md) +[Home](index.html) > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -33,12 +33,7 @@ Description level - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 899ed0c326..7ef880c82a 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [Logger](./browser-logs.logger.md) > [warn](./browser-logs.logger.warn.md) +[Home](index.html) > @datadog/browser-logs > Logger > warn ## Logger.warn() method diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index e703f68440..c1d5110f9c 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [context](./browser-logs.loggerconfiguration.context.md) +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index e49f7ce6c5..184a17df02 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [handler](./browser-logs.loggerconfiguration.handler.md) +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 6308843b81..e8bd7a0789 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) > [level](./browser-logs.loggerconfiguration.level.md) +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 1a28967ce5..9066857413 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LoggerConfiguration](./browser-logs.loggerconfiguration.md) +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface @@ -33,12 +33,7 @@ Description - - -[context?](./browser-logs.loggerconfiguration.context.md) - - - +context? @@ -52,17 +47,12 @@ _(Optional)_ - - -[handler?](./browser-logs.loggerconfiguration.handler.md) +handler? - - - -[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] +HandlerType \| HandlerType\[\] @@ -71,20 +61,10 @@ _(Optional)_ - - -[level?](./browser-logs.loggerconfiguration.level.md) +level? - - - - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType _(Optional)_ diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index ed0ca7e273..499d64320d 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [application\_id](./browser-logs.logsevent.application_id.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > application\_id ## LogsEvent.application\_id property diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index eb124dea7c..e1c8d0dc7a 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [date](./browser-logs.logsevent.date.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index f6375002da..6f5c6d24c7 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [error](./browser-logs.logsevent.error.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 1a655934b2..9911cdb758 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [http](./browser-logs.logsevent.http.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 71865f0597..bd730407c0 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [logger](./browser-logs.logsevent.logger.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 9b084c7ded..4274971d98 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent ## LogsEvent interface @@ -33,12 +33,7 @@ Description - - -[application\_id?](./browser-logs.logsevent.application_id.md) - - - +application\_id? @@ -52,12 +47,7 @@ _(Optional)_ UUID of the application - - -[date](./browser-logs.logsevent.date.md) - - - +date @@ -71,12 +61,7 @@ Start of the log in ms from epoch - - -[error?](./browser-logs.logsevent.error.md) - - - +error? @@ -90,12 +75,7 @@ _(Optional)_ Error properties - - -[http?](./browser-logs.logsevent.http.md) - - - +http? @@ -109,12 +89,7 @@ _(Optional)_ Resource properties of the error - - -[logger?](./browser-logs.logsevent.logger.md) - - - +logger? @@ -128,12 +103,7 @@ _(Optional)_ Logger properties - - -[message](./browser-logs.logsevent.message.md) - - - +message @@ -147,12 +117,7 @@ The log message - - -[origin](./browser-logs.logsevent.origin.md) - - - +origin @@ -166,12 +131,7 @@ Origin of the log - - -[service?](./browser-logs.logsevent.service.md) - - - +service? @@ -185,12 +145,7 @@ _(Optional)_ The service name - - -[session\_id?](./browser-logs.logsevent.session_id.md) - - - +session\_id? @@ -204,12 +159,7 @@ _(Optional)_ UUID of the session (deprecated in favor of session.id) - - -[session?](./browser-logs.logsevent.session.md) - - - +session? @@ -223,12 +173,7 @@ _(Optional)_ Session properties - - -[status](./browser-logs.logsevent.status.md) - - - +status @@ -242,12 +187,7 @@ The log status - - -[view](./browser-logs.logsevent.view.md) - - - +view diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index b885d16a60..34d89871bd 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [message](./browser-logs.logsevent.message.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 774dac3ef9..d8636f0b36 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [origin](./browser-logs.logsevent.origin.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index c2b4e51a6f..a02ccf4524 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [service](./browser-logs.logsevent.service.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 802a18bafe..f23270716f 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [session](./browser-logs.logsevent.session.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 42d6204c28..098d996c79 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [session\_id](./browser-logs.logsevent.session_id.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > session\_id ## LogsEvent.session\_id property diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 30f49e0660..82cc7daa8f 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [status](./browser-logs.logsevent.status.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 1823fa2642..88a5cf0821 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEvent](./browser-logs.logsevent.md) > [view](./browser-logs.logsevent.view.md) +[Home](index.html) > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index d6ac5e49f4..3ae1135a47 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsEventDomainContext](./browser-logs.logseventdomaincontext.md) +[Home](index.html) > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index 93b14f6568..fba8b86689 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearAccount](./browser-logs.logsglobal.clearaccount.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index f011c75030..f70acc9853 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearGlobalContext](./browser-logs.logsglobal.clearglobalcontext.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index ee1ef67d15..ad75ee0df6 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [clearUser](./browser-logs.logsglobal.clearuser.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 1f420e1d8b..d747b25fde 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [createLogger](./browser-logs.logsglobal.createlogger.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index c35a4aba7b..e925769dd5 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getAccount](./browser-logs.logsglobal.getaccount.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index e4d7c4ba4c..d28b667041 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getGlobalContext](./browser-logs.logsglobal.getglobalcontext.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index e1f2c4db2c..3dc2f5111c 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getInitConfiguration](./browser-logs.logsglobal.getinitconfiguration.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index 957235379e..a55202a226 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getInternalContext](./browser-logs.logsglobal.getinternalcontext.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 092fa0586b..60b2c9ca97 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getLogger](./browser-logs.logsglobal.getlogger.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 14144d86dc..ac23277703 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [getUser](./browser-logs.logsglobal.getuser.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 6d8a8b3a77..24e2c19f85 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [init](./browser-logs.logsglobal.init.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index aa7d9de05d..a94c80c26d 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [logger](./browser-logs.logsglobal.logger.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 1cd2967b47..71cc481aa5 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface @@ -34,12 +34,7 @@ Description - - -[clearAccount](./browser-logs.logsglobal.clearaccount.md) - - - +clearAccount @@ -53,12 +48,7 @@ Clear all account information - - -[clearGlobalContext](./browser-logs.logsglobal.clearglobalcontext.md) - - - +clearGlobalContext @@ -70,16 +60,11 @@ Clear all account information Clear the global context -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. +See \Overwrite context\ for further information. - - -[clearUser](./browser-logs.logsglobal.clearuser.md) - - - +clearUser @@ -91,37 +76,27 @@ See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javasc Clear all user information -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. +See \User context\ for further information. - - -[createLogger](./browser-logs.logsglobal.createlogger.md) +createLogger - - - -(name: string, conf?: [LoggerConfiguration](./browser-logs.loggerconfiguration.md)) => [Logger](./browser-logs.logger.md) +(name: string, conf?: LoggerConfiguration) => Logger The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. +See \Define multiple loggers\ for further information. - - -[getAccount](./browser-logs.logsglobal.getaccount.md) - - - +getAccount @@ -135,12 +110,7 @@ Get account information - - -[getGlobalContext](./browser-logs.logsglobal.getglobalcontext.md) - - - +getGlobalContext @@ -152,21 +122,16 @@ Get account information Get the global Context -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. +See \Overwrite context\ for further information. - - -[getInitConfiguration](./browser-logs.logsglobal.getinitconfiguration.md) +getInitConfiguration - - - -() => [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) \| undefined +() => LogsInitConfiguration \| undefined @@ -175,12 +140,7 @@ Get the init configuration - - -[getInternalContext](./browser-logs.logsglobal.getinternalcontext.md) - - - +getInternalContext @@ -192,37 +152,27 @@ Get the init configuration \[Internal API\] Get the internal SDK context -See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. +See \Access internal context\ for further information. - - -[getLogger](./browser-logs.logsglobal.getlogger.md) - - - +getLogger -(name: string) => [Logger](./browser-logs.logger.md) \| undefined +(name: string) => Logger \| undefined Get a logger -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. +See \Define multiple loggers\ for further information. - - -[getUser](./browser-logs.logsglobal.getuser.md) - - - +getUser @@ -234,21 +184,16 @@ See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/ Get user information -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. +See \User context\ for further information. - - -[init](./browser-logs.logsglobal.init.md) - - - +init -(initConfiguration: [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md)) => void +(initConfiguration: LogsInitConfiguration) => void @@ -257,29 +202,14 @@ Init the Logs browser SDK. - - -[logger](./browser-logs.logsglobal.logger.md) - - - +logger - - -[Logger](./browser-logs.logger.md) - - - +Logger - - -[removeAccountProperty](./browser-logs.logsglobal.removeaccountproperty.md) - - - +removeAccountProperty @@ -293,12 +223,7 @@ Remove an account property - - -[removeGlobalContextProperty](./browser-logs.logsglobal.removeglobalcontextproperty.md) - - - +removeGlobalContextProperty @@ -310,16 +235,11 @@ Remove an account property Remove a global context property -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. +See \Overwrite context\ for further information. - - -[removeUserProperty](./browser-logs.logsglobal.removeuserproperty.md) - - - +removeUserProperty @@ -331,16 +251,11 @@ See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javasc Remove a user property -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. +See \User context\ for further information. - - -[setAccount](./browser-logs.logsglobal.setaccount.md) - - - +setAccount @@ -354,12 +269,7 @@ Set account information to all events, stored in `@account` - - -[setAccountProperty](./browser-logs.logsglobal.setaccountproperty.md) - - - +setAccountProperty @@ -373,12 +283,7 @@ Set or update the account property, stored in `@account.` - - -[setGlobalContext](./browser-logs.logsglobal.setglobalcontext.md) - - - +setGlobalContext @@ -392,12 +297,7 @@ Set the global context information to all logs, stored in `@context` - - -[setGlobalContextProperty](./browser-logs.logsglobal.setglobalcontextproperty.md) - - - +setGlobalContextProperty @@ -411,12 +311,7 @@ Set or update a global context property, stored in `@context.` - - -[setTrackingConsent](./browser-logs.logsglobal.settrackingconsent.md) - - - +setTrackingConsent @@ -430,12 +325,7 @@ Set the tracking consent of the current user. - - -[setUserProperty](./browser-logs.logsglobal.setuserproperty.md) - - - +setUserProperty @@ -464,25 +354,15 @@ Description - - -[setUser(newUser)](./browser-logs.logsglobal.setuser.md) - - - +setUser(newUser) Set user information to all events, stored in `@usr` -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. +See \User context\ for further information. - - -[setUser(newUser)](./browser-logs.logsglobal.setuser_1.md) - - - +setUser(newUser) Set user information to all events, stored in `@usr` diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index ae3276cc27..495f21977a 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeAccountProperty](./browser-logs.logsglobal.removeaccountproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index db1094e668..a7a626b26d 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeGlobalContextProperty](./browser-logs.logsglobal.removeglobalcontextproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 09339e7712..941e0422a4 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [removeUserProperty](./browser-logs.logsglobal.removeuserproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index ceceaaa140..37b40e0eff 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setAccount](./browser-logs.logsglobal.setaccount.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index fdf63305d8..1f2361d032 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setAccountProperty](./browser-logs.logsglobal.setaccountproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index 958e929a36..1dc712cdd2 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setGlobalContext](./browser-logs.logsglobal.setglobalcontext.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index ca58b0e3a2..912b589ca7 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setGlobalContextProperty](./browser-logs.logsglobal.setglobalcontextproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 839ef98180..53eed52624 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setTrackingConsent](./browser-logs.logsglobal.settrackingconsent.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 34f100a2fe..d17bd3b963 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUser](./browser-logs.logsglobal.setuser.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 80b3cf568f..3672c9a314 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUser](./browser-logs.logsglobal.setuser_1.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 1e779fc935..e61551e375 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsGlobal](./browser-logs.logsglobal.md) > [setUserProperty](./browser-logs.logsglobal.setuserproperty.md) +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index 0f0298c081..113a1f8259 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [beforeSend](./browser-logs.logsinitconfiguration.beforesend.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index e9f42bee9f..e050d67c7e 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardConsoleLogs](./browser-logs.logsinitconfiguration.forwardconsolelogs.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index 22b37a6b52..0bd7c189ec 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardErrorsToLogs](./browser-logs.logsinitconfiguration.forwarderrorstologs.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index e5fb2e5641..9187f105a3 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [forwardReports](./browser-logs.logsinitconfiguration.forwardreports.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index f73f951da0..fa013c4377 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface @@ -34,17 +34,12 @@ Description - - -[beforeSend?](./browser-logs.logsinitconfiguration.beforesend.md) +beforeSend? - - - -((event: [LogsEvent](./browser-logs.logsevent.md), context: [LogsEventDomainContext](./browser-logs.logseventdomaincontext.md)) => boolean) \| undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined @@ -53,12 +48,7 @@ _(Optional)_ Access to every logs collected by the Logs SDK before they are sent - - -[forwardConsoleLogs?](./browser-logs.logsinitconfiguration.forwardconsolelogs.md) - - - +forwardConsoleLogs? @@ -72,12 +62,7 @@ _(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward every - - -[forwardErrorsToLogs?](./browser-logs.logsinitconfiguration.forwarderrorstologs.md) - - - +forwardErrorsToLogs? @@ -91,12 +76,7 @@ _(Optional)_ Forward console.error logs, uncaught exceptions and network errors - - -[forwardReports?](./browser-logs.logsinitconfiguration.forwardreports.md) - - - +forwardReports? @@ -106,16 +86,11 @@ RawReportType\[\] \| 'all' \| undefined -_(Optional)_ Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. - - -[usePciIntake?](./browser-logs.logsinitconfiguration.usepciintake.md) - - - +usePciIntake? @@ -125,7 +100,7 @@ boolean -_(Optional)_ Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false +_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 5fe28acdc2..250b9efba7 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) > [usePciIntake](./browser-logs.logsinitconfiguration.usepciintake.md) +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 74e411863e..9665aa382b 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [context](./browser-logs.logsmessage.context.md) +[Home](index.html) > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 597307fc9c..1a6b06743a 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) +[Home](index.html) > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -33,12 +33,7 @@ Description - - -[context?](./browser-logs.logsmessage.context.md) - - - +context? @@ -52,12 +47,7 @@ _(Optional)_ - - -[message](./browser-logs.logsmessage.message.md) - - - +message @@ -69,20 +59,10 @@ string - - -[status](./browser-logs.logsmessage.status.md) +status - - - - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index a9110aacc0..9fe6e2870d 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [message](./browser-logs.logsmessage.message.md) +[Home](index.html) > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 39a33dc74f..9f21c4a5ec 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [LogsMessage](./browser-logs.logsmessage.md) > [status](./browser-logs.logsmessage.status.md) +[Home](index.html) > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 8c4fe87ad1..fd02a380e7 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) +[Home](index.html) > @datadog/browser-logs ## browser-logs package @@ -17,12 +17,7 @@ Description - - -[Logger](./browser-logs.logger.md) - - - +Logger @@ -41,57 +36,27 @@ Description - - -[Logger](./browser-logs.logger.md) - - - +Logger - - -[LoggerConfiguration](./browser-logs.loggerconfiguration.md) - - - +LoggerConfiguration - - -[LogsEvent](./browser-logs.logsevent.md) - - - +LogsEvent - - -[LogsGlobal](./browser-logs.logsglobal.md) - - - +LogsGlobal - - -[LogsInitConfiguration](./browser-logs.logsinitconfiguration.md) - - - +LogsInitConfiguration - - -[LogsMessage](./browser-logs.logsmessage.md) - - - +LogsMessage @@ -110,30 +75,15 @@ Description - - -[datadogLogs](./browser-logs.datadoglogs.md) - - - +datadogLogs - - -[HandlerType](./browser-logs.handlertype.md) - - - +HandlerType - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType @@ -152,30 +102,15 @@ Description - - -[HandlerType](./browser-logs.handlertype.md) - - - +HandlerType - - -[LogsEventDomainContext](./browser-logs.logseventdomaincontext.md) - - - +LogsEventDomainContext - - -[StatusType](./browser-logs.statustype.md) - - - +StatusType diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index f0c2952fa7..b90df513dc 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-logs](./browser-logs.md) > [StatusType](./browser-logs.statustype.md) +[Home](index.html) > @datadog/browser-logs > StatusType ## StatusType variable diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 10e44ca54a..b14e46128f 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [addReactError](./browser-rum-react.addreacterror.md) +[Home](index.html) > @datadog/browser-rum-react > addReactError ## addReactError() function diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 4c94bc4bab..c48ab3bb5c 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [(constructor)](./browser-rum-react.errorboundary._constructor_.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 0ba5ed93a7..acbd5e0f3f 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [componentDidCatch](./browser-rum-react.errorboundary.componentdidcatch.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 136a142feb..b4e3372e47 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [getDerivedStateFromError](./browser-rum-react.errorboundary.getderivedstatefromerror.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index e57f3c00e0..22ebac85d6 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class @@ -29,12 +29,7 @@ Description - - -[(constructor)(props)](./browser-rum-react.errorboundary._constructor_.md) - - - +(constructor)(props) @@ -68,12 +63,7 @@ Description - - -[resetError](./browser-rum-react.errorboundary.reseterror.md) - - - +resetError @@ -105,24 +95,14 @@ Description - - -[componentDidCatch(error, errorInfo)](./browser-rum-react.errorboundary.componentdidcatch.md) - - - +componentDidCatch(error, errorInfo) - - -[getDerivedStateFromError(error)](./browser-rum-react.errorboundary.getderivedstatefromerror.md) - - - +getDerivedStateFromError(error) `static` @@ -131,12 +111,7 @@ Description - - -[render()](./browser-rum-react.errorboundary.render.md) - - - +render() diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 59104a5388..7d3d23d667 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [render](./browser-rum-react.errorboundary.render.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index a15c2f05c2..ad8112fbda 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [ErrorBoundary](./browser-rum-react.errorboundary.md) > [resetError](./browser-rum-react.errorboundary.reseterror.md) +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 3e5c1f343c..d980c3ec65 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) +[Home](index.html) > @datadog/browser-rum-react ## browser-rum-react package @@ -17,12 +17,7 @@ Description - - -[ErrorBoundary](./browser-rum-react.errorboundary.md) - - - +ErrorBoundary @@ -41,21 +36,11 @@ Description - - -[addReactError(error, info)](./browser-rum-react.addreacterror.md) - - - +addReactError(error, info) - - -[reactPlugin(configuration)](./browser-rum-react.reactplugin.md) - - - +reactPlugin(configuration) @@ -74,12 +59,7 @@ Description - - -[UNSTABLE\_ReactComponentTracker](./browser-rum-react.unstable_reactcomponenttracker.md) - - - +UNSTABLE\_ReactComponentTracker diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 14abf1f0ec..dae5012a46 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [reactPlugin](./browser-rum-react.reactplugin.md) +[Home](index.html) > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 5f6e8c67ff..969e542421 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-react](./browser-rum-react.md) > [UNSTABLE\_ReactComponentTracker](./browser-rum-react.unstable_reactcomponenttracker.md) +[Home](index.html) > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker ## UNSTABLE\_ReactComponentTracker variable diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index a7169f2ae2..782acb9e0d 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-slim](./browser-rum-slim.md) > [datadogRum](./browser-rum-slim.datadogrum.md) +[Home](index.html) > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index ffa0ea6342..d7b1d56aae 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum-slim](./browser-rum-slim.md) +[Home](index.html) > @datadog/browser-rum-slim ## browser-rum-slim package @@ -17,12 +17,7 @@ Description - - -[datadogRum](./browser-rum-slim.datadogrum.md) - - - +datadogRum diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 6b578e5e1d..750fa31f36 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [\_dd](./browser-rum.commonproperties._dd.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > \_dd ## CommonProperties.\_dd property diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 75f5f1fa6b..98aecc2164 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [account](./browser-rum.commonproperties.account.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index 8bfcccd067..fdb5f90184 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [application](./browser-rum.commonproperties.application.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 25eaae7531..5df6d027b9 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [build\_id](./browser-rum.commonproperties.build_id.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > build\_id ## CommonProperties.build\_id property diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 9e7f2b9168..d0072260a0 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [build\_version](./browser-rum.commonproperties.build_version.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > build\_version ## CommonProperties.build\_version property diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 2163f5003b..f1fbe23c5b 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [ci\_test](./browser-rum.commonproperties.ci_test.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > ci\_test ## CommonProperties.ci\_test property diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 4151bfb45a..8e0ec46ed7 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [connectivity](./browser-rum.commonproperties.connectivity.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index cb7e686953..770edb06c3 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [context](./browser-rum.commonproperties.context.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index ec436b6f5b..f792d7cf3c 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [date](./browser-rum.commonproperties.date.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index 541c71ad3e..6027154b29 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [device](./browser-rum.commonproperties.device.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 8e002da646..e684c6f119 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [display](./browser-rum.commonproperties.display.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 61dd5d3c19..8badf26cf8 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -35,12 +35,7 @@ Description - - -[\_dd](./browser-rum.commonproperties._dd.md) - - - +\_dd `readonly` @@ -56,12 +51,7 @@ Internal properties - - -[account?](./browser-rum.commonproperties.account.md) - - - +account? `readonly` @@ -77,12 +67,7 @@ _(Optional)_ Account properties - - -[application](./browser-rum.commonproperties.application.md) - - - +application `readonly` @@ -98,12 +83,7 @@ Application properties - - -[build\_id?](./browser-rum.commonproperties.build_id.md) - - - +build\_id? `readonly` @@ -119,12 +99,7 @@ _(Optional)_ Generated unique ID of the application build. Unlike version or bui - - -[build\_version?](./browser-rum.commonproperties.build_version.md) - - - +build\_version? `readonly` @@ -140,12 +115,7 @@ _(Optional)_ The build version for this application - - -[ci\_test?](./browser-rum.commonproperties.ci_test.md) - - - +ci\_test? `readonly` @@ -161,12 +131,7 @@ _(Optional)_ CI Visibility properties - - -[connectivity?](./browser-rum.commonproperties.connectivity.md) - - - +connectivity? @@ -180,12 +145,7 @@ _(Optional)_ Device connectivity properties - - -[context?](./browser-rum.commonproperties.context.md) - - - +context? @@ -199,12 +159,7 @@ _(Optional)_ User provided context - - -[date](./browser-rum.commonproperties.date.md) - - - +date `readonly` @@ -220,12 +175,7 @@ Start of the event in ms from epoch - - -[device?](./browser-rum.commonproperties.device.md) - - - +device? @@ -239,12 +189,7 @@ _(Optional)_ Device properties - - -[display?](./browser-rum.commonproperties.display.md) - - - +display? @@ -258,12 +203,7 @@ _(Optional)_ Display properties - - -[os?](./browser-rum.commonproperties.os.md) - - - +os? @@ -277,12 +217,7 @@ _(Optional)_ Operating system properties - - -[service?](./browser-rum.commonproperties.service.md) - - - +service? @@ -296,12 +231,7 @@ _(Optional)_ The service name for this application - - -[session](./browser-rum.commonproperties.session.md) - - - +session `readonly` @@ -317,12 +247,7 @@ Session properties - - -[source?](./browser-rum.commonproperties.source.md) - - - +source? `readonly` @@ -338,12 +263,7 @@ _(Optional)_ The source of this event - - -[synthetics?](./browser-rum.commonproperties.synthetics.md) - - - +synthetics? `readonly` @@ -359,12 +279,7 @@ _(Optional)_ Synthetics properties - - -[usr?](./browser-rum.commonproperties.usr.md) - - - +usr? `readonly` @@ -380,12 +295,7 @@ _(Optional)_ User properties - - -[version?](./browser-rum.commonproperties.version.md) - - - +version? @@ -399,12 +309,7 @@ _(Optional)_ The version for this application - - -[view](./browser-rum.commonproperties.view.md) - - - +view `readonly` diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index de823a4dec..0ffb1e0ca6 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [os](./browser-rum.commonproperties.os.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index d1a723a885..8312b10a9f 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [service](./browser-rum.commonproperties.service.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index 44231dbf19..0ee51ed666 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [session](./browser-rum.commonproperties.session.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index b7b95961a8..49f6472d37 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [source](./browser-rum.commonproperties.source.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 7bafd41fed..75f3a7702e 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [synthetics](./browser-rum.commonproperties.synthetics.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index fb7e4615c2..b28bb859b5 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [usr](./browser-rum.commonproperties.usr.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 7e7db354d1..fd63365165 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [version](./browser-rum.commonproperties.version.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index 93bc4d48a6..e9fb8b0cb1 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [CommonProperties](./browser-rum.commonproperties.md) > [view](./browser-rum.commonproperties.view.md) +[Home](index.html) > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 8f426c7d49..90be04739b 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [datadogRum](./browser-rum.datadogrum.md) +[Home](index.html) > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 13b6eaae58..a8e72c2601 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) +[Home](index.html) > @datadog/browser-rum ## browser-rum package @@ -17,95 +17,45 @@ Description - - -[CommonProperties](./browser-rum.commonproperties.md) - - - +CommonProperties Schema of common properties of RUM events - - -[RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) - - - +RumActionEventDomainContext - - -[RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) - - - +RumErrorEventDomainContext - - -[RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) - - - +RumFetchResourceEventDomainContext - - -[RumGlobal](./browser-rum.rumglobal.md) - - - +RumGlobal - - -[RumInitConfiguration](./browser-rum.ruminitconfiguration.md) - - - +RumInitConfiguration - - -[RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) - - - +RumLongTaskEventDomainContext - - -[RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) - - - +RumOtherResourceEventDomainContext - - -[RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) - - - +RumViewEventDomainContext - - -[RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) - - - +RumXhrResourceEventDomainContext @@ -124,12 +74,7 @@ Description - - -[datadogRum](./browser-rum.datadogrum.md) - - - +datadogRum @@ -148,87 +93,47 @@ Description - - -[RumActionEvent](./browser-rum.rumactionevent.md) - - - +RumActionEvent Schema of all properties of an Action event - - -[RumErrorEvent](./browser-rum.rumerrorevent.md) - - - +RumErrorEvent Schema of all properties of an Error event - - -[RumEvent](./browser-rum.rumevent.md) - - - +RumEvent Schema of all properties of a RUM event - - -[RumEventDomainContext](./browser-rum.rumeventdomaincontext.md) - - - +RumEventDomainContext - - -[RumLongTaskEvent](./browser-rum.rumlongtaskevent.md) - - - +RumLongTaskEvent Schema of all properties of a Long Task event - - -[RumResourceEvent](./browser-rum.rumresourceevent.md) - - - +RumResourceEvent Schema of all properties of a Resource event - - -[RumViewEvent](./browser-rum.rumviewevent.md) - - - +RumViewEvent Schema of all properties of a View event - - -[RumVitalEvent](./browser-rum.rumvitalevent.md) - - - +RumVitalEvent Schema of all properties of a Vital event diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 95683a12b1..cd7d82a026 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEvent](./browser-rum.rumactionevent.md) +[Home](index.html) > @datadog/browser-rum > RumActionEvent ## RumActionEvent type diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index ee1da6f454..4347b4fdc7 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) > [events](./browser-rum.rumactioneventdomaincontext.events.md) +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 00b729c00e..c5034c308f 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) > [handlingStack](./browser-rum.rumactioneventdomaincontext.handlingstack.md) +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 18c9e5198f..4ede6d3b25 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[events?](./browser-rum.rumactioneventdomaincontext.events.md) - - - +events? @@ -52,12 +47,7 @@ _(Optional)_ - - -[handlingStack?](./browser-rum.rumactioneventdomaincontext.handlingstack.md) - - - +handlingStack? diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index af44321526..92c6f306e4 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEvent](./browser-rum.rumerrorevent.md) +[Home](index.html) > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 07b86a62c7..20dca2e9db 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) > [error](./browser-rum.rumerroreventdomaincontext.error.md) +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index a34386757b..375e308535 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) > [handlingStack](./browser-rum.rumerroreventdomaincontext.handlingstack.md) +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 144dc2e01c..f75af78ce6 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[error](./browser-rum.rumerroreventdomaincontext.error.md) - - - +error @@ -50,12 +45,7 @@ unknown - - -[handlingStack?](./browser-rum.rumerroreventdomaincontext.handlingstack.md) - - - +handlingStack? diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 33ce6e8059..ca11de07b5 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumEvent](./browser-rum.rumevent.md) +[Home](index.html) > @datadog/browser-rum > RumEvent ## RumEvent type diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index c232bce44c..22a6f63243 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumEventDomainContext](./browser-rum.rumeventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 4d79f74441..5965c8c603 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [error](./browser-rum.rumfetchresourceeventdomaincontext.error.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index ec51e5665f..928e81f8ae 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [handlingStack](./browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 84bcee1ea4..7125b554b4 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [isAborted](./browser-rum.rumfetchresourceeventdomaincontext.isaborted.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 037e85bf86..013d077804 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[error?](./browser-rum.rumfetchresourceeventdomaincontext.error.md) - - - +error? @@ -52,12 +47,7 @@ _(Optional)_ - - -[handlingStack?](./browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md) - - - +handlingStack? @@ -71,12 +61,7 @@ _(Optional)_ - - -[isAborted](./browser-rum.rumfetchresourceeventdomaincontext.isaborted.md) - - - +isAborted @@ -88,12 +73,7 @@ boolean - - -[performanceEntry?](./browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md) - - - +performanceEntry? @@ -107,12 +87,7 @@ _(Optional)_ - - -[requestInit?](./browser-rum.rumfetchresourceeventdomaincontext.requestinit.md) - - - +requestInit? @@ -126,12 +101,7 @@ _(Optional)_ - - -[requestInput](./browser-rum.rumfetchresourceeventdomaincontext.requestinput.md) - - - +requestInput @@ -143,12 +113,7 @@ RequestInfo - - -[response?](./browser-rum.rumfetchresourceeventdomaincontext.response.md) - - - +response? diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 6598327071..65dfa2ca84 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 17e9697eb8..137efdcf0d 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [requestInit](./browser-rum.rumfetchresourceeventdomaincontext.requestinit.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index a4a6ebcb19..afe134436c 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [requestInput](./browser-rum.rumfetchresourceeventdomaincontext.requestinput.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index faae9fb0e5..99b2be672b 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md) > [response](./browser-rum.rumfetchresourceeventdomaincontext.response.md) +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 10288771cb..4eefca4332 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addAction](./browser-rum.rumglobal.addaction.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index c2616c339c..3fcd880e7d 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addDurationVital](./browser-rum.rumglobal.adddurationvital.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index 82b2c38810..9b9bb6f4cc 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addError](./browser-rum.rumglobal.adderror.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 5201237968..9a361d4204 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addFeatureFlagEvaluation](./browser-rum.rumglobal.addfeatureflagevaluation.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index b86ec8fb7c..56c6feb657 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [addTiming](./browser-rum.rumglobal.addtiming.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index b405a5cd27..9dd5739fca 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearAccount](./browser-rum.rumglobal.clearaccount.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index b4454d9b05..aff7820af7 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearGlobalContext](./browser-rum.rumglobal.clearglobalcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index b832f58248..5ca3eea115 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [clearUser](./browser-rum.rumglobal.clearuser.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index 114a476219..e6fe727326 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getAccount](./browser-rum.rumglobal.getaccount.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 0986d24876..12f6b8ab44 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getGlobalContext](./browser-rum.rumglobal.getglobalcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 9baebc09ac..2f59bd8dc6 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getInitConfiguration](./browser-rum.rumglobal.getinitconfiguration.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index b76f162af9..a1f0f79cbd 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getInternalContext](./browser-rum.rumglobal.getinternalcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index bcd7602159..bdbfbeb2de 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getSessionReplayLink](./browser-rum.rumglobal.getsessionreplaylink.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index e373ef5af5..d7bc50d723 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getUser](./browser-rum.rumglobal.getuser.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 10aba554f2..c4b60a615d 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [getViewContext](./browser-rum.rumglobal.getviewcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 3dc614c3c4..6f7f24c4cf 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [init](./browser-rum.rumglobal.init.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index cbf2faca90..dd5fab4230 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal ## RumGlobal interface @@ -34,12 +34,7 @@ Description - - -[addAction](./browser-rum.rumglobal.addaction.md) - - - +addAction @@ -53,12 +48,7 @@ Add a custom action, stored in `@action` - - -[addDurationVital](./browser-rum.rumglobal.adddurationvital.md) - - - +addDurationVital @@ -72,12 +62,7 @@ Add a custom duration vital - - -[addError](./browser-rum.rumglobal.adderror.md) - - - +addError @@ -91,12 +76,7 @@ Add a custom error, stored in `@error`. - - -[addFeatureFlagEvaluation](./browser-rum.rumglobal.addfeatureflagevaluation.md) - - - +addFeatureFlagEvaluation @@ -110,12 +90,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` - - -[addTiming](./browser-rum.rumglobal.addtiming.md) - - - +addTiming @@ -129,12 +104,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. - - -[clearAccount](./browser-rum.rumglobal.clearaccount.md) - - - +clearAccount @@ -148,12 +118,7 @@ Clear all account information - - -[clearGlobalContext](./browser-rum.rumglobal.clearglobalcontext.md) - - - +clearGlobalContext @@ -165,16 +130,11 @@ Clear all account information Clear the global context -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. +See \Global context\ for further information. - - -[clearUser](./browser-rum.rumglobal.clearuser.md) - - - +clearUser @@ -186,16 +146,11 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser Clear all user information -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. +See \User session\ for further information. - - -[getAccount](./browser-rum.rumglobal.getaccount.md) - - - +getAccount @@ -209,12 +164,7 @@ Get account information - - -[getGlobalContext](./browser-rum.rumglobal.getglobalcontext.md) - - - +getGlobalContext @@ -226,21 +176,16 @@ Get account information Get the global Context -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. +See \Global context\ for further information. - - -[getInitConfiguration](./browser-rum.rumglobal.getinitconfiguration.md) +getInitConfiguration - - - -() => [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) \| undefined +() => RumInitConfiguration \| undefined @@ -249,12 +194,7 @@ Get the init configuration - - -[getInternalContext](./browser-rum.rumglobal.getinternalcontext.md) - - - +getInternalContext @@ -268,12 +208,7 @@ Get the init configuration - - -[getSessionReplayLink](./browser-rum.rumglobal.getsessionreplaylink.md) - - - +getSessionReplayLink @@ -285,16 +220,11 @@ Get the init configuration Get the Session Replay Link. -See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. +See \Connect Session Replay To Your Third-Party Tools\ for further information. - - -[getUser](./browser-rum.rumglobal.getuser.md) - - - +getUser @@ -306,16 +236,11 @@ See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq. Get user information -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. +See \User session\ for further information. - - -[getViewContext](./browser-rum.rumglobal.getviewcontext.md) - - - +getViewContext @@ -329,17 +254,12 @@ Get View Context. - - -[init](./browser-rum.rumglobal.init.md) - - - +init -(initConfiguration: [RumInitConfiguration](./browser-rum.ruminitconfiguration.md)) => void +(initConfiguration: RumInitConfiguration) => void @@ -348,12 +268,7 @@ Init the RUM browser SDK. - - -[removeAccountProperty](./browser-rum.rumglobal.removeaccountproperty.md) - - - +removeAccountProperty @@ -367,12 +282,7 @@ Remove an account property - - -[removeGlobalContextProperty](./browser-rum.rumglobal.removeglobalcontextproperty.md) - - - +removeGlobalContextProperty @@ -384,16 +294,11 @@ Remove an account property Remove a global context property -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. +See \Global context\ for further information. - - -[removeUserProperty](./browser-rum.rumglobal.removeuserproperty.md) - - - +removeUserProperty @@ -405,16 +310,11 @@ See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser Remove a user property -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. +See \User session\ for further information. - - -[setAccount](./browser-rum.rumglobal.setaccount.md) - - - +setAccount @@ -428,12 +328,7 @@ Set account information to all events, stored in `@account` - - -[setAccountProperty](./browser-rum.rumglobal.setaccountproperty.md) - - - +setAccountProperty @@ -447,12 +342,7 @@ Set or update the account property, stored in `@account.` - - -[setGlobalContext](./browser-rum.rumglobal.setglobalcontext.md) - - - +setGlobalContext @@ -466,12 +356,7 @@ Set the global context information to all events, stored in `@context` - - -[setGlobalContextProperty](./browser-rum.rumglobal.setglobalcontextproperty.md) - - - +setGlobalContextProperty @@ -485,12 +370,7 @@ Set or update a global context property, stored in `@context.` - - -[setTrackingConsent](./browser-rum.rumglobal.settrackingconsent.md) - - - +setTrackingConsent @@ -504,12 +384,7 @@ Set the tracking consent of the current user. - - -[setUserProperty](./browser-rum.rumglobal.setuserproperty.md) - - - +setUserProperty @@ -523,12 +398,7 @@ Set or update the user property, stored in `@usr.` - - -[setViewContext](./browser-rum.rumglobal.setviewcontext.md) - - - +setViewContext @@ -544,12 +414,7 @@ Enable to manually set the context of the current view. - - -[setViewContextProperty](./browser-rum.rumglobal.setviewcontextproperty.md) - - - +setViewContextProperty @@ -565,12 +430,7 @@ Enable to manually set a property of the context of the current view. - - -[setViewName](./browser-rum.rumglobal.setviewname.md) - - - +setViewName @@ -586,12 +446,7 @@ Enable to manually change the name of the current view. - - -[startDurationVital](./browser-rum.rumglobal.startdurationvital.md) - - - +startDurationVital @@ -607,12 +462,7 @@ If you plan to have multiple durations for the same vital, you should use the re - - -[startSessionReplayRecording](./browser-rum.rumglobal.startsessionreplayrecording.md) - - - +startSessionReplayRecording @@ -624,16 +474,11 @@ If you plan to have multiple durations for the same vital, you should use the re Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. +See \Browser Session Replay\ for further information. - - -[startView](./browser-rum.rumglobal.startview.md) - - - +startView @@ -647,12 +492,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t - - -[stopDurationVital](./browser-rum.rumglobal.stopdurationvital.md) - - - +stopDurationVital @@ -666,12 +506,7 @@ Stop a custom duration vital - - -[stopSession](./browser-rum.rumglobal.stopsession.md) - - - +stopSession @@ -685,12 +520,7 @@ Stop the session. A new session will start at the next user interaction with the - - -[stopSessionReplayRecording](./browser-rum.rumglobal.stopsessionreplayrecording.md) - - - +stopSessionReplayRecording @@ -702,7 +532,7 @@ Stop the session. A new session will start at the next user interaction with the Stop Session Replay recording. -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. +See \Browser Session Replay\ for further information. @@ -721,25 +551,15 @@ Description - - -[setUser(newUser)](./browser-rum.rumglobal.setuser.md) - - - +setUser(newUser) Set user information to all events, stored in `@usr` -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. +See \User session\ for further information. - - -[setUser(newUser)](./browser-rum.rumglobal.setuser_1.md) - - - +setUser(newUser) Set user information to all events, stored in `@usr` diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index b25a09766a..ede8941973 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeAccountProperty](./browser-rum.rumglobal.removeaccountproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index a03e7ea84f..15a1226f56 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeGlobalContextProperty](./browser-rum.rumglobal.removeglobalcontextproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 8a0c8487ad..1361077718 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [removeUserProperty](./browser-rum.rumglobal.removeuserproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 12926738fb..c275a22cbd 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setAccount](./browser-rum.rumglobal.setaccount.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 6ec0626be0..fbdb0f49bb 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setAccountProperty](./browser-rum.rumglobal.setaccountproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 342239b8c6..d58f69ec60 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setGlobalContext](./browser-rum.rumglobal.setglobalcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 10f1898f4a..90000fa818 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setGlobalContextProperty](./browser-rum.rumglobal.setglobalcontextproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 9fcfe4cbff..92d915b2f9 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setTrackingConsent](./browser-rum.rumglobal.settrackingconsent.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index bcac763970..f93ac6e3ff 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUser](./browser-rum.rumglobal.setuser.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 28ba53adc8..da7de92906 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUser](./browser-rum.rumglobal.setuser_1.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 2f1ad618a8..704a73ee17 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setUserProperty](./browser-rum.rumglobal.setuserproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index b63864e8b3..923982f788 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewContext](./browser-rum.rumglobal.setviewcontext.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 15c0a7095c..8d491e1e60 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewContextProperty](./browser-rum.rumglobal.setviewcontextproperty.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 9e3e7e7075..510cf85d56 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [setViewName](./browser-rum.rumglobal.setviewname.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 44d61e8a2e..3a419e7460 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startDurationVital](./browser-rum.rumglobal.startdurationvital.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 3c85c33bab..9b3239910a 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startSessionReplayRecording](./browser-rum.rumglobal.startsessionreplayrecording.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index 5e12d064fd..9bd7d24010 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [startView](./browser-rum.rumglobal.startview.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index dee60011f9..49d5ea2fc3 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopDurationVital](./browser-rum.rumglobal.stopdurationvital.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 434079b019..62944fc62c 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopSession](./browser-rum.rumglobal.stopsession.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index 9481671665..ec18b79ff3 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumGlobal](./browser-rum.rumglobal.md) > [stopSessionReplayRecording](./browser-rum.rumglobal.stopsessionreplayrecording.md) +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 19ef4fe19f..54ec029494 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [actionNameAttribute](./browser-rum.ruminitconfiguration.actionnameattribute.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index f84c9de780..36aa62c2f3 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [allowedTracingUrls](./browser-rum.ruminitconfiguration.allowedtracingurls.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index 35cafa5e87..f498237dec 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [applicationId](./browser-rum.ruminitconfiguration.applicationid.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index bafc949bd9..e0e159ae0a 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [beforeSend](./browser-rum.ruminitconfiguration.beforesend.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index edab3ce0d7..28ae23a2c9 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [compressIntakeRequests](./browser-rum.ruminitconfiguration.compressintakerequests.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index b120958027..5a487a9df2 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [defaultPrivacyLevel](./browser-rum.ruminitconfiguration.defaultprivacylevel.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 12e8a75470..1f5c7db769 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [enablePrivacyForActionName](./browser-rum.ruminitconfiguration.enableprivacyforactionname.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index 32c76d31dc..96cb2c68af 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [excludedActivityUrls](./browser-rum.ruminitconfiguration.excludedactivityurls.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 0a6f376c65..19ecda74c8 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface @@ -34,12 +34,7 @@ Description - - -[actionNameAttribute?](./browser-rum.ruminitconfiguration.actionnameattribute.md) - - - +actionNameAttribute? @@ -49,16 +44,11 @@ string \| undefined -_(Optional)_ Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. +_(Optional)_ Specify your own attribute to use to name actions. See \Declare a name for click actions\ for further information. - - -[allowedTracingUrls?](./browser-rum.ruminitconfiguration.allowedtracingurls.md) - - - +allowedTracingUrls? @@ -68,16 +58,11 @@ Array<MatchOption \| TracingOption> \| undefined -_(Optional)_ A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. +_(Optional)_ A list of request URLs used to inject tracing headers. See \Connect RUM and Traces\ for further information. - - -[applicationId](./browser-rum.ruminitconfiguration.applicationid.md) - - - +applicationId @@ -91,33 +76,23 @@ The RUM application ID. - - -[beforeSend?](./browser-rum.ruminitconfiguration.beforesend.md) - - - +beforeSend? -((event: [RumEvent](./browser-rum.rumevent.md), context: [RumEventDomainContext](./browser-rum.rumeventdomaincontext.md)) => boolean) \| undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined _(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events -See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. +See \Enrich And Control Browser RUM Data With beforeSend\ for further information. - - -[compressIntakeRequests?](./browser-rum.ruminitconfiguration.compressintakerequests.md) - - - +compressIntakeRequests? @@ -127,16 +102,11 @@ boolean \| undefined -_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. +_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \Content Security Policy guidelines\ for further information. - - -[defaultPrivacyLevel?](./browser-rum.ruminitconfiguration.defaultprivacylevel.md) - - - +defaultPrivacyLevel? @@ -146,16 +116,11 @@ DefaultPrivacyLevel \| undefined -_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. +_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \Replay Privacy Options\ for further information. - - -[enablePrivacyForActionName?](./browser-rum.ruminitconfiguration.enableprivacyforactionname.md) - - - +enablePrivacyForActionName? @@ -169,12 +134,7 @@ _(Optional)_ Enables privacy control for action names. - - -[excludedActivityUrls?](./browser-rum.ruminitconfiguration.excludedactivityurls.md) - - - +excludedActivityUrls? @@ -184,16 +144,11 @@ MatchOption\[\] \| undefined -_(Optional)_ A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. +_(Optional)_ A list of request origins ignored when computing the page activity. See \How page activity is calculated\ for further information. - - -[plugins?](./browser-rum.ruminitconfiguration.plugins.md) - - - +plugins? @@ -207,12 +162,7 @@ _(Optional)_ List of plugins to enable. The plugins API is unstable and experime - - -[profilingSampleRate?](./browser-rum.ruminitconfiguration.profilingsamplerate.md) - - - +profilingSampleRate? @@ -226,12 +176,7 @@ _(Optional)_ Not ready for production. The percentage of users profiled. A value - - -[propagateTraceBaggage?](./browser-rum.ruminitconfiguration.propagatetracebaggage.md) - - - +propagateTraceBaggage? @@ -245,12 +190,7 @@ _(Optional)_ Whether to propagate user and account IDs in the baggage header of - - -[remoteConfigurationId?](./browser-rum.ruminitconfiguration.remoteconfigurationid.md) - - - +remoteConfigurationId? @@ -264,12 +204,7 @@ _(Optional)_ - - -[sessionReplaySampleRate?](./browser-rum.ruminitconfiguration.sessionreplaysamplerate.md) - - - +sessionReplaySampleRate? @@ -279,16 +214,11 @@ number \| undefined -_(Optional)_ The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. +_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See \Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\ for further information. - - -[startSessionReplayRecordingManually?](./browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md) - - - +startSessionReplayRecordingManually? @@ -298,16 +228,11 @@ boolean \| undefined -_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. +_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \Session Replay Usage\ for further information. - - -[subdomain?](./browser-rum.ruminitconfiguration.subdomain.md) - - - +subdomain? @@ -317,16 +242,11 @@ string -_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. +_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \Connect Session Replay To Your Third-Party Tools\ for further information. - - -[traceContextInjection?](./browser-rum.ruminitconfiguration.tracecontextinjection.md) - - - +traceContextInjection? @@ -336,16 +256,11 @@ TraceContextInjection \| undefined -_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. +_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \Connect RUM and Traces\ for further information. - - -[traceSampleRate?](./browser-rum.ruminitconfiguration.tracesamplerate.md) - - - +traceSampleRate? @@ -355,16 +270,11 @@ number \| undefined -_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. +_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \Connect RUM and Traces\ for further information. - - -[trackBfcacheViews?](./browser-rum.ruminitconfiguration.trackbfcacheviews.md) - - - +trackBfcacheViews? @@ -378,12 +288,7 @@ _(Optional)_ Enable the creation of dedicated views for pages restored from the - - -[trackFeatureFlagsForEvents?](./browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md) - - - +trackFeatureFlagsForEvents? @@ -397,12 +302,7 @@ _(Optional)_ Enables collection of features flags in chosen events. - - -[trackLongTasks?](./browser-rum.ruminitconfiguration.tracklongtasks.md) - - - +trackLongTasks? @@ -416,12 +316,7 @@ _(Optional)_ Enables collection of long task events. true - - -[trackResources?](./browser-rum.ruminitconfiguration.trackresources.md) - - - +trackResources? @@ -435,12 +330,7 @@ _(Optional)_ Enables collection of resource events. true - - -[trackUserInteractions?](./browser-rum.ruminitconfiguration.trackuserinteractions.md) - - - +trackUserInteractions? @@ -450,16 +340,11 @@ boolean \| undefined -_(Optional)_ Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true +_(Optional)_ Enables automatic collection of users actions. See \Tracking User Actions\ for further information. true - - -[trackViewsManually?](./browser-rum.ruminitconfiguration.trackviewsmanually.md) - - - +trackViewsManually? @@ -469,16 +354,11 @@ boolean \| undefined -_(Optional)_ Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. +_(Optional)_ Allows you to control RUM views creation. See \Override default RUM view names\ for further information. - - -[workerUrl?](./browser-rum.ruminitconfiguration.workerurl.md) - - - +workerUrl? @@ -488,7 +368,7 @@ string -_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. +_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \Content Security Policy guidelines\ for further information. diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index fc42fa068c..2253d6f184 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [plugins](./browser-rum.ruminitconfiguration.plugins.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index 64546acf42..1f19978c58 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [profilingSampleRate](./browser-rum.ruminitconfiguration.profilingsamplerate.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 1fece4fb24..7cc82ecc34 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [propagateTraceBaggage](./browser-rum.ruminitconfiguration.propagatetracebaggage.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 00d9a7186b..97d7cddb26 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [remoteConfigurationId](./browser-rum.ruminitconfiguration.remoteconfigurationid.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index a8c590f8ff..6a4f4edc53 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [sessionReplaySampleRate](./browser-rum.ruminitconfiguration.sessionreplaysamplerate.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index c04dcaa3a7..93bf44fc5d 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [startSessionReplayRecordingManually](./browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 2b79f229cc..659827c89b 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [subdomain](./browser-rum.ruminitconfiguration.subdomain.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 7491c88d76..0c22ee50ba 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [traceContextInjection](./browser-rum.ruminitconfiguration.tracecontextinjection.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index 139deb33dc..37a8e62da9 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [traceSampleRate](./browser-rum.ruminitconfiguration.tracesamplerate.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md index a2cb56a145..07de678d0b 100644 --- a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md +++ b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackBfcacheViews](./browser-rum.ruminitconfiguration.trackbfcacheviews.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackBfcacheViews ## RumInitConfiguration.trackBfcacheViews property diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index d66ede8caf..bc82b62c61 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackFeatureFlagsForEvents](./browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 93950406bd..5389a7636f 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackLongTasks](./browser-rum.ruminitconfiguration.tracklongtasks.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index e8309153e4..64375858b2 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackResources](./browser-rum.ruminitconfiguration.trackresources.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index 79608750be..a3f53c0fbe 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackUserInteractions](./browser-rum.ruminitconfiguration.trackuserinteractions.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index b20b5228fa..f7873cb993 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [trackViewsManually](./browser-rum.ruminitconfiguration.trackviewsmanually.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index ea013500d4..06d70ff96a 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumInitConfiguration](./browser-rum.ruminitconfiguration.md) > [workerUrl](./browser-rum.ruminitconfiguration.workerurl.md) +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 2efb7c65a7..d4720343ad 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md) +[Home](index.html) > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 33852ee909..561717d766 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[performanceEntry](./browser-rum.rumlongtaskeventdomaincontext.performanceentry.md) - - - +performanceEntry diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 609c2b8327..cf988cfda0 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) > [performanceEntry](./browser-rum.rumlongtaskeventdomaincontext.performanceentry.md) +[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index ec14c014cd..5e5415ce86 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[performanceEntry](./browser-rum.rumotherresourceeventdomaincontext.performanceentry.md) - - - +performanceEntry diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index b12942a1a0..4b5e81d288 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumotherresourceeventdomaincontext.performanceentry.md) +[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index b7b966cdd1..da8f29e8ac 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumResourceEvent](./browser-rum.rumresourceevent.md) +[Home](index.html) > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index dd95d402c9..14bb5f0929 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEvent](./browser-rum.rumviewevent.md) +[Home](index.html) > @datadog/browser-rum > RumViewEvent ## RumViewEvent type diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index fb6927d85e..0a299087a6 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) > [location](./browser-rum.rumvieweventdomaincontext.location.md) +[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 79ad47bc2c..ae2b2ac0b9 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[location](./browser-rum.rumvieweventdomaincontext.location.md) - - - +location diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index da26b59401..509c35669e 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumVitalEvent](./browser-rum.rumvitalevent.md) +[Home](index.html) > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 7c02e28fa4..9a2e017726 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [handlingStack](./browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md) +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 06c183b80a..8a340f8fdc 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [isAborted](./browser-rum.rumxhrresourceeventdomaincontext.isaborted.md) +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index ad8540e2de..0077ebaeb3 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface @@ -33,12 +33,7 @@ Description - - -[handlingStack?](./browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md) - - - +handlingStack? @@ -52,12 +47,7 @@ _(Optional)_ - - -[isAborted](./browser-rum.rumxhrresourceeventdomaincontext.isaborted.md) - - - +isAborted @@ -69,12 +59,7 @@ boolean - - -[performanceEntry?](./browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md) - - - +performanceEntry? @@ -88,12 +73,7 @@ _(Optional)_ - - -[xhr](./browser-rum.rumxhrresourceeventdomaincontext.xhr.md) - - - +xhr diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index df31aba736..5d5035b4f5 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [performanceEntry](./browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md) +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 1eb2d6f8ab..868bd506bd 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@datadog/browser-rum](./browser-rum.md) > [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md) > [xhr](./browser-rum.rumxhrresourceeventdomaincontext.xhr.md) +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property diff --git a/docs/index.md b/docs/index.md index 87cd2583bd..96cc580467 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,34 +1,30 @@ -[Home](./index.md) +[Home](index.html) ## API Reference ## Packages - - - - - - - - - - - - - - - - - - - - - - - - - -
PackageDescription
@datadog/browser-logsLogs collection package for browser applications
@datadog/browser-rumMain RUM package for collecting user monitoring data
@datadog/browser-rum-reactReact-specific extensions for RUM
@datadog/browser-rum-slimLightweight version of the RUM package
+ + + + + +
+ +Package + + + +Description + +
@datadog/browser-logs + +
@datadog/browser-rum + +
@datadog/browser-rum-react + +
@datadog/browser-rum-slim + +
diff --git a/scripts/fix-api-docs.js b/scripts/fix-api-docs.js new file mode 100644 index 0000000000..89f68ba24e --- /dev/null +++ b/scripts/fix-api-docs.js @@ -0,0 +1,83 @@ +const fs = require('fs') +const path = require('path') + +function fixMarkdownLinks(content) { + // Remplacer les tables HTML complexes par des tables markdown simples + // ou convertir les liens markdown en HTML dans les cellules + + // Pattern pour trouver les liens markdown [text](url) + const linkPattern = /\[([^\]]+)\]\(([^)]+)\)/g + + // Remplacer les liens dans les cellules de table + content = content.replace(/\s*\n*\s*\[([^\]]+)\]\(([^)]+)\)\s*\n*\s*<\/td>/g, (_match, text, url) => { + // Corriger l'URL si nécessaire + let fixedUrl = url + if (url.startsWith('./')) { + fixedUrl = url.substring(2) + } + if (fixedUrl.endsWith('.md')) { + fixedUrl = fixedUrl.replace('.md', '.html') + } + + return `${text}` + }) + + // Gérer les cas où il y a du texte supplémentaire dans les cellules + content = content.replace(/([\s\S]*?)<\/td>/g, (_match, cellContent) => { + const fixedContent = cellContent.replace(linkPattern, (_linkMatch, text, url) => { + let fixedUrl = url + if (url.startsWith('./')) { + fixedUrl = url.substring(2) + } + if (fixedUrl.endsWith('.md')) { + fixedUrl = fixedUrl.replace('.md', '.html') + } + return `${text}` + }) + return `${fixedContent}` + }) + + // Corriger aussi les liens en dehors des tables + content = content.replace(/\[Home\]\(\.\/(index\.md)\)/g, '[Home](index.html)') + content = content.replace(/> \[([^\]]+)\]\(\.\/([^)]+)\.md\)/g, '> $1') + + return content +} + +function processDirectory(dirPath) { + const files = fs.readdirSync(dirPath) + + files.forEach((file) => { + const filePath = path.join(dirPath, file) + const stat = fs.statSync(filePath) + + if (stat.isDirectory() && !file.startsWith('_') && file !== '.git') { + processDirectory(filePath) + } else if (stat.isFile() && file.endsWith('.md') && file !== 'README.md') { + console.log(`Processing: ${filePath}`) + + let content = fs.readFileSync(filePath, 'utf-8') + const fixedContent = fixMarkdownLinks(content) + + if (content !== fixedContent) { + fs.writeFileSync(filePath, fixedContent, 'utf-8') + console.log(` ✓ Fixed links in ${file}`) + } + } + }) +} + +function runMain() { + // Traiter le dossier docs + const docsPath = path.join(__dirname, '..', 'docs') + if (fs.existsSync(docsPath)) { + console.log('Fixing API documentation links...') + processDirectory(docsPath) + console.log('Done!') + } else { + console.error('Error: docs directory not found') + process.exit(1) + } +} + +runMain() From 15ac8ab1578cdf7a3bb8c746ed4bb85f2764649f Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 13:25:35 +0200 Subject: [PATCH 09/21] clean --- .github/workflows/pages.yml | 73 - docs/Gemfile | 13 - docs/_config.yml | 23 - docs/_layouts/default.html | 62 - docs/assets/css/style.scss | 1 - docs/browser-logs.datadoglogs.md | 22 +- docs/browser-logs.handlertype.md | 30 +- docs/browser-logs.logger._constructor_.md | 195 +- docs/browser-logs.logger.alert.md | 149 +- docs/browser-logs.logger.clearcontext.md | 30 +- docs/browser-logs.logger.critical.md | 149 +- docs/browser-logs.logger.debug.md | 149 +- docs/browser-logs.logger.emerg.md | 149 +- docs/browser-logs.logger.error.md | 149 +- docs/browser-logs.logger.getcontext.md | 30 +- docs/browser-logs.logger.gethandler.md | 30 +- docs/browser-logs.logger.getlevel.md | 30 +- docs/browser-logs.logger.info.md | 149 +- docs/browser-logs.logger.log.md | 169 +- docs/browser-logs.logger.logimplementation.md | 198 +- docs/browser-logs.logger.md | 113 +- docs/browser-logs.logger.notice.md | 149 +- docs/browser-logs.logger.ok.md | 149 +- ...owser-logs.logger.removecontextproperty.md | 91 +- docs/browser-logs.logger.setcontext.md | 91 +- .../browser-logs.logger.setcontextproperty.md | 116 +- docs/browser-logs.logger.sethandler.md | 91 +- docs/browser-logs.logger.setlevel.md | 82 +- docs/browser-logs.logger.warn.md | 149 +- ...rowser-logs.loggerconfiguration.context.md | 22 +- ...rowser-logs.loggerconfiguration.handler.md | 22 +- .../browser-logs.loggerconfiguration.level.md | 22 +- docs/browser-logs.loggerconfiguration.md | 134 +- docs/browser-logs.logsevent.application_id.md | 26 +- docs/browser-logs.logsevent.date.md | 26 +- docs/browser-logs.logsevent.error.md | 50 +- docs/browser-logs.logsevent.http.md | 36 +- docs/browser-logs.logsevent.logger.md | 32 +- docs/browser-logs.logsevent.md | 368 +- docs/browser-logs.logsevent.message.md | 26 +- docs/browser-logs.logsevent.origin.md | 26 +- docs/browser-logs.logsevent.service.md | 26 +- docs/browser-logs.logsevent.session.md | 32 +- docs/browser-logs.logsevent.session_id.md | 26 +- docs/browser-logs.logsevent.status.md | 26 +- docs/browser-logs.logsevent.view.md | 36 +- docs/browser-logs.logseventdomaincontext.md | 28 +- docs/browser-logs.logsglobal.clearaccount.md | 26 +- ...wser-logs.logsglobal.clearglobalcontext.md | 30 +- docs/browser-logs.logsglobal.clearuser.md | 30 +- docs/browser-logs.logsglobal.createlogger.md | 30 +- docs/browser-logs.logsglobal.getaccount.md | 26 +- ...rowser-logs.logsglobal.getglobalcontext.md | 30 +- ...er-logs.logsglobal.getinitconfiguration.md | 26 +- ...wser-logs.logsglobal.getinternalcontext.md | 30 +- docs/browser-logs.logsglobal.getlogger.md | 30 +- docs/browser-logs.logsglobal.getuser.md | 30 +- docs/browser-logs.logsglobal.init.md | 26 +- docs/browser-logs.logsglobal.logger.md | 22 +- docs/browser-logs.logsglobal.md | 673 +- ...r-logs.logsglobal.removeaccountproperty.md | 26 +- ....logsglobal.removeglobalcontextproperty.md | 30 +- ...wser-logs.logsglobal.removeuserproperty.md | 30 +- docs/browser-logs.logsglobal.setaccount.md | 26 +- ...wser-logs.logsglobal.setaccountproperty.md | 26 +- ...rowser-logs.logsglobal.setglobalcontext.md | 26 +- ...ogs.logsglobal.setglobalcontextproperty.md | 26 +- ...wser-logs.logsglobal.settrackingconsent.md | 26 +- docs/browser-logs.logsglobal.setuser.md | 103 +- docs/browser-logs.logsglobal.setuser_1.md | 104 +- ...browser-logs.logsglobal.setuserproperty.md | 26 +- ...r-logs.logsinitconfiguration.beforesend.md | 26 +- ...ogsinitconfiguration.forwardconsolelogs.md | 26 +- ...gsinitconfiguration.forwarderrorstologs.md | 26 +- ...gs.logsinitconfiguration.forwardreports.md | 26 +- docs/browser-logs.logsinitconfiguration.md | 196 +- ...logs.logsinitconfiguration.usepciintake.md | 26 +- docs/browser-logs.logsmessage.context.md | 22 +- docs/browser-logs.logsmessage.md | 126 +- docs/browser-logs.logsmessage.message.md | 22 +- docs/browser-logs.logsmessage.status.md | 22 +- docs/browser-logs.md | 213 +- docs/browser-logs.statustype.md | 42 +- docs/browser-rum-react.addreacterror.md | 116 +- ...r-rum-react.errorboundary._constructor_.md | 88 +- ...m-react.errorboundary.componentdidcatch.md | 116 +- ....errorboundary.getderivedstatefromerror.md | 91 +- docs/browser-rum-react.errorboundary.md | 222 +- .../browser-rum-react.errorboundary.render.md | 30 +- ...wser-rum-react.errorboundary.reseterror.md | 22 +- docs/browser-rum-react.md | 122 +- docs/browser-rum-react.reactplugin.md | 120 +- ...um-react.unstable_reactcomponenttracker.md | 26 +- docs/browser-rum-slim.datadogrum.md | 22 +- docs/browser-rum-slim.md | 45 +- docs/browser-rum.commonproperties._dd.md | 54 +- docs/browser-rum.commonproperties.account.md | 34 +- ...rowser-rum.commonproperties.application.md | 32 +- docs/browser-rum.commonproperties.build_id.md | 26 +- ...wser-rum.commonproperties.build_version.md | 26 +- docs/browser-rum.commonproperties.ci_test.md | 32 +- ...owser-rum.commonproperties.connectivity.md | 46 +- docs/browser-rum.commonproperties.context.md | 30 +- docs/browser-rum.commonproperties.date.md | 26 +- docs/browser-rum.commonproperties.device.md | 40 +- docs/browser-rum.commonproperties.display.md | 40 +- docs/browser-rum.commonproperties.md | 595 +- docs/browser-rum.commonproperties.os.md | 38 +- docs/browser-rum.commonproperties.service.md | 26 +- docs/browser-rum.commonproperties.session.md | 36 +- docs/browser-rum.commonproperties.source.md | 26 +- ...browser-rum.commonproperties.synthetics.md | 36 +- docs/browser-rum.commonproperties.usr.md | 38 +- docs/browser-rum.commonproperties.version.md | 26 +- docs/browser-rum.commonproperties.view.md | 38 +- docs/browser-rum.datadogrum.md | 22 +- docs/browser-rum.md | 259 +- docs/browser-rum.rumactionevent.md | 147 +- ...-rum.rumactioneventdomaincontext.events.md | 22 +- ...mactioneventdomaincontext.handlingstack.md | 22 +- ...browser-rum.rumactioneventdomaincontext.md | 118 +- docs/browser-rum.rumerrorevent.md | 213 +- ...er-rum.rumerroreventdomaincontext.error.md | 22 +- ...umerroreventdomaincontext.handlingstack.md | 22 +- .../browser-rum.rumerroreventdomaincontext.md | 114 +- docs/browser-rum.rumevent.md | 36 +- docs/browser-rum.rumeventdomaincontext.md | 38 +- ...umfetchresourceeventdomaincontext.error.md | 22 +- ...esourceeventdomaincontext.handlingstack.md | 22 +- ...tchresourceeventdomaincontext.isaborted.md | 22 +- ...-rum.rumfetchresourceeventdomaincontext.md | 235 +- ...urceeventdomaincontext.performanceentry.md | 22 +- ...hresourceeventdomaincontext.requestinit.md | 22 +- ...resourceeventdomaincontext.requestinput.md | 22 +- ...etchresourceeventdomaincontext.response.md | 22 +- docs/browser-rum.rumglobal.addaction.md | 26 +- .../browser-rum.rumglobal.adddurationvital.md | 36 +- docs/browser-rum.rumglobal.adderror.md | 26 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 26 +- docs/browser-rum.rumglobal.addtiming.md | 26 +- docs/browser-rum.rumglobal.clearaccount.md | 26 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 30 +- docs/browser-rum.rumglobal.clearuser.md | 30 +- docs/browser-rum.rumglobal.getaccount.md | 26 +- .../browser-rum.rumglobal.getglobalcontext.md | 30 +- ...wser-rum.rumglobal.getinitconfiguration.md | 26 +- ...rowser-rum.rumglobal.getinternalcontext.md | 26 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 30 +- docs/browser-rum.rumglobal.getuser.md | 30 +- docs/browser-rum.rumglobal.getviewcontext.md | 26 +- docs/browser-rum.rumglobal.init.md | 26 +- docs/browser-rum.rumglobal.md | 1027 +-- ...ser-rum.rumglobal.removeaccountproperty.md | 26 +- ...m.rumglobal.removeglobalcontextproperty.md | 30 +- ...rowser-rum.rumglobal.removeuserproperty.md | 30 +- docs/browser-rum.rumglobal.setaccount.md | 26 +- ...rowser-rum.rumglobal.setaccountproperty.md | 26 +- .../browser-rum.rumglobal.setglobalcontext.md | 26 +- ...-rum.rumglobal.setglobalcontextproperty.md | 26 +- ...rowser-rum.rumglobal.settrackingconsent.md | 26 +- docs/browser-rum.rumglobal.setuser.md | 103 +- docs/browser-rum.rumglobal.setuser_1.md | 104 +- docs/browser-rum.rumglobal.setuserproperty.md | 26 +- docs/browser-rum.rumglobal.setviewcontext.md | 30 +- ...er-rum.rumglobal.setviewcontextproperty.md | 30 +- docs/browser-rum.rumglobal.setviewname.md | 30 +- ...rowser-rum.rumglobal.startdurationvital.md | 39 +- ...m.rumglobal.startsessionreplayrecording.md | 30 +- docs/browser-rum.rumglobal.startview.md | 32 +- ...browser-rum.rumglobal.stopdurationvital.md | 32 +- docs/browser-rum.rumglobal.stopsession.md | 26 +- ...um.rumglobal.stopsessionreplayrecording.md | 30 +- ...uminitconfiguration.actionnameattribute.md | 26 +- ...ruminitconfiguration.allowedtracingurls.md | 26 +- ...-rum.ruminitconfiguration.applicationid.md | 26 +- ...ser-rum.ruminitconfiguration.beforesend.md | 30 +- ...nitconfiguration.compressintakerequests.md | 26 +- ...uminitconfiguration.defaultprivacylevel.md | 26 +- ...onfiguration.enableprivacyforactionname.md | 26 +- ...minitconfiguration.excludedactivityurls.md | 26 +- docs/browser-rum.ruminitconfiguration.md | 675 +- ...rowser-rum.ruminitconfiguration.plugins.md | 26 +- ...uminitconfiguration.profilingsamplerate.md | 26 +- ...initconfiguration.propagatetracebaggage.md | 26 +- ...initconfiguration.remoteconfigurationid.md | 22 +- ...itconfiguration.sessionreplaysamplerate.md | 26 +- ...ion.startsessionreplayrecordingmanually.md | 26 +- ...wser-rum.ruminitconfiguration.subdomain.md | 26 +- ...initconfiguration.tracecontextinjection.md | 26 +- ...um.ruminitconfiguration.tracesamplerate.md | 26 +- ....ruminitconfiguration.trackbfcacheviews.md | 26 +- ...onfiguration.trackfeatureflagsforevents.md | 26 +- ...rum.ruminitconfiguration.tracklongtasks.md | 26 +- ...rum.ruminitconfiguration.trackresources.md | 26 +- ...initconfiguration.trackuserinteractions.md | 26 +- ...ruminitconfiguration.trackviewsmanually.md | 26 +- ...wser-rum.ruminitconfiguration.workerurl.md | 26 +- docs/browser-rum.rumlongtaskevent.md | 104 +- ...owser-rum.rumlongtaskeventdomaincontext.md | 89 +- ...taskeventdomaincontext.performanceentry.md | 22 +- ...-rum.rumotherresourceeventdomaincontext.md | 89 +- ...urceeventdomaincontext.performanceentry.md | 22 +- docs/browser-rum.rumresourceevent.md | 205 +- docs/browser-rum.rumviewevent.md | 295 +- ...-rum.rumvieweventdomaincontext.location.md | 22 +- docs/browser-rum.rumvieweventdomaincontext.md | 89 +- docs/browser-rum.rumvitalevent.md | 73 +- ...esourceeventdomaincontext.handlingstack.md | 22 +- ...xhrresourceeventdomaincontext.isaborted.md | 22 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 160 +- ...urceeventdomaincontext.performanceentry.md | 22 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 22 +- docs/index.md | 60 +- etc/browser-logs.api.json | 7042 +++++++-------- etc/browser-rum-react.api.json | 1250 +-- etc/browser-rum-slim.api.json | 404 +- etc/browser-rum.api.json | 7744 ++++++++--------- scripts/fix-api-docs.js | 83 - 218 files changed, 15031 insertions(+), 16025 deletions(-) delete mode 100644 docs/Gemfile delete mode 100644 docs/_config.yml delete mode 100644 docs/_layouts/default.html delete mode 100644 docs/assets/css/style.scss delete mode 100644 scripts/fix-api-docs.js diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 374ccbc97d..e69de29bb2 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -1,73 +0,0 @@ -name: Deploy Jekyll site to Pages - -on: - push: - branches: ['romanG/api-reference'] - pull_request: - branches: ['romanG/api-reference'] - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: 'pages' - cancel-in-progress: false - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version: '18' - - - name: Fix API documentation links - run: | - node scripts/fix-api-docs.js - - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.2' - bundler-cache: true - working-directory: ./docs - - - name: Setup Pages - id: pages - uses: actions/configure-pages@v4 - - - name: Install dependencies - run: | - cd docs - bundle install - - - name: Build with Jekyll - run: | - cd docs - bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" - env: - JEKYLL_ENV: production - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: ./docs/_site - - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build - if: github.ref == 'refs/heads/romanG/api-reference' - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 8ed6929a67..0000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,13 +0,0 @@ -source "https://rubygems.org" - -# GitHub Pages gem - inclut Jekyll et tous les plugins supportés -gem "github-pages", group: :jekyll_plugins - -# Windows et JRuby support -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", ">= 1", "< 3" - gem "tzinfo-data" -end - -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] -gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6db53f5667..0000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,23 +0,0 @@ -title: 'Datadog Browser SDK API Reference' -description: 'API documentation for Datadog Browser SDK packages' - -# Build settings -markdown: kramdown - -# GitHub Pages settings -baseurl: '/browser-sdk' -url: 'https://datadoghq.dev' - -# Plugins -plugins: - - jekyll-feed - -# Kramdown settings -kramdown: - input: GFM - hard_wrap: false - parse_block_html: true - parse_span_html: true - html_to_native: true - enable_coderay: false - math_engine: null diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index 1cd5e0e7e9..0000000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - {{ page.title | default: site.title }} - - - -
- {{ content }} -
- - \ No newline at end of file diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss deleted file mode 100644 index 0519ecba6e..0000000000 --- a/docs/assets/css/style.scss +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index f064cea50f..3f3d9c053b 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > datadogLogs - -## datadogLogs variable - -**Signature:** - -```typescript -datadogLogs: LogsPublicApi -``` + + +[Home](index.html) > @datadog/browser-logs > datadogLogs + +## datadogLogs variable + +**Signature:** + +```typescript +datadogLogs: LogsPublicApi +``` diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index 7a0bf98754..d0de6dab81 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > HandlerType - -## HandlerType variable - -**Signature:** - -```typescript -HandlerType: { - readonly console: "console"; - readonly http: "http"; - readonly silent: "silent"; -} -``` + + +[Home](index.html) > @datadog/browser-logs > HandlerType + +## HandlerType variable + +**Signature:** + +```typescript +HandlerType: { + readonly console: "console"; + readonly http: "http"; + readonly silent: "silent"; +} +``` diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 0b99e50081..5970ee666a 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,106 +1,89 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > (constructor) - -## Logger.(constructor) - -Constructs a new instance of the `Logger` class - -**Signature:** - -```typescript -constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void, name?: string, handlerType?: HandlerType | HandlerType[], level?: StatusType, loggerContext?: object); -``` - -## Parameters - - - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -handleLogStrategy - - - - -(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void - - - - - -
- -name - - - - -string - - - - -_(Optional)_ - - -
- -handlerType - - - - -HandlerType \| HandlerType\[\] - - - - -_(Optional)_ - - -
- -level - - -StatusType - -_(Optional)_ - - -
- -loggerContext - - - - -object - - - - -_(Optional)_ - - -
+ + +[Home](index.html) > @datadog/browser-logs > Logger > (constructor) + +## Logger.(constructor) + +Constructs a new instance of the `Logger` class + +**Signature:** + +```typescript +constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void, name?: string, handlerType?: HandlerType | HandlerType[], level?: StatusType, loggerContext?: object); +``` + +## Parameters + + + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +handleLogStrategy + + + +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void + + + +
+ +name + + + +string + + + +_(Optional)_ + +
+ +handlerType + + + +HandlerType \| HandlerType\[\] + + + +_(Optional)_ + +
+ +level + +StatusType + +_(Optional)_ + +
+ +loggerContext + + + +object + + + +_(Optional)_ + +
diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 4e5dcbe317..f5b2b4f1ed 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > alert - -## Logger.alert() method - -**Signature:** - -```typescript -alert(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > alert + +## Logger.alert() method + +**Signature:** + +```typescript +alert(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 65de673baa..6c3a62ba38 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > clearContext - -## Logger.clearContext() method - -**Signature:** - -```typescript -clearContext(): void; -``` -**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > clearContext + +## Logger.clearContext() method + +**Signature:** + +```typescript +clearContext(): void; +``` + +**Returns:** + +void diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index f11c919acf..a505bffade 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > critical - -## Logger.critical() method - -**Signature:** - -```typescript -critical(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > critical + +## Logger.critical() method + +**Signature:** + +```typescript +critical(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index bc2f820f06..895fe96a64 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > debug - -## Logger.debug() method - -**Signature:** - -```typescript -debug(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > debug + +## Logger.debug() method + +**Signature:** + +```typescript +debug(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index 4108a72ff4..64248145ed 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > emerg - -## Logger.emerg() method - -**Signature:** - -```typescript -emerg(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > emerg + +## Logger.emerg() method + +**Signature:** + +```typescript +emerg(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 60a4094c4f..f289672eae 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > error - -## Logger.error() method - -**Signature:** - -```typescript -error(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > error + +## Logger.error() method + +**Signature:** + +```typescript +error(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 4d42aa1069..b1f45693dc 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getContext - -## Logger.getContext() method - -**Signature:** - -```typescript -getContext(): Context; -``` -**Returns:** - -Context - + + +[Home](index.html) > @datadog/browser-logs > Logger > getContext + +## Logger.getContext() method + +**Signature:** + +```typescript +getContext(): Context; +``` + +**Returns:** + +Context diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 7967e87831..a3853eb735 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getHandler - -## Logger.getHandler() method - -**Signature:** - -```typescript -getHandler(): HandlerType | HandlerType[]; -``` -**Returns:** - -[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] - + + +[Home](index.html) > @datadog/browser-logs > Logger > getHandler + +## Logger.getHandler() method + +**Signature:** + +```typescript +getHandler(): HandlerType | HandlerType[]; +``` + +**Returns:** + +[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 684b236f0e..95d3da646e 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getLevel - -## Logger.getLevel() method - -**Signature:** - -```typescript -getLevel(): StatusType; -``` -**Returns:** - -[StatusType](./browser-logs.statustype.md) - + + +[Home](index.html) > @datadog/browser-logs > Logger > getLevel + +## Logger.getLevel() method + +**Signature:** + +```typescript +getLevel(): StatusType; +``` + +**Returns:** + +[StatusType](./browser-logs.statustype.md) diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index cae086b467..43a20fe038 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > info - -## Logger.info() method - -**Signature:** - -```typescript -info(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > info + +## Logger.info() method + +**Signature:** + +```typescript +info(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 8035a63031..a4e6c9a9d5 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,92 +1,77 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > log - -## Logger.log() method - -**Signature:** - -```typescript -log(message: string, messageContext?: object, status?: StatusType, error?: Error): void; -``` - -## Parameters - - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -status - - -StatusType - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > log + +## Logger.log() method + +**Signature:** + +```typescript +log(message: string, messageContext?: object, status?: StatusType, error?: Error): void; +``` + +## Parameters + + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +status + +StatusType + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index cff6883ec2..179489398f 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,108 +1,90 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > logImplementation - -## Logger.logImplementation() method - -**Signature:** - -```typescript -logImplementation(message: string, messageContext?: object, status?: StatusType, error?: Error, handlingStack?: string): void; -``` - -## Parameters - - - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -status - - -StatusType - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
- -handlingStack - - - - -string - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > logImplementation + +## Logger.logImplementation() method + +**Signature:** + +```typescript +logImplementation(message: string, messageContext?: object, status?: StatusType, error?: Error, handlingStack?: string): void; +``` + +## Parameters + + + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +status + +StatusType + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+ +handlingStack + + + +string + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index fd5419dbdd..bcff527ff0 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,62 +1,51 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger - -## Logger interface - -**Signature:** - -```typescript -export interface Logger -``` - -## Methods - - - - - - - - - - - -
- -Method - - - - -Description - - -
alert(message, messageContext, error) - - -
critical(message, messageContext, error) - - -
debug(message, messageContext, error) - - -
emerg(message, messageContext, error) - - -
error(message, messageContext, error) - - -
info(message, messageContext, error) - - -
notice(message, messageContext, error) - - -
ok(message, messageContext, error) - - -
warn(message, messageContext, error) - - -
+ + +[Home](index.html) > @datadog/browser-logs > Logger + +## Logger interface + +**Signature:** + +```typescript +export interface Logger +``` + +## Methods + + + + + + + + + + + +
+ +Method + + + +Description + +
alert(message, messageContext, error) + +
critical(message, messageContext, error) + +
debug(message, messageContext, error) + +
emerg(message, messageContext, error) + +
error(message, messageContext, error) + +
info(message, messageContext, error) + +
notice(message, messageContext, error) + +
ok(message, messageContext, error) + +
warn(message, messageContext, error) + +
diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index d41f62a5f5..76eed5a8df 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > notice - -## Logger.notice() method - -**Signature:** - -```typescript -notice(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > notice + +## Logger.notice() method + +**Signature:** + +```typescript +notice(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 994958db2c..2de5ca7d2c 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > ok - -## Logger.ok() method - -**Signature:** - -```typescript -ok(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > ok + +## Logger.ok() method + +**Signature:** + +```typescript +ok(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index 94d462f402..fed6805d54 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,49 +1,42 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > removeContextProperty - -## Logger.removeContextProperty() method - -**Signature:** - -```typescript -removeContextProperty(key: string): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -key - - - - -string - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > removeContextProperty + +## Logger.removeContextProperty() method + +**Signature:** + +```typescript +removeContextProperty(key: string): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +key + + + +string + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 8c73b7df2b..82debf2d90 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,49 +1,42 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setContext - -## Logger.setContext() method - -**Signature:** - -```typescript -setContext(context: object): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -context - - - - -object - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > setContext + +## Logger.setContext() method + +**Signature:** + +```typescript +setContext(context: object): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +context + + + +object + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 1c1d24f86e..5c651cd847 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,63 +1,53 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setContextProperty - -## Logger.setContextProperty() method - -**Signature:** - -```typescript -setContextProperty(key: string, value: any): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -key - - - - -string - - - - - -
- -value - - - - -any - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > setContextProperty + +## Logger.setContextProperty() method + +**Signature:** + +```typescript +setContextProperty(key: string, value: any): void; +``` + +## Parameters + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +key + + + +string + + + +
+ +value + + + +any + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index 9cde2ba30c..20953e86df 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,49 +1,42 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setHandler - -## Logger.setHandler() method - -**Signature:** - -```typescript -setHandler(handler: HandlerType | HandlerType[]): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -handler - - - - -HandlerType \| HandlerType\[\] - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > setHandler + +## Logger.setHandler() method + +**Signature:** + +```typescript +setHandler(handler: HandlerType | HandlerType[]): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +handler + + + +HandlerType \| HandlerType\[\] + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index e46b79cfcf..10b8f1d2ad 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,44 +1,38 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setLevel - -## Logger.setLevel() method - -**Signature:** - -```typescript -setLevel(level: StatusType): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -level - - -StatusType - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > setLevel + +## Logger.setLevel() method + +**Signature:** + +```typescript +setLevel(level: StatusType): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +level + +StatusType + +
+**Returns:** + +void diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 7ef880c82a..de11798515 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,81 +1,68 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > warn - -## Logger.warn() method - -**Signature:** - -```typescript -warn(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -message - - - - -string - - - - - -
- -messageContext - - - - -object - - - - -_(Optional)_ - - -
- -error - - - - -Error - - - - -_(Optional)_ - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > Logger > warn + +## Logger.warn() method + +**Signature:** + +```typescript +warn(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +message + + + +string + + + +
+ +messageContext + + + +object + + + +_(Optional)_ + +
+ +error + + + +Error + + + +_(Optional)_ + +
+**Returns:** + +void diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index c1d5110f9c..c8205b3be5 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > context - -## LoggerConfiguration.context property - -**Signature:** - -```typescript -context?: object; -``` + + +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > context + +## LoggerConfiguration.context property + +**Signature:** + +```typescript +context?: object; +``` diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 184a17df02..214933b1ba 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > handler - -## LoggerConfiguration.handler property - -**Signature:** - -```typescript -handler?: HandlerType | HandlerType[]; -``` + + +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > handler + +## LoggerConfiguration.handler property + +**Signature:** + +```typescript +handler?: HandlerType | HandlerType[]; +``` diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index e8bd7a0789..552e831b2a 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > level - -## LoggerConfiguration.level property - -**Signature:** - -```typescript -level?: StatusType; -``` + + +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > level + +## LoggerConfiguration.level property + +**Signature:** + +```typescript +level?: StatusType; +``` diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 9066857413..5adc2f3197 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,73 +1,61 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration - -## LoggerConfiguration interface - -**Signature:** - -```typescript -export interface LoggerConfiguration -``` - -## Properties - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
context? - - - - -object - - - - -_(Optional)_ - - -
handler? - - - - -HandlerType \| HandlerType\[\] - - - - -_(Optional)_ - - -
level? - - -StatusType - -_(Optional)_ - - -
+ + +[Home](index.html) > @datadog/browser-logs > LoggerConfiguration + +## LoggerConfiguration interface + +**Signature:** + +```typescript +export interface LoggerConfiguration +``` + +## Properties + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
context? + + + +object + + + +_(Optional)_ + +
handler? + + + +HandlerType \| HandlerType\[\] + + + +_(Optional)_ + +
level? + +StatusType + +_(Optional)_ + +
diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 499d64320d..ff55b34c48 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > application\_id - -## LogsEvent.application\_id property - -UUID of the application - -**Signature:** - -```typescript -application_id?: string; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > application_id + +## LogsEvent.application_id property + +UUID of the application + +**Signature:** + +```typescript +application_id?: string; +``` diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index e1c8d0dc7a..c6c14da41f 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > date - -## LogsEvent.date property - -Start of the log in ms from epoch - -**Signature:** - -```typescript -date: number; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > date + +## LogsEvent.date property + +Start of the log in ms from epoch + +**Signature:** + +```typescript +date: number +``` diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 6f5c6d24c7..c7230046ce 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,25 +1,25 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > error - -## LogsEvent.error property - -Error properties - -**Signature:** - -```typescript -error?: { - kind?: string; - stack?: string; - fingerprint?: string; - message?: string; - causes?: Array<{ - message: string; - source: string; - type?: string; - stack?: string; - }>; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > error + +## LogsEvent.error property + +Error properties + +**Signature:** + +```typescript +error?: { + kind?: string; + stack?: string; + fingerprint?: string; + message?: string; + causes?: Array<{ + message: string; + source: string; + type?: string; + stack?: string; + }>; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 9911cdb758..9e8787d7ae 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > http - -## LogsEvent.http property - -Resource properties of the error - -**Signature:** - -```typescript -http?: { - method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; - status_code: number; - url: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > http + +## LogsEvent.http property + +Resource properties of the error + +**Signature:** + +```typescript +http?: { + method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; + status_code: number; + url: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index bd730407c0..6886141dbb 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > logger - -## LogsEvent.logger property - -Logger properties - -**Signature:** - -```typescript -logger?: { - name: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > logger + +## LogsEvent.logger property + +Logger properties + +**Signature:** + +```typescript +logger?: { + name: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 4274971d98..1e04fb5a0d 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,204 +1,164 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent - -## LogsEvent interface - -**Signature:** - -```typescript -export interface LogsEvent -``` - -## Properties - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
application\_id? - - - - -string - - - - -_(Optional)_ UUID of the application - - -
date - - - - -number - - - - -Start of the log in ms from epoch - - -
error? - - - - -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } - - - - -_(Optional)_ Error properties - - -
http? - - - - -{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Resource properties of the error - - -
logger? - - - - -{ name: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Logger properties - - -
message - - - - -string - - - - -The log message - - -
origin - - - - -'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' - - - - -Origin of the log - - -
service? - - - - -string - - - - -_(Optional)_ The service name - - -
session\_id? - - - - -string - - - - -_(Optional)_ UUID of the session (deprecated in favor of session.id) - - -
session? - - - - -{ id?: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Session properties - - -
status - - - - -'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' - - - - -The log status - - -
view - - - - -{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } - - - - -View properties - - -
+ + +[Home](index.html) > @datadog/browser-logs > LogsEvent + +## LogsEvent interface + +**Signature:** + +```typescript +export interface LogsEvent +``` + +## Properties + + + + + + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
application\_id? + + + +string + + + +_(Optional)_ UUID of the application + +
date + + + +number + + + +Start of the log in ms from epoch + +
error? + + + +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } + + + +_(Optional)_ Error properties + +
http? + + + +{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status_code: number; url: string; \[k: string\]: unknown; } + + + +_(Optional)_ Resource properties of the error + +
logger? + + + +{ name: string; \[k: string\]: unknown; } + + + +_(Optional)_ Logger properties + +
message + + + +string + + + +The log message + +
origin + + + +'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' + + + +Origin of the log + +
service? + + + +string + + + +_(Optional)_ The service name + +
session\_id? + + + +string + + + +_(Optional)_ UUID of the session (deprecated in favor of session.id) + +
session? + + + +{ id?: string; \[k: string\]: unknown; } + + + +_(Optional)_ Session properties + +
status + + + +'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' + + + +The log status + +
view + + + +{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } + + + +View properties + +
diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 34d89871bd..394350ea5c 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > message - -## LogsEvent.message property - -The log message - -**Signature:** - -```typescript -message: string; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > message + +## LogsEvent.message property + +The log message + +**Signature:** + +```typescript +message: string +``` diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index d8636f0b36..cd278a0140 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > origin - -## LogsEvent.origin property - -Origin of the log - -**Signature:** - -```typescript -origin: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > origin + +## LogsEvent.origin property + +Origin of the log + +**Signature:** + +```typescript +origin: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'report' +``` diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index a02ccf4524..fadcffe6f2 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > service - -## LogsEvent.service property - -The service name - -**Signature:** - -```typescript -service?: string; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > service + +## LogsEvent.service property + +The service name + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index f23270716f..1c2c52875e 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > session - -## LogsEvent.session property - -Session properties - -**Signature:** - -```typescript -session?: { - id?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > session + +## LogsEvent.session property + +Session properties + +**Signature:** + +```typescript +session?: { + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 098d996c79..b4670e9984 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > session\_id - -## LogsEvent.session\_id property - -UUID of the session (deprecated in favor of session.id) - -**Signature:** - -```typescript -session_id?: string; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > session_id + +## LogsEvent.session_id property + +UUID of the session (deprecated in favor of session.id) + +**Signature:** + +```typescript +session_id?: string; +``` diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 82cc7daa8f..13ba53044d 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > status - -## LogsEvent.status property - -The log status - -**Signature:** - -```typescript -status: 'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > status + +## LogsEvent.status property + +The log status + +**Signature:** + +```typescript +status: 'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg' +``` diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 88a5cf0821..99247cb077 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > view - -## LogsEvent.view property - -View properties - -**Signature:** - -```typescript -view: { - referrer?: string; - url: string; - id?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEvent > view + +## LogsEvent.view property + +View properties + +**Signature:** + +```typescript +view: { + referrer?: string; + url: string; + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 3ae1135a47..bf864623bc 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,11 +1,17 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEventDomainContext - -## LogsEventDomainContext type - -**Signature:** - -```typescript -export type LogsEventDomainContext = T extends typeof ErrorSource.NETWORK ? NetworkLogsEventDomainContext : T extends typeof ErrorSource.CONSOLE ? ConsoleLogsEventDomainContext : T extends typeof ErrorSource.LOGGER ? LoggerLogsEventDomainContext : never; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsEventDomainContext + +## LogsEventDomainContext type + +**Signature:** + +```typescript +export type LogsEventDomainContext = T extends typeof ErrorSource.NETWORK + ? NetworkLogsEventDomainContext + : T extends typeof ErrorSource.CONSOLE + ? ConsoleLogsEventDomainContext + : T extends typeof ErrorSource.LOGGER + ? LoggerLogsEventDomainContext + : never +``` diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index fba8b86689..e5ef238851 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearAccount - -## LogsGlobal.clearAccount property - -Clear all account information - -**Signature:** - -```typescript -clearAccount: () => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearAccount + +## LogsGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index f70acc9853..1e923365f3 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearGlobalContext - -## LogsGlobal.clearGlobalContext property - -Clear the global context - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -clearGlobalContext: () => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearGlobalContext + +## LogsGlobal.clearGlobalContext property + +Clear the global context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index ad75ee0df6..85fe0e263a 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearUser - -## LogsGlobal.clearUser property - -Clear all user information - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -clearUser: () => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearUser + +## LogsGlobal.clearUser property + +Clear all user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index d747b25fde..13dc1bd145 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > createLogger - -## LogsGlobal.createLogger property - -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. - -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. - -**Signature:** - -```typescript -createLogger: (name: string, conf?: LoggerConfiguration) => Logger; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > createLogger + +## LogsGlobal.createLogger property + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + +**Signature:** + +```typescript +createLogger: (name: string, conf?: LoggerConfiguration) => Logger +``` diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index e925769dd5..3b3e786884 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getAccount - -## LogsGlobal.getAccount property - -Get account information - -**Signature:** - -```typescript -getAccount: () => Context; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getAccount + +## LogsGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context +``` diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index d28b667041..c46b41ee12 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getGlobalContext - -## LogsGlobal.getGlobalContext property - -Get the global Context - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -getGlobalContext: () => Context; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getGlobalContext + +## LogsGlobal.getGlobalContext property + +Get the global Context + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context +``` diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index 3dc2f5111c..2e5f481305 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInitConfiguration - -## LogsGlobal.getInitConfiguration property - -Get the init configuration - -**Signature:** - -```typescript -getInitConfiguration: () => LogsInitConfiguration | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInitConfiguration + +## LogsGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => LogsInitConfiguration | undefined +``` diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index a55202a226..2da6711fa1 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInternalContext - -## LogsGlobal.getInternalContext property - -\[Internal API\] Get the internal SDK context - -See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. - -**Signature:** - -```typescript -getInternalContext: (startTime?: number) => InternalContext | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInternalContext + +## LogsGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined +``` diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 60b2c9ca97..514f8a3a96 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getLogger - -## LogsGlobal.getLogger property - -Get a logger - -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. - -**Signature:** - -```typescript -getLogger: (name: string) => Logger | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getLogger + +## LogsGlobal.getLogger property + +Get a logger + +See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. + +**Signature:** + +```typescript +getLogger: (name: string) => Logger | undefined +``` diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index ac23277703..be59a26aeb 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getUser - -## LogsGlobal.getUser property - -Get user information - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -getUser: () => Context; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > getUser + +## LogsGlobal.getUser property + +Get user information + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +getUser: () => Context +``` diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 24e2c19f85..4834422baf 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > init - -## LogsGlobal.init property - -Init the Logs browser SDK. - -**Signature:** - -```typescript -init: (initConfiguration: LogsInitConfiguration) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > init + +## LogsGlobal.init property + +Init the Logs browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: LogsInitConfiguration) => void; +``` diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index a94c80c26d..374867635c 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > logger - -## LogsGlobal.logger property - -**Signature:** - -```typescript -logger: Logger; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > logger + +## LogsGlobal.logger property + +**Signature:** + +```typescript +logger: Logger +``` diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 71cc481aa5..805b2748b5 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,371 +1,302 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal - -## LogsGlobal interface - -**Signature:** - -```typescript -export interface LogsPublicApi extends PublicApi -``` -**Extends:** PublicApi - -## Properties - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
clearAccount - - - - -() => void - - - - -Clear all account information - - -
clearGlobalContext - - - - -() => void - - - - -Clear the global context - -See \Overwrite context\ for further information. - - -
clearUser - - - - -() => void - - - - -Clear all user information - -See \User context\ for further information. - - -
createLogger - - - - -(name: string, conf?: LoggerConfiguration) => Logger - - - - -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. - -See \Define multiple loggers\ for further information. - - -
getAccount - - - - -() => Context - - - - -Get account information - - -
getGlobalContext - - - - -() => Context - - - - -Get the global Context - -See \Overwrite context\ for further information. - - -
getInitConfiguration - - - - -() => LogsInitConfiguration \| undefined - - - - -Get the init configuration - - -
getInternalContext - - - - -(startTime?: number) => InternalContext \| undefined - - - - -\[Internal API\] Get the internal SDK context - -See \Access internal context\ for further information. - - -
getLogger - - - - -(name: string) => Logger \| undefined - - - - -Get a logger - -See \Define multiple loggers\ for further information. - - -
getUser - - - - -() => Context - - - - -Get user information - -See \User context\ for further information. - - -
init - - - - -(initConfiguration: LogsInitConfiguration) => void - - - - -Init the Logs browser SDK. - - -
logger - - -Logger - - -
removeAccountProperty - - - - -(key: string) => void - - - - -Remove an account property - - -
removeGlobalContextProperty - - - - -(key: any) => void - - - - -Remove a global context property - -See \Overwrite context\ for further information. - - -
removeUserProperty - - - - -(key: any) => void - - - - -Remove a user property - -See \User context\ for further information. - - -
setAccount - - - - -(newAccount: Account) => void - - - - -Set account information to all events, stored in `@account` - - -
setAccountProperty - - - - -(key: string, property: any) => void - - - - -Set or update the account property, stored in `@account.` - - -
setGlobalContext - - - - -(context: any) => void - - - - -Set the global context information to all logs, stored in `@context` - - -
setGlobalContextProperty - - - - -(key: any, value: any) => void - - - - -Set or update a global context property, stored in `@context.` - - -
setTrackingConsent - - - - -(trackingConsent: TrackingConsent) => void - - - - -Set the tracking consent of the current user. - - -
setUserProperty - - - - -(key: any, property: any) => void - - - - -Set or update the user property, stored in `@usr.` - - -
- -## Methods - - - - -
- -Method - - - - -Description - - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -See \User context\ for further information. - - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - - -
+ + +[Home](index.html) > @datadog/browser-logs > LogsGlobal + +## LogsGlobal interface + +**Signature:** + +```typescript +export interface LogsPublicApi extends PublicApi +``` + +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
clearAccount + + + +() => void + + + +Clear all account information + +
clearGlobalContext + + + +() => void + + + +Clear the global context + +See \Overwrite context\ for further information. + +
clearUser + + + +() => void + + + +Clear all user information + +See \User context\ for further information. + +
createLogger + + + +(name: string, conf?: LoggerConfiguration) => Logger + + + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \Define multiple loggers\ for further information. + +
getAccount + + + +() => Context + + + +Get account information + +
getGlobalContext + + + +() => Context + + + +Get the global Context + +See \Overwrite context\ for further information. + +
getInitConfiguration + + + +() => LogsInitConfiguration \| undefined + + + +Get the init configuration + +
getInternalContext + + + +(startTime?: number) => InternalContext \| undefined + + + +\[Internal API\] Get the internal SDK context + +See \Access internal context\ for further information. + +
getLogger + + + +(name: string) => Logger \| undefined + + + +Get a logger + +See \Define multiple loggers\ for further information. + +
getUser + + + +() => Context + + + +Get user information + +See \User context\ for further information. + +
init + + + +(initConfiguration: LogsInitConfiguration) => void + + + +Init the Logs browser SDK. + +
logger + +Logger + +
removeAccountProperty + + + +(key: string) => void + + + +Remove an account property + +
removeGlobalContextProperty + + + +(key: any) => void + + + +Remove a global context property + +See \Overwrite context\ for further information. + +
removeUserProperty + + + +(key: any) => void + + + +Remove a user property + +See \User context\ for further information. + +
setAccount + + + +(newAccount: Account) => void + + + +Set account information to all events, stored in `@account` + +
setAccountProperty + + + +(key: string, property: any) => void + + + +Set or update the account property, stored in `@account.` + +
setGlobalContext + + + +(context: any) => void + + + +Set the global context information to all logs, stored in `@context` + +
setGlobalContextProperty + + + +(key: any, value: any) => void + + + +Set or update a global context property, stored in `@context.` + +
setTrackingConsent + + + +(trackingConsent: TrackingConsent) => void + + + +Set the tracking consent of the current user. + +
setUserProperty + + + +(key: any, property: any) => void + + + +Set or update the user property, stored in `@usr.` + +
+ +## Methods + + + + +
+ +Method + + + +Description + +
setUser(newUser) + +Set user information to all events, stored in `@usr` + +See \User context\ for further information. + +
setUser(newUser) + +Set user information to all events, stored in `@usr` + +
diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 495f21977a..336adac0f0 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeAccountProperty - -## LogsGlobal.removeAccountProperty property - -Remove an account property - -**Signature:** - -```typescript -removeAccountProperty: (key: string) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeAccountProperty + +## LogsGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index a7a626b26d..e66f48c9eb 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty - -## LogsGlobal.removeGlobalContextProperty property - -Remove a global context property - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -removeGlobalContextProperty: (key: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty + +## LogsGlobal.removeGlobalContextProperty property + +Remove a global context property + +See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 941e0422a4..9c4eed3047 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeUserProperty - -## LogsGlobal.removeUserProperty property - -Remove a user property - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -removeUserProperty: (key: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeUserProperty + +## LogsGlobal.removeUserProperty property + +Remove a user property + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index 37b40e0eff..45780ca434 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccount - -## LogsGlobal.setAccount property - -Set account information to all events, stored in `@account` - -**Signature:** - -```typescript -setAccount: (newAccount: Account) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccount + +## LogsGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 1f2361d032..7e7138eab8 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccountProperty - -## LogsGlobal.setAccountProperty property - -Set or update the account property, stored in `@account.` - -**Signature:** - -```typescript -setAccountProperty: (key: string, property: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccountProperty + +## LogsGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index 1dc712cdd2..5a51722e54 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContext - -## LogsGlobal.setGlobalContext property - -Set the global context information to all logs, stored in `@context` - -**Signature:** - -```typescript -setGlobalContext: (context: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContext + +## LogsGlobal.setGlobalContext property + +Set the global context information to all logs, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 912b589ca7..e4279fcad9 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty - -## LogsGlobal.setGlobalContextProperty property - -Set or update a global context property, stored in `@context.` - -**Signature:** - -```typescript -setGlobalContextProperty: (key: any, value: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty + +## LogsGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 53eed52624..c41b0f6b44 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setTrackingConsent - -## LogsGlobal.setTrackingConsent property - -Set the tracking consent of the current user. - -**Signature:** - -```typescript -setTrackingConsent: (trackingConsent: TrackingConsent) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setTrackingConsent + +## LogsGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index d17bd3b963..48ec0e1813 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,55 +1,48 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser - -## LogsGlobal.setUser() method - -Set user information to all events, stored in `@usr` - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -setUser(newUser: User & { - id: string; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newUser - - - - -User & { id: string; } - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser + +## LogsGlobal.setUser() method + +Set user information to all events, stored in `@usr` + +See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +newUser + + + +User & { id: string; } + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 3672c9a314..2ca5fe9992 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,56 +1,48 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser - -## LogsGlobal.setUser() method - -> Warning: This API is now obsolete. -> -> You must specified a user id -> - -Set user information to all events, stored in `@usr` - -**Signature:** - -```typescript -setUser(newUser: User): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newUser - - - - -User - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser + +## LogsGlobal.setUser() method + +> Warning: This API is now obsolete. +> +> You must specified a user id + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +newUser + + + +User + + + +
+**Returns:** + +void diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index e61551e375..6c59cd2ead 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUserProperty - -## LogsGlobal.setUserProperty property - -Set or update the user property, stored in `@usr.` - -**Signature:** - -```typescript -setUserProperty: (key: any, property: any) => void; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUserProperty + +## LogsGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index 113a1f8259..bdfd08cb5e 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > beforeSend - -## LogsInitConfiguration.beforeSend property - -Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs - -**Signature:** - -```typescript -beforeSend?: ((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > beforeSend + +## LogsInitConfiguration.beforeSend property + +Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + +**Signature:** + +```typescript +beforeSend?: ((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index e050d67c7e..b63fd5e735 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs - -## LogsInitConfiguration.forwardConsoleLogs property - -Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. - -**Signature:** - -```typescript -forwardConsoleLogs?: ConsoleApiName[] | 'all' | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs + +## LogsInitConfiguration.forwardConsoleLogs property + +Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + +**Signature:** + +```typescript +forwardConsoleLogs?: ConsoleApiName[] | 'all' | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index 0bd7c189ec..5e6f514f59 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs - -## LogsInitConfiguration.forwardErrorsToLogs property - -Forward console.error logs, uncaught exceptions and network errors to Datadog. true - -**Signature:** - -```typescript -forwardErrorsToLogs?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs + +## LogsInitConfiguration.forwardErrorsToLogs property + +Forward console.error logs, uncaught exceptions and network errors to Datadog. true + +**Signature:** + +```typescript +forwardErrorsToLogs?: boolean | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index 9187f105a3..ccda58a9ee 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardReports - -## LogsInitConfiguration.forwardReports property - -Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. - -**Signature:** - -```typescript -forwardReports?: RawReportType[] | 'all' | undefined; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardReports + +## LogsInitConfiguration.forwardReports property + +Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + +**Signature:** + +```typescript +forwardReports?: RawReportType[] | 'all' | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index fa013c4377..9f80ee9d1b 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,107 +1,89 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration - -## LogsInitConfiguration interface - -**Signature:** - -```typescript -export interface LogsInitConfiguration extends InitConfiguration -``` -**Extends:** InitConfiguration - -## Properties - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
beforeSend? - - - - -((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined - - - - -_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs - - -
forwardConsoleLogs? - - - - -ConsoleApiName\[\] \| 'all' \| undefined - - - - -_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. - - -
forwardErrorsToLogs? - - - - -boolean \| undefined - - - - -_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true - - -
forwardReports? - - - - -RawReportType\[\] \| 'all' \| undefined - - - - -_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. - - -
usePciIntake? - - - - -boolean - - - - -_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false - - -
+ + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration + +## LogsInitConfiguration interface + +**Signature:** + +```typescript +export interface LogsInitConfiguration extends InitConfiguration +``` + +**Extends:** InitConfiguration + +## Properties + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
beforeSend? + + + +((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined + + + +_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + +
forwardConsoleLogs? + + + +ConsoleApiName\[\] \| 'all' \| undefined + + + +_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + +
forwardErrorsToLogs? + + + +boolean \| undefined + + + +_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true + +
forwardReports? + + + +RawReportType\[\] \| 'all' \| undefined + + + +_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + +
usePciIntake? + + + +boolean + + + +_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false + +
diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 250b9efba7..4c00abf6b6 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > usePciIntake - -## LogsInitConfiguration.usePciIntake property - -Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false - -**Signature:** - -```typescript -usePciIntake?: boolean; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > usePciIntake + +## LogsInitConfiguration.usePciIntake property + +Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false + +**Signature:** + +```typescript +usePciIntake?: boolean; +``` diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 9665aa382b..926644aa85 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > context - -## LogsMessage.context property - -**Signature:** - -```typescript -context?: Context; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsMessage > context + +## LogsMessage.context property + +**Signature:** + +```typescript +context?: Context; +``` diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 1a6b06743a..3912103932 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,69 +1,57 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage - -## LogsMessage interface - -**Signature:** - -```typescript -export interface LogsMessage -``` - -## Properties - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
context? - - - - -Context - - - - -_(Optional)_ - - -
message - - - - -string - - - - - -
status - - -StatusType - - -
+ + +[Home](index.html) > @datadog/browser-logs > LogsMessage + +## LogsMessage interface + +**Signature:** + +```typescript +export interface LogsMessage +``` + +## Properties + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
context? + + + +Context + + + +_(Optional)_ + +
message + + + +string + + + +
status + +StatusType + +
diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index 9fe6e2870d..64ed2030f4 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > message - -## LogsMessage.message property - -**Signature:** - -```typescript -message: string; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsMessage > message + +## LogsMessage.message property + +**Signature:** + +```typescript +message: string +``` diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 9f21c4a5ec..28bee3738c 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > status - -## LogsMessage.status property - -**Signature:** - -```typescript -status: StatusType; -``` + + +[Home](index.html) > @datadog/browser-logs > LogsMessage > status + +## LogsMessage.status property + +**Signature:** + +```typescript +status: StatusType +``` diff --git a/docs/browser-logs.md b/docs/browser-logs.md index fd02a380e7..e920036754 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,117 +1,96 @@ - - -[Home](index.html) > @datadog/browser-logs - -## browser-logs package - -## Classes - - - -
- -Class - - - - -Description - - -
Logger - - -
- -## Interfaces - - - - - - - - -
- -Interface - - - - -Description - - -
Logger - - -
LoggerConfiguration - - -
LogsEvent - - -
LogsGlobal - - -
LogsInitConfiguration - - -
LogsMessage - - -
- -## Variables - - - - - -
- -Variable - - - - -Description - - -
datadogLogs - - -
HandlerType - - -
StatusType - - -
- -## Type Aliases - - - - - -
- -Type Alias - - - - -Description - - -
HandlerType - - -
LogsEventDomainContext - - -
StatusType - - -
+ + +[Home](index.html) > @datadog/browser-logs + +## browser-logs package + +## Classes + + + +
+ +Class + + + +Description + +
Logger + +
+ +## Interfaces + + + + + + + + +
+ +Interface + + + +Description + +
Logger + +
LoggerConfiguration + +
LogsEvent + +
LogsGlobal + +
LogsInitConfiguration + +
LogsMessage + +
+ +## Variables + + + + + +
+ +Variable + + + +Description + +
datadogLogs + +
HandlerType + +
StatusType + +
+ +## Type Aliases + + + + + +
+ +Type Alias + + + +Description + +
HandlerType + +
LogsEventDomainContext + +
StatusType + +
diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index b90df513dc..ced0e4f566 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,21 +1,21 @@ - - -[Home](index.html) > @datadog/browser-logs > StatusType - -## StatusType variable - -**Signature:** - -```typescript -StatusType: { - readonly ok: "ok"; - readonly debug: "debug"; - readonly info: "info"; - readonly notice: "notice"; - readonly warn: "warn"; - readonly error: "error"; - readonly critical: "critical"; - readonly alert: "alert"; - readonly emerg: "emerg"; -} -``` + + +[Home](index.html) > @datadog/browser-logs > StatusType + +## StatusType variable + +**Signature:** + +```typescript +StatusType: { + readonly ok: "ok"; + readonly debug: "debug"; + readonly info: "info"; + readonly notice: "notice"; + readonly warn: "warn"; + readonly error: "error"; + readonly critical: "critical"; + readonly alert: "alert"; + readonly emerg: "emerg"; +} +``` diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index b14e46128f..306b76d171 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,63 +1,53 @@ - - -[Home](index.html) > @datadog/browser-rum-react > addReactError - -## addReactError() function - -**Signature:** - -```typescript -export declare function addReactError(error: Error, info: ErrorInfo): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -error - - - - -Error - - - - - -
- -info - - - - -ErrorInfo - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-rum-react > addReactError + +## addReactError() function + +**Signature:** + +```typescript +export declare function addReactError(error: Error, info: ErrorInfo): void +``` + +## Parameters + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +error + + + +Error + + + +
+ +info + + + +ErrorInfo + + + +
+**Returns:** + +void diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index c48ab3bb5c..ad92d3680c 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,47 +1,41 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > (constructor) - -## ErrorBoundary.(constructor) - -Constructs a new instance of the `ErrorBoundary` class - -**Signature:** - -```typescript -constructor(props: Props); -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -props - - - - -Props - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > (constructor) + +## ErrorBoundary.(constructor) + +Constructs a new instance of the `ErrorBoundary` class + +**Signature:** + +```typescript +constructor(props: Props); +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +props + + + +Props + + + +
diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index acbd5e0f3f..4bf2efd602 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,63 +1,53 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch - -## ErrorBoundary.componentDidCatch() method - -**Signature:** - -```typescript -componentDidCatch(error: Error, errorInfo: ErrorInfo): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -error - - - - -Error - - - - - -
- -errorInfo - - - - -ErrorInfo - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch + +## ErrorBoundary.componentDidCatch() method + +**Signature:** + +```typescript +componentDidCatch(error: Error, errorInfo: ErrorInfo): void; +``` + +## Parameters + + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +error + + + +Error + + + +
+ +errorInfo + + + +ErrorInfo + + + +
+**Returns:** + +void diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index b4e3372e47..dc80c95051 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,49 +1,42 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError - -## ErrorBoundary.getDerivedStateFromError() method - -**Signature:** - -```typescript -static getDerivedStateFromError(error: Error): State; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -error - - - - -Error - - - - - -
-**Returns:** - -State - + + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError + +## ErrorBoundary.getDerivedStateFromError() method + +**Signature:** + +```typescript +static getDerivedStateFromError(error: Error): State; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +error + + + +Error + + + +
+**Returns:** + +State diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 22ebac85d6..695eccac12 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,121 +1,101 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary - -## ErrorBoundary class - -**Signature:** - -```typescript -export declare class ErrorBoundary extends React.Component -``` -**Extends:** React.Component<Props, State> - -## Constructors - - - -
- -Constructor - - - - -Modifiers - - - - -Description - - -
(constructor)(props) - - - - -Constructs a new instance of the `ErrorBoundary` class - - -
- -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
resetError - - - - -() => void - - - - - -
- -## Methods - - - - - -
- -Method - - - - -Modifiers - - - - -Description - - -
componentDidCatch(error, errorInfo) - - - - - -
getDerivedStateFromError(error) - -`static` - - - - - -
render() - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary + +## ErrorBoundary class + +**Signature:** + +```typescript +export declare class ErrorBoundary extends React.Component +``` + +**Extends:** React.Component<Props, State> + +## Constructors + + + +
+ +Constructor + + + +Modifiers + + + +Description + +
(constructor)(props) + + + +Constructs a new instance of the `ErrorBoundary` class + +
+ +## Properties + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
resetError + + + +() => void + + + +
+ +## Methods + + + + + +
+ +Method + + + +Modifiers + + + +Description + +
componentDidCatch(error, errorInfo) + + + +
getDerivedStateFromError(error) + +`static` + + + +
render() + + + +
diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 7d3d23d667..5f8a55e0d8 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > render - -## ErrorBoundary.render() method - -**Signature:** - -```typescript -render(): React.ReactNode; -``` -**Returns:** - -React.ReactNode - + + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > render + +## ErrorBoundary.render() method + +**Signature:** + +```typescript +render(): React.ReactNode; +``` + +**Returns:** + +React.ReactNode diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index ad8112fbda..9d36964745 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > resetError - -## ErrorBoundary.resetError property - -**Signature:** - -```typescript -resetError: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > resetError + +## ErrorBoundary.resetError property + +**Signature:** + +```typescript +resetError: () => void; +``` diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index d980c3ec65..e70a74520d 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,66 +1,56 @@ - - -[Home](index.html) > @datadog/browser-rum-react - -## browser-rum-react package - -## Classes - - - -
- -Class - - - - -Description - - -
ErrorBoundary - - -
- -## Functions - - - - -
- -Function - - - - -Description - - -
addReactError(error, info) - - -
reactPlugin(configuration) - - -
- -## Variables - - - -
- -Variable - - - - -Description - - -
UNSTABLE\_ReactComponentTracker - - -
+ + +[Home](index.html) > @datadog/browser-rum-react + +## browser-rum-react package + +## Classes + + + +
+ +Class + + + +Description + +
ErrorBoundary + +
+ +## Functions + + + + +
+ +Function + + + +Description + +
addReactError(error, info) + +
reactPlugin(configuration) + +
+ +## Variables + + + +
+ +Variable + + + +Description + +
UNSTABLE\_ReactComponentTracker + +
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index dae5012a46..abeb4849f9 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,63 +1,57 @@ - - -[Home](index.html) > @datadog/browser-rum-react > reactPlugin - -## reactPlugin() function - -**Signature:** - -```typescript -export declare function reactPlugin(configuration?: ReactPluginConfiguration): { - name: string; - onInit({ publicApi, initConfiguration }: { - initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; - publicApi: RumPublicApi; - }): void; - onRumStart({ strategy }: { - strategy: Strategy; - }): void; - getConfigurationTelemetry(): { - router: boolean; - }; -}; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -configuration - - - - -ReactPluginConfiguration - - - - -_(Optional)_ - - -
-**Returns:** - -{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } - + + +[Home](index.html) > @datadog/browser-rum-react > reactPlugin + +## reactPlugin() function + +**Signature:** + +```typescript +export declare function reactPlugin(configuration?: ReactPluginConfiguration): { + name: string + onInit({ + publicApi, + initConfiguration, + }: { + initConfiguration: import('@datadog/browser-rum-core').RumInitConfiguration + publicApi: RumPublicApi + }): void + onRumStart({ strategy }: { strategy: Strategy }): void + getConfigurationTelemetry(): { + router: boolean + } +} +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +configuration + + + +ReactPluginConfiguration + + + +_(Optional)_ + +
+**Returns:** + +{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 969e542421..20e3bf8667 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,14 +1,12 @@ - - -[Home](index.html) > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker - -## UNSTABLE\_ReactComponentTracker variable - -**Signature:** - -```typescript -UNSTABLE_ReactComponentTracker: ({ name: componentName, children, }: { - name: string; - children?: React.ReactNode; -}) => React.JSX.Element -``` + + +[Home](index.html) > @datadog/browser-rum-react > UNSTABLE_ReactComponentTracker + +## UNSTABLE_ReactComponentTracker variable + +**Signature:** + +```typescript +UNSTABLE_ReactComponentTracker: ({ name: componentName, children }: { name: string; children?: React.ReactNode }) => + React.JSX.Element +``` diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 782acb9e0d..a4075adcf4 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum-slim > datadogRum - -## datadogRum variable - -**Signature:** - -```typescript -datadogRum: RumPublicApi -``` + + +[Home](index.html) > @datadog/browser-rum-slim > datadogRum + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index d7b1d56aae..5bea49891a 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,24 +1,21 @@ - - -[Home](index.html) > @datadog/browser-rum-slim - -## browser-rum-slim package - -## Variables - - - -
- -Variable - - - - -Description - - -
datadogRum - - -
+ + +[Home](index.html) > @datadog/browser-rum-slim + +## browser-rum-slim package + +## Variables + + + +
+ +Variable + + + +Description + +
datadogRum + +
diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 750fa31f36..9d402cac58 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,27 +1,27 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > \_dd - -## CommonProperties.\_dd property - -Internal properties - -**Signature:** - -```typescript -readonly _dd: { - readonly format_version: 2; - session?: { - plan?: 1 | 2; - readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; - [k: string]: unknown; - }; - readonly configuration?: { - readonly session_sample_rate: number; - readonly session_replay_sample_rate?: number; - [k: string]: unknown; - }; - readonly browser_sdk_version?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > \_dd + +## CommonProperties.\_dd property + +Internal properties + +**Signature:** + +```typescript +readonly _dd: { + readonly format_version: 2; + session?: { + plan?: 1 | 2; + readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; + [k: string]: unknown; + }; + readonly configuration?: { + readonly session_sample_rate: number; + readonly session_replay_sample_rate?: number; + [k: string]: unknown; + }; + readonly browser_sdk_version?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 98aecc2164..dd7e7293af 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,17 +1,17 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > account - -## CommonProperties.account property - -Account properties - -**Signature:** - -```typescript -readonly account?: { - readonly id: string; - readonly name?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > account + +## CommonProperties.account property + +Account properties + +**Signature:** + +```typescript +readonly account?: { + readonly id: string; + readonly name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index fdb5f90184..501cfa5b51 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > application - -## CommonProperties.application property - -Application properties - -**Signature:** - -```typescript -readonly application: { - readonly id: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > application + +## CommonProperties.application property + +Application properties + +**Signature:** + +```typescript +readonly application: { + readonly id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 5df6d027b9..9194faf7df 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > build\_id - -## CommonProperties.build\_id property - -Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. - -**Signature:** - -```typescript -readonly build_id?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > build_id + +## CommonProperties.build_id property + +Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + +**Signature:** + +```typescript +readonly build_id?: string; +``` diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index d0072260a0..f08912e915 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > build\_version - -## CommonProperties.build\_version property - -The build version for this application - -**Signature:** - -```typescript -readonly build_version?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > build_version + +## CommonProperties.build_version property + +The build version for this application + +**Signature:** + +```typescript +readonly build_version?: string; +``` diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index f1fbe23c5b..07a148c533 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > ci\_test - -## CommonProperties.ci\_test property - -CI Visibility properties - -**Signature:** - -```typescript -readonly ci_test?: { - readonly test_execution_id: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > ci_test + +## CommonProperties.ci_test property + +CI Visibility properties + +**Signature:** + +```typescript +readonly ci_test?: { + readonly test_execution_id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 8e0ec46ed7..cdd6f0ddfd 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,23 +1,23 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > connectivity - -## CommonProperties.connectivity property - -Device connectivity properties - -**Signature:** - -```typescript -connectivity?: { - readonly status: 'connected' | 'not_connected' | 'maybe'; - readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; - readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; - readonly cellular?: { - readonly technology?: string; - readonly carrier_name?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > connectivity + +## CommonProperties.connectivity property + +Device connectivity properties + +**Signature:** + +```typescript +connectivity?: { + readonly status: 'connected' | 'not_connected' | 'maybe'; + readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; + readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; + readonly cellular?: { + readonly technology?: string; + readonly carrier_name?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index 770edb06c3..35fa30d973 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > context - -## CommonProperties.context property - -User provided context - -**Signature:** - -```typescript -context?: { - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > context + +## CommonProperties.context property + +User provided context + +**Signature:** + +```typescript +context?: { + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index f792d7cf3c..22c58addfd 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > date - -## CommonProperties.date property - -Start of the event in ms from epoch - -**Signature:** - -```typescript -readonly date: number; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > date + +## CommonProperties.date property + +Start of the event in ms from epoch + +**Signature:** + +```typescript +readonly date: number; +``` diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index 6027154b29..49d6aa0b6c 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,20 +1,20 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > device - -## CommonProperties.device property - -Device properties - -**Signature:** - -```typescript -device?: { - readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; - readonly name?: string; - readonly model?: string; - readonly brand?: string; - readonly architecture?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > device + +## CommonProperties.device property + +Device properties + +**Signature:** + +```typescript +device?: { + readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; + readonly name?: string; + readonly model?: string; + readonly brand?: string; + readonly architecture?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index e684c6f119..4eb03d20e5 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,20 +1,20 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > display - -## CommonProperties.display property - -Display properties - -**Signature:** - -```typescript -display?: { - readonly viewport?: { - readonly width: number; - readonly height: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > display + +## CommonProperties.display property + +Display properties + +**Signature:** + +```typescript +display?: { + readonly viewport?: { + readonly width: number; + readonly height: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 8badf26cf8..05cac90147 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,328 +1,267 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties - -## CommonProperties interface - -Schema of common properties of RUM events - -**Signature:** - -```typescript -export interface CommonProperties -``` - -## Properties - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
\_dd - -`readonly` - - - - -{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } - - - - -Internal properties - - -
account? - -`readonly` - - - - -{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Account properties - - -
application - -`readonly` - - - - -{ readonly id: string; \[k: string\]: unknown; } - - - - -Application properties - - -
build\_id? - -`readonly` - - - - -string - - - - -_(Optional)_ Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. - - -
build\_version? - -`readonly` - - - - -string - - - - -_(Optional)_ The build version for this application - - -
ci\_test? - -`readonly` - - - - -{ readonly test\_execution\_id: string; \[k: string\]: unknown; } - - - - -_(Optional)_ CI Visibility properties - - -
connectivity? - - - - -{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } - - - - -_(Optional)_ Device connectivity properties - - -
context? - - - - -{ \[k: string\]: unknown; } - - - - -_(Optional)_ User provided context - - -
date - -`readonly` - - - - -number - - - - -Start of the event in ms from epoch - - -
device? - - - - -{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Device properties - - -
display? - - - - -{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } - - - - -_(Optional)_ Display properties - - -
os? - - - - -{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } - - - - -_(Optional)_ Operating system properties - - -
service? - - - - -string - - - - -_(Optional)_ The service name for this application - - -
session - -`readonly` - - - - -{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } - - - - -Session properties - - -
source? - -`readonly` - - - - -'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' - - - - -_(Optional)_ The source of this event - - -
synthetics? - -`readonly` - - - - -{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } - - - - -_(Optional)_ Synthetics properties - - -
usr? - -`readonly` - - - - -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } - - - - -_(Optional)_ User properties - - -
version? - - - - -string - - - - -_(Optional)_ The version for this application - - -
view - -`readonly` - - - - -{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } - - - - -View properties - - -
+ + +[Home](index.html) > @datadog/browser-rum > CommonProperties + +## CommonProperties interface + +Schema of common properties of RUM events + +**Signature:** + +```typescript +export interface CommonProperties +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
\_dd + +`readonly` + + + +{ readonly format_version: 2; session?: { plan?: 1 \| 2; readonly session_precondition?: 'user_app_launch' \| 'inactivity_timeout' \| 'max_duration' \| 'background_launch' \| 'prewarm' \| 'from_non_interactive_session' \| 'explicit_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; \[k: string\]: unknown; }; readonly browser_sdk_version?: string; \[k: string\]: unknown; } + + + +Internal properties + +
account? + +`readonly` + + + +{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } + + + +_(Optional)_ Account properties + +
application + +`readonly` + + + +{ readonly id: string; \[k: string\]: unknown; } + + + +Application properties + +
build\_id? + +`readonly` + + + +string + + + +_(Optional)_ Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + +
build\_version? + +`readonly` + + + +string + + + +_(Optional)_ The build version for this application + +
ci\_test? + +`readonly` + + + +{ readonly test_execution_id: string; \[k: string\]: unknown; } + + + +_(Optional)_ CI Visibility properties + +
connectivity? + + + +{ readonly status: 'connected' \| 'not_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + +_(Optional)_ Device connectivity properties + +
context? + + + +{ \[k: string\]: unknown; } + + + +_(Optional)_ User provided context + +
date + +`readonly` + + + +number + + + +Start of the event in ms from epoch + +
device? + + + +{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } + + + +_(Optional)_ Device properties + +
display? + + + +{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + +_(Optional)_ Display properties + +
os? + + + +{ readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; \[k: string\]: unknown; } + + + +_(Optional)_ Operating system properties + +
service? + + + +string + + + +_(Optional)_ The service name for this application + +
session + +`readonly` + + + +{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci_test'; readonly has_replay?: boolean; \[k: string\]: unknown; } + + + +Session properties + +
source? + +`readonly` + + + +'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' + + + +_(Optional)_ The source of this event + +
synthetics? + +`readonly` + + + +{ readonly test_id: string; readonly result_id: string; readonly injected?: boolean; \[k: string\]: unknown; } + + + +_(Optional)_ Synthetics properties + +
usr? + +`readonly` + + + +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; \[k: string\]: unknown; } + + + +_(Optional)_ User properties + +
version? + + + +string + + + +_(Optional)_ The version for this application + +
view + +`readonly` + + + +{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } + + + +View properties + +
diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 0ffb1e0ca6..c4294b5ad8 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > os - -## CommonProperties.os property - -Operating system properties - -**Signature:** - -```typescript -os?: { - readonly name: string; - readonly version: string; - readonly build?: string; - readonly version_major: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > os + +## CommonProperties.os property + +Operating system properties + +**Signature:** + +```typescript +os?: { + readonly name: string; + readonly version: string; + readonly build?: string; + readonly version_major: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index 8312b10a9f..d7db1f5d4d 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > service - -## CommonProperties.service property - -The service name for this application - -**Signature:** - -```typescript -service?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > service + +## CommonProperties.service property + +The service name for this application + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index 0ee51ed666..555f71d4ae 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > session - -## CommonProperties.session property - -Session properties - -**Signature:** - -```typescript -readonly session: { - readonly id: string; - readonly type: 'user' | 'synthetics' | 'ci_test'; - readonly has_replay?: boolean; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > session + +## CommonProperties.session property + +Session properties + +**Signature:** + +```typescript +readonly session: { + readonly id: string; + readonly type: 'user' | 'synthetics' | 'ci_test'; + readonly has_replay?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index 49f6472d37..aed2324e5b 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > source - -## CommonProperties.source property - -The source of this event - -**Signature:** - -```typescript -readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > source + +## CommonProperties.source property + +The source of this event + +**Signature:** + +```typescript +readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'; +``` diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 75f3a7702e..233cc3e07e 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > synthetics - -## CommonProperties.synthetics property - -Synthetics properties - -**Signature:** - -```typescript -readonly synthetics?: { - readonly test_id: string; - readonly result_id: string; - readonly injected?: boolean; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > synthetics + +## CommonProperties.synthetics property + +Synthetics properties + +**Signature:** + +```typescript +readonly synthetics?: { + readonly test_id: string; + readonly result_id: string; + readonly injected?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index b28bb859b5..32b980eaf8 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > usr - -## CommonProperties.usr property - -User properties - -**Signature:** - -```typescript -readonly usr?: { - readonly id?: string; - readonly name?: string; - readonly email?: string; - readonly anonymous_id?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > usr + +## CommonProperties.usr property + +User properties + +**Signature:** + +```typescript +readonly usr?: { + readonly id?: string; + readonly name?: string; + readonly email?: string; + readonly anonymous_id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index fd63365165..512f5d693c 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > version - -## CommonProperties.version property - -The version for this application - -**Signature:** - -```typescript -version?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > version + +## CommonProperties.version property + +The version for this application + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index e9fb8b0cb1..b4b2d8df5c 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > view - -## CommonProperties.view property - -View properties - -**Signature:** - -```typescript -readonly view: { - readonly id: string; - referrer?: string; - url: string; - name?: string; - [k: string]: unknown; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > CommonProperties > view + +## CommonProperties.view property + +View properties + +**Signature:** + +```typescript +readonly view: { + readonly id: string; + referrer?: string; + url: string; + name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 90be04739b..3377ae68e9 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > datadogRum - -## datadogRum variable - -**Signature:** - -```typescript -datadogRum: RumPublicApi -``` + + +[Home](index.html) > @datadog/browser-rum > datadogRum + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/browser-rum.md b/docs/browser-rum.md index a8e72c2601..832230798f 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,142 +1,117 @@ - - -[Home](index.html) > @datadog/browser-rum - -## browser-rum package - -## Interfaces - - - - - - - - - - - - -
- -Interface - - - - -Description - - -
CommonProperties - -Schema of common properties of RUM events - - -
RumActionEventDomainContext - - -
RumErrorEventDomainContext - - -
RumFetchResourceEventDomainContext - - -
RumGlobal - - -
RumInitConfiguration - - -
RumLongTaskEventDomainContext - - -
RumOtherResourceEventDomainContext - - -
RumViewEventDomainContext - - -
RumXhrResourceEventDomainContext - - -
- -## Variables - - - -
- -Variable - - - - -Description - - -
datadogRum - - -
- -## Type Aliases - - - - - - - - - - -
- -Type Alias - - - - -Description - - -
RumActionEvent - -Schema of all properties of an Action event - - -
RumErrorEvent - -Schema of all properties of an Error event - - -
RumEvent - -Schema of all properties of a RUM event - - -
RumEventDomainContext - - -
RumLongTaskEvent - -Schema of all properties of a Long Task event - - -
RumResourceEvent - -Schema of all properties of a Resource event - - -
RumViewEvent - -Schema of all properties of a View event - - -
RumVitalEvent - -Schema of all properties of a Vital event - - -
+ + +[Home](index.html) > @datadog/browser-rum + +## browser-rum package + +## Interfaces + + + + + + + + + + + + +
+ +Interface + + + +Description + +
CommonProperties + +Schema of common properties of RUM events + +
RumActionEventDomainContext + +
RumErrorEventDomainContext + +
RumFetchResourceEventDomainContext + +
RumGlobal + +
RumInitConfiguration + +
RumLongTaskEventDomainContext + +
RumOtherResourceEventDomainContext + +
RumViewEventDomainContext + +
RumXhrResourceEventDomainContext + +
+ +## Variables + + + +
+ +Variable + + + +Description + +
datadogRum + +
+ +## Type Aliases + + + + + + + + + + +
+ +Type Alias + + + +Description + +
RumActionEvent + +Schema of all properties of an Action event + +
RumErrorEvent + +Schema of all properties of an Error event + +
RumEvent + +Schema of all properties of a RUM event + +
RumEventDomainContext + +
RumLongTaskEvent + +Schema of all properties of a Long Task event + +
RumResourceEvent + +Schema of all properties of a Resource event + +
RumViewEvent + +Schema of all properties of a View event + +
RumVitalEvent + +Schema of all properties of a Vital event + +
diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index cd7d82a026..534425ff88 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,70 +1,77 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEvent - -## RumActionEvent type - -Schema of all properties of an Action event - -**Signature:** - -```typescript -export type RumActionEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'action'; - readonly action: { - readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; - readonly id?: string; - readonly loading_time?: number; - readonly target?: { - name: string; - [k: string]: unknown; - }; - readonly frustration?: { - readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; - [k: string]: unknown; - }; - readonly error?: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly resource?: { - readonly count: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - _dd?: { - readonly action?: { - readonly position?: { - readonly x: number; - readonly y: number; - [k: string]: unknown; - }; - target?: { - readonly selector?: string; - readonly width?: number; - readonly height?: number; - [k: string]: unknown; - }; - name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumActionEvent + +## RumActionEvent type + +Schema of all properties of an Action event + +**Signature:** + +```typescript +export type RumActionEvent = CommonProperties & + ViewContainerSchema & { + readonly type: 'action' + readonly action: { + readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back' + readonly id?: string + readonly loading_time?: number + readonly target?: { + name: string + [k: string]: unknown + } + readonly frustration?: { + readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[] + [k: string]: unknown + } + readonly error?: { + readonly count: number + [k: string]: unknown + } + readonly crash?: { + readonly count: number + [k: string]: unknown + } + readonly long_task?: { + readonly count: number + [k: string]: unknown + } + readonly resource?: { + readonly count: number + [k: string]: unknown + } + [k: string]: unknown + } + readonly view?: { + readonly in_foreground?: boolean + [k: string]: unknown + } + _dd?: { + readonly action?: { + readonly position?: { + readonly x: number + readonly y: number + [k: string]: unknown + } + target?: { + readonly selector?: string + readonly width?: number + readonly height?: number + [k: string]: unknown + } + name_source?: + | 'custom_attribute' + | 'mask_placeholder' + | 'standard_attribute' + | 'text_content' + | 'mask_disallowed' + | 'blank' + [k: string]: unknown + } + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 4347b4fdc7..84db3c77de 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > events - -## RumActionEventDomainContext.events property - -**Signature:** - -```typescript -events?: Event[]; -``` + + +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > events + +## RumActionEventDomainContext.events property + +**Signature:** + +```typescript +events?: Event[]; +``` diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index c5034c308f..d7c03fe471 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > handlingStack - -## RumActionEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > handlingStack + +## RumActionEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 4ede6d3b25..1549fb2ca2 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,64 +1,54 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext - -## RumActionEventDomainContext interface - -**Signature:** - -```typescript -export interface RumActionEventDomainContext -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
events? - - - - -Event\[\] - - - - -_(Optional)_ - - -
handlingStack? - - - - -string - - - - -_(Optional)_ - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext + +## RumActionEventDomainContext interface + +**Signature:** + +```typescript +export interface RumActionEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
events? + + + +Event\[\] + + + +_(Optional)_ + +
handlingStack? + + + +string + + + +_(Optional)_ + +
diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index 92c6f306e4..ad1edd4639 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,94 +1,119 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEvent - -## RumErrorEvent type - -Schema of all properties of an Error event - -**Signature:** - -```typescript -export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'error'; - readonly error: { - readonly id?: string; - message: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - stack?: string; - causes?: { - message: string; - readonly type?: string; - stack?: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - [k: string]: unknown; - }[]; - readonly is_crash?: boolean; - fingerprint?: string; - readonly type?: string; - readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; - readonly handling?: 'handled' | 'unhandled'; - readonly handling_stack?: string; - readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; - readonly resource?: { - readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - readonly status_code: number; - url: string; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - threads?: { - readonly name: string; - readonly crashed: boolean; - readonly stack: string; - readonly state?: string; - [k: string]: unknown; - }[]; - readonly binary_images?: { - readonly uuid: string; - readonly name: string; - readonly is_system: boolean; - readonly load_address?: string; - readonly max_address?: string; - readonly arch?: string; - [k: string]: unknown; - }[]; - readonly was_truncated?: boolean; - readonly meta?: { - readonly code_type?: string; - readonly parent_process?: string; - readonly incident_identifier?: string; - readonly process?: string; - readonly exception_type?: string; - readonly exception_codes?: string; - readonly path?: string; - [k: string]: unknown; - }; - readonly csp?: { - readonly disposition?: 'enforce' | 'report'; - [k: string]: unknown; - }; - readonly time_since_app_start?: number; - [k: string]: unknown; - }; - readonly freeze?: { - readonly duration: number; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumErrorEvent + +## RumErrorEvent type + +Schema of all properties of an Error event + +**Signature:** + +```typescript +export type RumErrorEvent = CommonProperties & + ActionChildProperties & + ViewContainerSchema & { + readonly type: 'error' + readonly error: { + readonly id?: string + message: string + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report' + stack?: string + causes?: { + message: string + readonly type?: string + stack?: string + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report' + [k: string]: unknown + }[] + readonly is_crash?: boolean + fingerprint?: string + readonly type?: string + readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning' + readonly handling?: 'handled' | 'unhandled' + readonly handling_stack?: string + readonly source_type?: + | 'android' + | 'browser' + | 'ios' + | 'react-native' + | 'flutter' + | 'roku' + | 'ndk' + | 'ios+il2cpp' + | 'ndk+il2cpp' + readonly resource?: { + readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT' + readonly status_code: number + url: string + readonly provider?: { + readonly domain?: string + readonly name?: string + readonly type?: + | 'ad' + | 'advertising' + | 'analytics' + | 'cdn' + | 'content' + | 'customer-success' + | 'first party' + | 'hosting' + | 'marketing' + | 'other' + | 'social' + | 'tag-manager' + | 'utility' + | 'video' + [k: string]: unknown + } + [k: string]: unknown + } + threads?: { + readonly name: string + readonly crashed: boolean + readonly stack: string + readonly state?: string + [k: string]: unknown + }[] + readonly binary_images?: { + readonly uuid: string + readonly name: string + readonly is_system: boolean + readonly load_address?: string + readonly max_address?: string + readonly arch?: string + [k: string]: unknown + }[] + readonly was_truncated?: boolean + readonly meta?: { + readonly code_type?: string + readonly parent_process?: string + readonly incident_identifier?: string + readonly process?: string + readonly exception_type?: string + readonly exception_codes?: string + readonly path?: string + [k: string]: unknown + } + readonly csp?: { + readonly disposition?: 'enforce' | 'report' + [k: string]: unknown + } + readonly time_since_app_start?: number + [k: string]: unknown + } + readonly freeze?: { + readonly duration: number + [k: string]: unknown + } + readonly view?: { + readonly in_foreground?: boolean + [k: string]: unknown + } + readonly feature_flags?: { + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 20dca2e9db..ce98ebfb2e 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > error - -## RumErrorEventDomainContext.error property - -**Signature:** - -```typescript -error: unknown; -``` + + +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > error + +## RumErrorEventDomainContext.error property + +**Signature:** + +```typescript +error: unknown +``` diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 375e308535..40040e52c0 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack - -## RumErrorEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack + +## RumErrorEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index f75af78ce6..3bd11be761 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,62 +1,52 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext - -## RumErrorEventDomainContext interface - -**Signature:** - -```typescript -export interface RumErrorEventDomainContext -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
error - - - - -unknown - - - - - -
handlingStack? - - - - -string - - - - -_(Optional)_ - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext + +## RumErrorEventDomainContext interface + +**Signature:** + +```typescript +export interface RumErrorEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
error + + + +unknown + + + +
handlingStack? + + + +string + + + +_(Optional)_ + +
diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index ca11de07b5..d7e3f0ca25 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,15 +1,21 @@ - - -[Home](index.html) > @datadog/browser-rum > RumEvent - -## RumEvent type - -Schema of all properties of a RUM event - -**Signature:** - -```typescript -export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; -``` -**References:** [RumActionEvent](./browser-rum.rumactionevent.md), [RumErrorEvent](./browser-rum.rumerrorevent.md), [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md), [RumResourceEvent](./browser-rum.rumresourceevent.md), [RumViewEvent](./browser-rum.rumviewevent.md), [RumVitalEvent](./browser-rum.rumvitalevent.md) - + + +[Home](index.html) > @datadog/browser-rum > RumEvent + +## RumEvent type + +Schema of all properties of a RUM event + +**Signature:** + +```typescript +export type RumEvent = + | RumActionEvent + | RumErrorEvent + | RumLongTaskEvent + | RumResourceEvent + | RumViewEvent + | RumVitalEvent +``` + +**References:** [RumActionEvent](./browser-rum.rumactionevent.md), [RumErrorEvent](./browser-rum.rumerrorevent.md), [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md), [RumResourceEvent](./browser-rum.rumresourceevent.md), [RumViewEvent](./browser-rum.rumviewevent.md), [RumVitalEvent](./browser-rum.rumvitalevent.md) diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 22a6f63243..bca352f4df 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,13 +1,25 @@ - - -[Home](index.html) > @datadog/browser-rum > RumEventDomainContext - -## RumEventDomainContext type - -**Signature:** - -```typescript -export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; -``` -**References:** [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md), [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md), [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md), [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md), [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) - + + +[Home](index.html) > @datadog/browser-rum > RumEventDomainContext + +## RumEventDomainContext type + +**Signature:** + +```typescript +export type RumEventDomainContext = T extends RumEventType.VIEW + ? RumViewEventDomainContext + : T extends RumEventType.ACTION + ? RumActionEventDomainContext + : T extends RumEventType.RESOURCE + ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext + : T extends RumEventType.ERROR + ? RumErrorEventDomainContext + : T extends RumEventType.LONG_TASK + ? RumLongTaskEventDomainContext + : T extends RumEventType.VITAL + ? RumVitalEventDomainContext + : never +``` + +**References:** [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md), [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md), [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md), [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md), [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 5965c8c603..94e0a7c531 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > error - -## RumFetchResourceEventDomainContext.error property - -**Signature:** - -```typescript -error?: Error; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > error + +## RumFetchResourceEventDomainContext.error property + +**Signature:** + +```typescript +error?: Error; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index 928e81f8ae..7575f76fa4 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack - -## RumFetchResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack + +## RumFetchResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 7125b554b4..8e6bc6f383 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted - -## RumFetchResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted + +## RumFetchResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 013d077804..a8d998e08e 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,130 +1,105 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext - -## RumFetchResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumFetchResourceEventDomainContext -``` - -## Properties - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
error? - - - - -Error - - - - -_(Optional)_ - - -
handlingStack? - - - - -string - - - - -_(Optional)_ - - -
isAborted - - - - -boolean - - - - - -
performanceEntry? - - - - -PerformanceEntry - - - - -_(Optional)_ - - -
requestInit? - - - - -RequestInit - - - - -_(Optional)_ - - -
requestInput - - - - -RequestInfo - - - - - -
response? - - - - -Response - - - - -_(Optional)_ - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext + +## RumFetchResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumFetchResourceEventDomainContext +``` + +## Properties + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
error? + + + +Error + + + +_(Optional)_ + +
handlingStack? + + + +string + + + +_(Optional)_ + +
isAborted + + + +boolean + + + +
performanceEntry? + + + +PerformanceEntry + + + +_(Optional)_ + +
requestInit? + + + +RequestInit + + + +_(Optional)_ + +
requestInput + + + +RequestInfo + + + +
response? + + + +Response + + + +_(Optional)_ + +
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 65dfa2ca84..4d8eac7ed3 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry - -## RumFetchResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry + +## RumFetchResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 137efdcf0d..5077a77e46 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit - -## RumFetchResourceEventDomainContext.requestInit property - -**Signature:** - -```typescript -requestInit?: RequestInit; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit + +## RumFetchResourceEventDomainContext.requestInit property + +**Signature:** + +```typescript +requestInit?: RequestInit; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index afe134436c..06b6890b79 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput - -## RumFetchResourceEventDomainContext.requestInput property - -**Signature:** - -```typescript -requestInput: RequestInfo; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput + +## RumFetchResourceEventDomainContext.requestInput property + +**Signature:** + +```typescript +requestInput: RequestInfo +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 99b2be672b..b5fc662d3c 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > response - -## RumFetchResourceEventDomainContext.response property - -**Signature:** - -```typescript -response?: Response; -``` + + +[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > response + +## RumFetchResourceEventDomainContext.response property + +**Signature:** + +```typescript +response?: Response; +``` diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 4eefca4332..c73ab4b095 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addAction - -## RumGlobal.addAction property - -Add a custom action, stored in `@action` - -**Signature:** - -```typescript -addAction: (name: string, context?: object) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > addAction + +## RumGlobal.addAction property + +Add a custom action, stored in `@action` + +**Signature:** + +```typescript +addAction: (name: string, context?: object) => void; +``` diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index 3fcd880e7d..77342d362d 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addDurationVital - -## RumGlobal.addDurationVital property - -Add a custom duration vital - -**Signature:** - -```typescript -addDurationVital: (name: string, options: { - startTime: number; - duration: number; - context?: object; - description?: string; - }) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > addDurationVital + +## RumGlobal.addDurationVital property + +Add a custom duration vital + +**Signature:** + +```typescript +addDurationVital: (name: string, options: { + startTime: number; + duration: number; + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index 9b9bb6f4cc..7154181633 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addError - -## RumGlobal.addError property - -Add a custom error, stored in `@error`. - -**Signature:** - -```typescript -addError: (error: unknown, context?: object) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > addError + +## RumGlobal.addError property + +Add a custom error, stored in `@error`. + +**Signature:** + +```typescript +addError: (error: unknown, context?: object) => void; +``` diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 9a361d4204..41f53c3541 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation - -## RumGlobal.addFeatureFlagEvaluation property - -Add a feature flag evaluation, stored in `@feature_flags.` - -**Signature:** - -```typescript -addFeatureFlagEvaluation: (key: string, value: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation + +## RumGlobal.addFeatureFlagEvaluation property + +Add a feature flag evaluation, stored in `@feature_flags.` + +**Signature:** + +```typescript +addFeatureFlagEvaluation: (key: string, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 56c6feb657..7b23629781 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addTiming - -## RumGlobal.addTiming property - -Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` - -**Signature:** - -```typescript -addTiming: (name: string, time?: number) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > addTiming + +## RumGlobal.addTiming property + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + +**Signature:** + +```typescript +addTiming: (name: string, time?: number) => void; +``` diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 9dd5739fca..3526bf77d9 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearAccount - -## RumGlobal.clearAccount property - -Clear all account information - -**Signature:** - -```typescript -clearAccount: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearAccount + +## RumGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index aff7820af7..14dbe38626 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearGlobalContext - -## RumGlobal.clearGlobalContext property - -Clear the global context - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -clearGlobalContext: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearGlobalContext + +## RumGlobal.clearGlobalContext property + +Clear the global context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 5ca3eea115..78fae53ee2 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearUser - -## RumGlobal.clearUser property - -Clear all user information - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -clearUser: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > clearUser + +## RumGlobal.clearUser property + +Clear all user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index e6fe727326..63825b4aa8 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getAccount - -## RumGlobal.getAccount property - -Get account information - -**Signature:** - -```typescript -getAccount: () => Context; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getAccount + +## RumGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context +``` diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 12f6b8ab44..913130ce90 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getGlobalContext - -## RumGlobal.getGlobalContext property - -Get the global Context - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -getGlobalContext: () => Context; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getGlobalContext + +## RumGlobal.getGlobalContext property + +Get the global Context + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context +``` diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 2f59bd8dc6..e4baeafa1f 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getInitConfiguration - -## RumGlobal.getInitConfiguration property - -Get the init configuration - -**Signature:** - -```typescript -getInitConfiguration: () => RumInitConfiguration | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getInitConfiguration + +## RumGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => RumInitConfiguration | undefined +``` diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index a1f0f79cbd..be48ed076f 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getInternalContext - -## RumGlobal.getInternalContext property - -\[Internal API\] Get the internal SDK context - -**Signature:** - -```typescript -getInternalContext: (startTime?: number) => InternalContext | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getInternalContext + +## RumGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined +``` diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index bdbfbeb2de..21a2243808 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getSessionReplayLink - -## RumGlobal.getSessionReplayLink property - -Get the Session Replay Link. - -See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. - -**Signature:** - -```typescript -getSessionReplayLink: () => string | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getSessionReplayLink + +## RumGlobal.getSessionReplayLink property + +Get the Session Replay Link. + +See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + +**Signature:** + +```typescript +getSessionReplayLink: () => string | undefined +``` diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index d7bc50d723..45c2d66e37 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getUser - -## RumGlobal.getUser property - -Get user information - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -getUser: () => Context; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getUser + +## RumGlobal.getUser property + +Get user information + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +getUser: () => Context +``` diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index c4b60a615d..c222d32a38 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getViewContext - -## RumGlobal.getViewContext property - -Get View Context. - -**Signature:** - -```typescript -getViewContext: () => Context; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > getViewContext + +## RumGlobal.getViewContext property + +Get View Context. + +**Signature:** + +```typescript +getViewContext: () => Context +``` diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 6f7f24c4cf..4f8891a801 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > init - -## RumGlobal.init property - -Init the RUM browser SDK. - -**Signature:** - -```typescript -init: (initConfiguration: RumInitConfiguration) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > init + +## RumGlobal.init property + +Init the RUM browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: RumInitConfiguration) => void; +``` diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index dd5fab4230..cbd271e81d 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,568 +1,459 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal - -## RumGlobal interface - -**Signature:** - -```typescript -export interface RumPublicApi extends PublicApi -``` -**Extends:** PublicApi - -## Properties - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
addAction - - - - -(name: string, context?: object) => void - - - - -Add a custom action, stored in `@action` - - -
addDurationVital - - - - -(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void - - - - -Add a custom duration vital - - -
addError - - - - -(error: unknown, context?: object) => void - - - - -Add a custom error, stored in `@error`. - - -
addFeatureFlagEvaluation - - - - -(key: string, value: any) => void - - - - -Add a feature flag evaluation, stored in `@feature_flags.` - - -
addTiming - - - - -(name: string, time?: number) => void - - - - -Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` - - -
clearAccount - - - - -() => void - - - - -Clear all account information - - -
clearGlobalContext - - - - -() => void - - - - -Clear the global context - -See \Global context\ for further information. - - -
clearUser - - - - -() => void - - - - -Clear all user information - -See \User session\ for further information. - - -
getAccount - - - - -() => Context - - - - -Get account information - - -
getGlobalContext - - - - -() => Context - - - - -Get the global Context - -See \Global context\ for further information. - - -
getInitConfiguration - - - - -() => RumInitConfiguration \| undefined - - - - -Get the init configuration - - -
getInternalContext - - - - -(startTime?: number) => InternalContext \| undefined - - - - -\[Internal API\] Get the internal SDK context - - -
getSessionReplayLink - - - - -() => string \| undefined - - - - -Get the Session Replay Link. - -See \Connect Session Replay To Your Third-Party Tools\ for further information. - - -
getUser - - - - -() => Context - - - - -Get user information - -See \User session\ for further information. - - -
getViewContext - - - - -() => Context - - - - -Get View Context. - - -
init - - - - -(initConfiguration: RumInitConfiguration) => void - - - - -Init the RUM browser SDK. - - -
removeAccountProperty - - - - -(key: string) => void - - - - -Remove an account property - - -
removeGlobalContextProperty - - - - -(key: any) => void - - - - -Remove a global context property - -See \Global context\ for further information. - - -
removeUserProperty - - - - -(key: any) => void - - - - -Remove a user property - -See \User session\ for further information. - - -
setAccount - - - - -(newAccount: Account) => void - - - - -Set account information to all events, stored in `@account` - - -
setAccountProperty - - - - -(key: string, property: any) => void - - - - -Set or update the account property, stored in `@account.` - - -
setGlobalContext - - - - -(context: any) => void - - - - -Set the global context information to all events, stored in `@context` - - -
setGlobalContextProperty - - - - -(key: any, value: any) => void - - - - -Set or update a global context property, stored in `@context.` - - -
setTrackingConsent - - - - -(trackingConsent: TrackingConsent) => void - - - - -Set the tracking consent of the current user. - - -
setUserProperty - - - - -(key: any, property: any) => void - - - - -Set or update the user property, stored in `@usr.` - - -
setViewContext - - - - -(context: Context) => void - - - - -Set View Context. - -Enable to manually set the context of the current view. - - -
setViewContextProperty - - - - -(key: string, value: any) => void - - - - -Set View Context Property. - -Enable to manually set a property of the context of the current view. - - -
setViewName - - - - -(name: string) => void - - - - -Set View Name. - -Enable to manually change the name of the current view. - - -
startDurationVital - - - - -(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference - - - - -Start a custom duration vital. - -If you plan to have multiple durations for the same vital, you should use the reference returned by this method. - - -
startSessionReplayRecording - - - - -(options?: StartRecordingOptions) => void - - - - -Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` - -See \Browser Session Replay\ for further information. - - -
startView - - - - -{ (name?: string): void; (options: ViewOptions): void; } - - - - -Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. - - -
stopDurationVital - - - - -(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void - - - - -Stop a custom duration vital - - -
stopSession - - - - -() => void - - - - -Stop the session. A new session will start at the next user interaction with the page. - - -
stopSessionReplayRecording - - - - -() => void - - - - -Stop Session Replay recording. - -See \Browser Session Replay\ for further information. - - -
- -## Methods - - - - -
- -Method - - - - -Description - - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -See \User session\ for further information. - - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumGlobal + +## RumGlobal interface + +**Signature:** + +```typescript +export interface RumPublicApi extends PublicApi +``` + +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
addAction + + + +(name: string, context?: object) => void + + + +Add a custom action, stored in `@action` + +
addDurationVital + + + +(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void + + + +Add a custom duration vital + +
addError + + + +(error: unknown, context?: object) => void + + + +Add a custom error, stored in `@error`. + +
addFeatureFlagEvaluation + + + +(key: string, value: any) => void + + + +Add a feature flag evaluation, stored in `@feature_flags.` + +
addTiming + + + +(name: string, time?: number) => void + + + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + +
clearAccount + + + +() => void + + + +Clear all account information + +
clearGlobalContext + + + +() => void + + + +Clear the global context + +See \Global context\ for further information. + +
clearUser + + + +() => void + + + +Clear all user information + +See \User session\ for further information. + +
getAccount + + + +() => Context + + + +Get account information + +
getGlobalContext + + + +() => Context + + + +Get the global Context + +See \Global context\ for further information. + +
getInitConfiguration + + + +() => RumInitConfiguration \| undefined + + + +Get the init configuration + +
getInternalContext + + + +(startTime?: number) => InternalContext \| undefined + + + +\[Internal API\] Get the internal SDK context + +
getSessionReplayLink + + + +() => string \| undefined + + + +Get the Session Replay Link. + +See \Connect Session Replay To Your Third-Party Tools\ for further information. + +
getUser + + + +() => Context + + + +Get user information + +See \User session\ for further information. + +
getViewContext + + + +() => Context + + + +Get View Context. + +
init + + + +(initConfiguration: RumInitConfiguration) => void + + + +Init the RUM browser SDK. + +
removeAccountProperty + + + +(key: string) => void + + + +Remove an account property + +
removeGlobalContextProperty + + + +(key: any) => void + + + +Remove a global context property + +See \Global context\ for further information. + +
removeUserProperty + + + +(key: any) => void + + + +Remove a user property + +See \User session\ for further information. + +
setAccount + + + +(newAccount: Account) => void + + + +Set account information to all events, stored in `@account` + +
setAccountProperty + + + +(key: string, property: any) => void + + + +Set or update the account property, stored in `@account.` + +
setGlobalContext + + + +(context: any) => void + + + +Set the global context information to all events, stored in `@context` + +
setGlobalContextProperty + + + +(key: any, value: any) => void + + + +Set or update a global context property, stored in `@context.` + +
setTrackingConsent + + + +(trackingConsent: TrackingConsent) => void + + + +Set the tracking consent of the current user. + +
setUserProperty + + + +(key: any, property: any) => void + + + +Set or update the user property, stored in `@usr.` + +
setViewContext + + + +(context: Context) => void + + + +Set View Context. + +Enable to manually set the context of the current view. + +
setViewContextProperty + + + +(key: string, value: any) => void + + + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + +
setViewName + + + +(name: string) => void + + + +Set View Name. + +Enable to manually change the name of the current view. + +
startDurationVital + + + +(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference + + + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + +
startSessionReplayRecording + + + +(options?: StartRecordingOptions) => void + + + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \Browser Session Replay\ for further information. + +
startView + + + +{ (name?: string): void; (options: ViewOptions): void; } + + + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + +
stopDurationVital + + + +(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void + + + +Stop a custom duration vital + +
stopSession + + + +() => void + + + +Stop the session. A new session will start at the next user interaction with the page. + +
stopSessionReplayRecording + + + +() => void + + + +Stop Session Replay recording. + +See \Browser Session Replay\ for further information. + +
+ +## Methods + + + + +
+ +Method + + + +Description + +
setUser(newUser) + +Set user information to all events, stored in `@usr` + +See \User session\ for further information. + +
setUser(newUser) + +Set user information to all events, stored in `@usr` + +
diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index ede8941973..3229acdd52 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeAccountProperty - -## RumGlobal.removeAccountProperty property - -Remove an account property - -**Signature:** - -```typescript -removeAccountProperty: (key: string) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeAccountProperty + +## RumGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index 15a1226f56..ab0ba0fdf0 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty - -## RumGlobal.removeGlobalContextProperty property - -Remove a global context property - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -removeGlobalContextProperty: (key: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty + +## RumGlobal.removeGlobalContextProperty property + +Remove a global context property + +See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 1361077718..b0a63b22df 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeUserProperty - -## RumGlobal.removeUserProperty property - -Remove a user property - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -removeUserProperty: (key: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > removeUserProperty + +## RumGlobal.removeUserProperty property + +Remove a user property + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index c275a22cbd..9f8804585f 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccount - -## RumGlobal.setAccount property - -Set account information to all events, stored in `@account` - -**Signature:** - -```typescript -setAccount: (newAccount: Account) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccount + +## RumGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index fbdb0f49bb..a446b62b6e 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccountProperty - -## RumGlobal.setAccountProperty property - -Set or update the account property, stored in `@account.` - -**Signature:** - -```typescript -setAccountProperty: (key: string, property: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccountProperty + +## RumGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index d58f69ec60..857940d732 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContext - -## RumGlobal.setGlobalContext property - -Set the global context information to all events, stored in `@context` - -**Signature:** - -```typescript -setGlobalContext: (context: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContext + +## RumGlobal.setGlobalContext property + +Set the global context information to all events, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 90000fa818..ef95f594da 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContextProperty - -## RumGlobal.setGlobalContextProperty property - -Set or update a global context property, stored in `@context.` - -**Signature:** - -```typescript -setGlobalContextProperty: (key: any, value: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContextProperty + +## RumGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 92d915b2f9..9293309a45 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setTrackingConsent - -## RumGlobal.setTrackingConsent property - -Set the tracking consent of the current user. - -**Signature:** - -```typescript -setTrackingConsent: (trackingConsent: TrackingConsent) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setTrackingConsent + +## RumGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index f93ac6e3ff..2f179184c4 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,55 +1,48 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser - -## RumGlobal.setUser() method - -Set user information to all events, stored in `@usr` - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -setUser(newUser: User & { - id: string; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newUser - - - - -User & { id: string; } - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser + +## RumGlobal.setUser() method + +Set user information to all events, stored in `@usr` + +See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +newUser + + + +User & { id: string; } + + + +
+**Returns:** + +void diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index da7de92906..5e9e46f565 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,56 +1,48 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser - -## RumGlobal.setUser() method - -> Warning: This API is now obsolete. -> -> You must specify a user id -> - -Set user information to all events, stored in `@usr` - -**Signature:** - -```typescript -setUser(newUser: User): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newUser - - - - -User - - - - - -
-**Returns:** - -void - + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser + +## RumGlobal.setUser() method + +> Warning: This API is now obsolete. +> +> You must specify a user id + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + +Type + + + +Description + +
+ +newUser + + + +User + + + +
+**Returns:** + +void diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 704a73ee17..efde1da55e 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUserProperty - -## RumGlobal.setUserProperty property - -Set or update the user property, stored in `@usr.` - -**Signature:** - -```typescript -setUserProperty: (key: any, property: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setUserProperty + +## RumGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 923982f788..c17e26e89b 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContext - -## RumGlobal.setViewContext property - -Set View Context. - -Enable to manually set the context of the current view. - -**Signature:** - -```typescript -setViewContext: (context: Context) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContext + +## RumGlobal.setViewContext property + +Set View Context. + +Enable to manually set the context of the current view. + +**Signature:** + +```typescript +setViewContext: (context: Context) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 8d491e1e60..f4f92098a8 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContextProperty - -## RumGlobal.setViewContextProperty property - -Set View Context Property. - -Enable to manually set a property of the context of the current view. - -**Signature:** - -```typescript -setViewContextProperty: (key: string, value: any) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContextProperty + +## RumGlobal.setViewContextProperty property + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + +**Signature:** + +```typescript +setViewContextProperty: (key: string, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 510cf85d56..474e6daf54 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewName - -## RumGlobal.setViewName property - -Set View Name. - -Enable to manually change the name of the current view. - -**Signature:** - -```typescript -setViewName: (name: string) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewName + +## RumGlobal.setViewName property + +Set View Name. + +Enable to manually change the name of the current view. + +**Signature:** + +```typescript +setViewName: (name: string) => void; +``` diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 3a419e7460..bec276e558 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,18 +1,21 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startDurationVital - -## RumGlobal.startDurationVital property - -Start a custom duration vital. - -If you plan to have multiple durations for the same vital, you should use the reference returned by this method. - -**Signature:** - -```typescript -startDurationVital: (name: string, options?: { - context?: object; - description?: string; - }) => DurationVitalReference; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > startDurationVital + +## RumGlobal.startDurationVital property + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + +**Signature:** + +```typescript +startDurationVital: ( + name: string, + options?: { + context?: object + description?: string + } +) => DurationVitalReference +``` diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 9b3239910a..802836ee3f 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startSessionReplayRecording - -## RumGlobal.startSessionReplayRecording property - -Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` - -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. - -**Signature:** - -```typescript -startSessionReplayRecording: (options?: StartRecordingOptions) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > startSessionReplayRecording + +## RumGlobal.startSessionReplayRecording property + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + +**Signature:** + +```typescript +startSessionReplayRecording: (options?: StartRecordingOptions) => void; +``` diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index 9bd7d24010..eb481222a3 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startView - -## RumGlobal.startView property - -Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. - -**Signature:** - -```typescript -startView: { - (name?: string): void; - (options: ViewOptions): void; - }; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > startView + +## RumGlobal.startView property + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + +**Signature:** + +```typescript +startView: { + (name?: string): void; + (options: ViewOptions): void; + }; +``` diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 49d5ea2fc3..aab3c12292 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopDurationVital - -## RumGlobal.stopDurationVital property - -Stop a custom duration vital - -**Signature:** - -```typescript -stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { - context?: object; - description?: string; - }) => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopDurationVital + +## RumGlobal.stopDurationVital property + +Stop a custom duration vital + +**Signature:** + +```typescript +stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 62944fc62c..f22a562617 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSession - -## RumGlobal.stopSession property - -Stop the session. A new session will start at the next user interaction with the page. - -**Signature:** - -```typescript -stopSession: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSession + +## RumGlobal.stopSession property + +Stop the session. A new session will start at the next user interaction with the page. + +**Signature:** + +```typescript +stopSession: () => void; +``` diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index ec18b79ff3..5d14e735ed 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording - -## RumGlobal.stopSessionReplayRecording property - -Stop Session Replay recording. - -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. - -**Signature:** - -```typescript -stopSessionReplayRecording: () => void; -``` + + +[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording + +## RumGlobal.stopSessionReplayRecording property + +Stop Session Replay recording. + +See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. + +**Signature:** + +```typescript +stopSessionReplayRecording: () => void; +``` diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 54ec029494..c35eec5191 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute - -## RumInitConfiguration.actionNameAttribute property - -Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. - -**Signature:** - -```typescript -actionNameAttribute?: string | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute + +## RumInitConfiguration.actionNameAttribute property + +Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. + +**Signature:** + +```typescript +actionNameAttribute?: string | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 36aa62c2f3..2f6d5c496c 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls - -## RumInitConfiguration.allowedTracingUrls property - -A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -allowedTracingUrls?: Array | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls + +## RumInitConfiguration.allowedTracingUrls property + +A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +allowedTracingUrls?: Array | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index f498237dec..a0482ca528 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > applicationId - -## RumInitConfiguration.applicationId property - -The RUM application ID. - -**Signature:** - -```typescript -applicationId: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > applicationId + +## RumInitConfiguration.applicationId property + +The RUM application ID. + +**Signature:** + +```typescript +applicationId: string +``` diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index e0e159ae0a..8bc9714843 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > beforeSend - -## RumInitConfiguration.beforeSend property - -Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events - -See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. - -**Signature:** - -```typescript -beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > beforeSend + +## RumInitConfiguration.beforeSend property + +Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. + +**Signature:** + +```typescript +beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 28ae23a2c9..73e2f62b3c 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests - -## RumInitConfiguration.compressIntakeRequests property - -Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. - -**Signature:** - -```typescript -compressIntakeRequests?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests + +## RumInitConfiguration.compressIntakeRequests property + +Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + +**Signature:** + +```typescript +compressIntakeRequests?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index 5a487a9df2..2338fd1ac0 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel - -## RumInitConfiguration.defaultPrivacyLevel property - -Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. - -**Signature:** - -```typescript -defaultPrivacyLevel?: DefaultPrivacyLevel | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel + +## RumInitConfiguration.defaultPrivacyLevel property + +Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. + +**Signature:** + +```typescript +defaultPrivacyLevel?: DefaultPrivacyLevel | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 1f5c7db769..34188ab3b8 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName - -## RumInitConfiguration.enablePrivacyForActionName property - -Enables privacy control for action names. - -**Signature:** - -```typescript -enablePrivacyForActionName?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName + +## RumInitConfiguration.enablePrivacyForActionName property + +Enables privacy control for action names. + +**Signature:** + +```typescript +enablePrivacyForActionName?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index 96cb2c68af..21d7cbfebd 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls - -## RumInitConfiguration.excludedActivityUrls property - -A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. - -**Signature:** - -```typescript -excludedActivityUrls?: MatchOption[] | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls + +## RumInitConfiguration.excludedActivityUrls property + +A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. + +**Signature:** + +```typescript +excludedActivityUrls?: MatchOption[] | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 19ecda74c8..197992c6c9 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,375 +1,300 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration - -## RumInitConfiguration interface - -**Signature:** - -```typescript -export interface RumInitConfiguration extends InitConfiguration -``` -**Extends:** InitConfiguration - -## Properties - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
actionNameAttribute? - - - - -string \| undefined - - - - -_(Optional)_ Specify your own attribute to use to name actions. See \Declare a name for click actions\ for further information. - - -
allowedTracingUrls? - - - - -Array<MatchOption \| TracingOption> \| undefined - - - - -_(Optional)_ A list of request URLs used to inject tracing headers. See \Connect RUM and Traces\ for further information. - - -
applicationId - - - - -string - - - - -The RUM application ID. - - -
beforeSend? - - - - -((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined - - - - -_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events - -See \Enrich And Control Browser RUM Data With beforeSend\ for further information. - - -
compressIntakeRequests? - - - - -boolean \| undefined - - - - -_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \Content Security Policy guidelines\ for further information. - - -
defaultPrivacyLevel? - - - - -DefaultPrivacyLevel \| undefined - - - - -_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \Replay Privacy Options\ for further information. - - -
enablePrivacyForActionName? - - - - -boolean \| undefined - - - - -_(Optional)_ Enables privacy control for action names. - - -
excludedActivityUrls? - - - - -MatchOption\[\] \| undefined - - - - -_(Optional)_ A list of request origins ignored when computing the page activity. See \How page activity is calculated\ for further information. - - -
plugins? - - - - -RumPlugin\[\] \| undefined - - - - -_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. - - -
profilingSampleRate? - - - - -number \| undefined - - - - -_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 - - -
propagateTraceBaggage? - - - - -boolean \| undefined - - - - -_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false - - -
remoteConfigurationId? - - - - -string \| undefined - - - - -_(Optional)_ - - -
sessionReplaySampleRate? - - - - -number \| undefined - - - - -_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See \Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\ for further information. - - -
startSessionReplayRecordingManually? - - - - -boolean \| undefined - - - - -_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \Session Replay Usage\ for further information. - - -
subdomain? - - - - -string - - - - -_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \Connect Session Replay To Your Third-Party Tools\ for further information. - - -
traceContextInjection? - - - - -TraceContextInjection \| undefined - - - - -_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \Connect RUM and Traces\ for further information. - - -
traceSampleRate? - - - - -number \| undefined - - - - -_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \Connect RUM and Traces\ for further information. - - -
trackBfcacheViews? - - - - -boolean \| undefined - - - - -_(Optional)_ Enable the creation of dedicated views for pages restored from the Back-Forward cache. false - - -
trackFeatureFlagsForEvents? - - - - -FeatureFlagsForEvents\[\] - - - - -_(Optional)_ Enables collection of features flags in chosen events. - - -
trackLongTasks? - - - - -boolean \| undefined - - - - -_(Optional)_ Enables collection of long task events. true - - -
trackResources? - - - - -boolean \| undefined - - - - -_(Optional)_ Enables collection of resource events. true - - -
trackUserInteractions? - - - - -boolean \| undefined - - - - -_(Optional)_ Enables automatic collection of users actions. See \Tracking User Actions\ for further information. true - - -
trackViewsManually? - - - - -boolean \| undefined - - - - -_(Optional)_ Allows you to control RUM views creation. See \Override default RUM view names\ for further information. - - -
workerUrl? - - - - -string - - - - -_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \Content Security Policy guidelines\ for further information. - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration + +## RumInitConfiguration interface + +**Signature:** + +```typescript +export interface RumInitConfiguration extends InitConfiguration +``` + +**Extends:** InitConfiguration + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
actionNameAttribute? + + + +string \| undefined + + + +_(Optional)_ Specify your own attribute to use to name actions. See \Declare a name for click actions\ for further information. + +
allowedTracingUrls? + + + +Array<MatchOption \| TracingOption> \| undefined + + + +_(Optional)_ A list of request URLs used to inject tracing headers. See \Connect RUM and Traces\ for further information. + +
applicationId + + + +string + + + +The RUM application ID. + +
beforeSend? + + + +((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined + + + +_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See \Enrich And Control Browser RUM Data With beforeSend\ for further information. + +
compressIntakeRequests? + + + +boolean \| undefined + + + +_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \Content Security Policy guidelines\ for further information. + +
defaultPrivacyLevel? + + + +DefaultPrivacyLevel \| undefined + + + +_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \Replay Privacy Options\ for further information. + +
enablePrivacyForActionName? + + + +boolean \| undefined + + + +_(Optional)_ Enables privacy control for action names. + +
excludedActivityUrls? + + + +MatchOption\[\] \| undefined + + + +_(Optional)_ A list of request origins ignored when computing the page activity. See \How page activity is calculated\ for further information. + +
plugins? + + + +RumPlugin\[\] \| undefined + + + +_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + +
profilingSampleRate? + + + +number \| undefined + + + +_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + +
propagateTraceBaggage? + + + +boolean \| undefined + + + +_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false + +
remoteConfigurationId? + + + +string \| undefined + + + +_(Optional)_ + +
sessionReplaySampleRate? + + + +number \| undefined + + + +_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See \Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\ for further information. + +
startSessionReplayRecordingManually? + + + +boolean \| undefined + + + +_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \Session Replay Usage\ for further information. + +
subdomain? + + + +string + + + +_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \Connect Session Replay To Your Third-Party Tools\ for further information. + +
traceContextInjection? + + + +TraceContextInjection \| undefined + + + +_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \Connect RUM and Traces\ for further information. + +
traceSampleRate? + + + +number \| undefined + + + +_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \Connect RUM and Traces\ for further information. + +
trackBfcacheViews? + + + +boolean \| undefined + + + +_(Optional)_ Enable the creation of dedicated views for pages restored from the Back-Forward cache. false + +
trackFeatureFlagsForEvents? + + + +FeatureFlagsForEvents\[\] + + + +_(Optional)_ Enables collection of features flags in chosen events. + +
trackLongTasks? + + + +boolean \| undefined + + + +_(Optional)_ Enables collection of long task events. true + +
trackResources? + + + +boolean \| undefined + + + +_(Optional)_ Enables collection of resource events. true + +
trackUserInteractions? + + + +boolean \| undefined + + + +_(Optional)_ Enables automatic collection of users actions. See \Tracking User Actions\ for further information. true + +
trackViewsManually? + + + +boolean \| undefined + + + +_(Optional)_ Allows you to control RUM views creation. See \Override default RUM view names\ for further information. + +
workerUrl? + + + +string + + + +_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \Content Security Policy guidelines\ for further information. + +
diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 2253d6f184..0224d98ed2 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > plugins - -## RumInitConfiguration.plugins property - -List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. - -**Signature:** - -```typescript -plugins?: RumPlugin[] | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > plugins + +## RumInitConfiguration.plugins property + +List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + +**Signature:** + +```typescript +plugins?: RumPlugin[] | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index 1f19978c58..a426c6579a 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate - -## RumInitConfiguration.profilingSampleRate property - -Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 - -**Signature:** - -```typescript -profilingSampleRate?: number | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate + +## RumInitConfiguration.profilingSampleRate property + +Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + +**Signature:** + +```typescript +profilingSampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 7cc82ecc34..d6b6c3e1e9 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage - -## RumInitConfiguration.propagateTraceBaggage property - -Whether to propagate user and account IDs in the baggage header of trace requests. false - -**Signature:** - -```typescript -propagateTraceBaggage?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage + +## RumInitConfiguration.propagateTraceBaggage property + +Whether to propagate user and account IDs in the baggage header of trace requests. false + +**Signature:** + +```typescript +propagateTraceBaggage?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 97d7cddb26..d858d83c1b 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId - -## RumInitConfiguration.remoteConfigurationId property - -**Signature:** - -```typescript -remoteConfigurationId?: string | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId + +## RumInitConfiguration.remoteConfigurationId property + +**Signature:** + +```typescript +remoteConfigurationId?: string | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 6a4f4edc53..19b3e4a295 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate - -## RumInitConfiguration.sessionReplaySampleRate property - -The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. - -**Signature:** - -```typescript -sessionReplaySampleRate?: number | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate + +## RumInitConfiguration.sessionReplaySampleRate property + +The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. + +**Signature:** + +```typescript +sessionReplaySampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 93bf44fc5d..7e4bb90082 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually - -## RumInitConfiguration.startSessionReplayRecordingManually property - -If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. - -**Signature:** - -```typescript -startSessionReplayRecordingManually?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually + +## RumInitConfiguration.startSessionReplayRecordingManually property + +If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. + +**Signature:** + +```typescript +startSessionReplayRecordingManually?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 659827c89b..a3e5bb6b53 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > subdomain - -## RumInitConfiguration.subdomain property - -If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. - -**Signature:** - -```typescript -subdomain?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > subdomain + +## RumInitConfiguration.subdomain property + +If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + +**Signature:** + +```typescript +subdomain?: string; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 0c22ee50ba..71de054f74 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceContextInjection - -## RumInitConfiguration.traceContextInjection property - -If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -traceContextInjection?: TraceContextInjection | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceContextInjection + +## RumInitConfiguration.traceContextInjection property + +If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +traceContextInjection?: TraceContextInjection | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index 37a8e62da9..b1dc951b26 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceSampleRate - -## RumInitConfiguration.traceSampleRate property - -The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -traceSampleRate?: number | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceSampleRate + +## RumInitConfiguration.traceSampleRate property + +The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. + +**Signature:** + +```typescript +traceSampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md index 07de678d0b..a5996d142c 100644 --- a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md +++ b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackBfcacheViews - -## RumInitConfiguration.trackBfcacheViews property - -Enable the creation of dedicated views for pages restored from the Back-Forward cache. false - -**Signature:** - -```typescript -trackBfcacheViews?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackBfcacheViews + +## RumInitConfiguration.trackBfcacheViews property + +Enable the creation of dedicated views for pages restored from the Back-Forward cache. false + +**Signature:** + +```typescript +trackBfcacheViews?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index bc82b62c61..141af07344 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents - -## RumInitConfiguration.trackFeatureFlagsForEvents property - -Enables collection of features flags in chosen events. - -**Signature:** - -```typescript -trackFeatureFlagsForEvents?: FeatureFlagsForEvents[]; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents + +## RumInitConfiguration.trackFeatureFlagsForEvents property + +Enables collection of features flags in chosen events. + +**Signature:** + +```typescript +trackFeatureFlagsForEvents?: FeatureFlagsForEvents[]; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 5389a7636f..03427fbd78 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackLongTasks - -## RumInitConfiguration.trackLongTasks property - -Enables collection of long task events. true - -**Signature:** - -```typescript -trackLongTasks?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackLongTasks + +## RumInitConfiguration.trackLongTasks property + +Enables collection of long task events. true + +**Signature:** + +```typescript +trackLongTasks?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 64375858b2..e0c1083fd3 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackResources - -## RumInitConfiguration.trackResources property - -Enables collection of resource events. true - -**Signature:** - -```typescript -trackResources?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackResources + +## RumInitConfiguration.trackResources property + +Enables collection of resource events. true + +**Signature:** + +```typescript +trackResources?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index a3f53c0fbe..dccc0bddcb 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions - -## RumInitConfiguration.trackUserInteractions property - -Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true - -**Signature:** - -```typescript -trackUserInteractions?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions + +## RumInitConfiguration.trackUserInteractions property + +Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true + +**Signature:** + +```typescript +trackUserInteractions?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index f7873cb993..873ec22613 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackViewsManually - -## RumInitConfiguration.trackViewsManually property - -Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. - -**Signature:** - -```typescript -trackViewsManually?: boolean | undefined; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackViewsManually + +## RumInitConfiguration.trackViewsManually property + +Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. + +**Signature:** + +```typescript +trackViewsManually?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index 06d70ff96a..57d2fb24c5 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > workerUrl - -## RumInitConfiguration.workerUrl property - -URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. - -**Signature:** - -```typescript -workerUrl?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > workerUrl + +## RumInitConfiguration.workerUrl property + +URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. + +**Signature:** + +```typescript +workerUrl?: string; +``` diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index d4720343ad..8ec48e81e6 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,48 +1,56 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEvent - -## RumLongTaskEvent type - -Schema of all properties of a Long Task event - -**Signature:** - -```typescript -export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'long_task'; - readonly long_task: { - readonly id?: string; - readonly start_time?: number; - readonly entry_type?: 'long-task' | 'long-animation-frame'; - readonly duration: number; - readonly blocking_duration?: number; - readonly render_start?: number; - readonly style_and_layout_start?: number; - readonly first_ui_event_timestamp?: number; - readonly is_frozen_frame?: boolean; - readonly scripts?: { - readonly duration?: number; - readonly pause_duration?: number; - readonly forced_style_and_layout_duration?: number; - readonly start_time?: number; - readonly execution_start?: number; - source_url?: string; - readonly source_function_name?: string; - readonly source_char_position?: number; - invoker?: string; - readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; - readonly window_attribution?: string; - [k: string]: unknown; - }[]; - [k: string]: unknown; - }; - readonly _dd?: { - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumLongTaskEvent + +## RumLongTaskEvent type + +Schema of all properties of a Long Task event + +**Signature:** + +```typescript +export type RumLongTaskEvent = CommonProperties & + ActionChildProperties & + ViewContainerSchema & { + readonly type: 'long_task' + readonly long_task: { + readonly id?: string + readonly start_time?: number + readonly entry_type?: 'long-task' | 'long-animation-frame' + readonly duration: number + readonly blocking_duration?: number + readonly render_start?: number + readonly style_and_layout_start?: number + readonly first_ui_event_timestamp?: number + readonly is_frozen_frame?: boolean + readonly scripts?: { + readonly duration?: number + readonly pause_duration?: number + readonly forced_style_and_layout_duration?: number + readonly start_time?: number + readonly execution_start?: number + source_url?: string + readonly source_function_name?: string + readonly source_char_position?: number + invoker?: string + readonly invoker_type?: + | 'user-callback' + | 'event-listener' + | 'resolve-promise' + | 'reject-promise' + | 'classic-script' + | 'module-script' + readonly window_attribution?: string + [k: string]: unknown + }[] + [k: string]: unknown + } + readonly _dd?: { + readonly discarded?: boolean + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 561717d766..c71b171430 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,48 +1,41 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext - -## RumLongTaskEventDomainContext interface - -**Signature:** - -```typescript -export interface RumLongTaskEventDomainContext -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
performanceEntry - - - - -PerformanceEntry - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext + +## RumLongTaskEventDomainContext interface + +**Signature:** + +```typescript +export interface RumLongTaskEventDomainContext +``` + +## Properties + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
performanceEntry + + + +PerformanceEntry + + + +
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index cf988cfda0..9f956a4d5f 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry - -## RumLongTaskEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry; -``` + + +[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry + +## RumLongTaskEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry +``` diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 5e5415ce86..ad64f7eeee 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,48 +1,41 @@ - - -[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext - -## RumOtherResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumOtherResourceEventDomainContext -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
performanceEntry - - - - -PerformanceEntry - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext + +## RumOtherResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumOtherResourceEventDomainContext +``` + +## Properties + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
performanceEntry + + + +PerformanceEntry + + + +
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 4b5e81d288..ef8646f396 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry - -## RumOtherResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry; -``` + + +[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry + +## RumOtherResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry +``` diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index da8f29e8ac..5ee6548e2f 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,89 +1,116 @@ - - -[Home](index.html) > @datadog/browser-rum > RumResourceEvent - -## RumResourceEvent type - -Schema of all properties of a Resource event - -**Signature:** - -```typescript -export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'resource'; - readonly resource: { - readonly id?: string; - readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; - readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - url: string; - readonly status_code?: number; - readonly duration?: number; - readonly size?: number; - readonly encoded_body_size?: number; - readonly decoded_body_size?: number; - readonly transfer_size?: number; - readonly render_blocking_status?: 'blocking' | 'non-blocking'; - readonly worker?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly redirect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly dns?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly connect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly ssl?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly first_byte?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly download?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly protocol?: string; - readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - readonly graphql?: { - readonly operationType: 'query' | 'mutation' | 'subscription'; - readonly operationName?: string; - payload?: string; - variables?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly span_id?: string; - readonly trace_id?: string; - readonly rule_psr?: number; - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumResourceEvent + +## RumResourceEvent type + +Schema of all properties of a Resource event + +**Signature:** + +```typescript +export type RumResourceEvent = CommonProperties & + ActionChildProperties & + ViewContainerSchema & { + readonly type: 'resource' + readonly resource: { + readonly id?: string + readonly type: + | 'document' + | 'xhr' + | 'beacon' + | 'fetch' + | 'css' + | 'js' + | 'image' + | 'font' + | 'media' + | 'other' + | 'native' + readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT' + url: string + readonly status_code?: number + readonly duration?: number + readonly size?: number + readonly encoded_body_size?: number + readonly decoded_body_size?: number + readonly transfer_size?: number + readonly render_blocking_status?: 'blocking' | 'non-blocking' + readonly worker?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly redirect?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly dns?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly connect?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly ssl?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly first_byte?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly download?: { + readonly duration: number + readonly start: number + [k: string]: unknown + } + readonly protocol?: string + readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other' + readonly provider?: { + readonly domain?: string + readonly name?: string + readonly type?: + | 'ad' + | 'advertising' + | 'analytics' + | 'cdn' + | 'content' + | 'customer-success' + | 'first party' + | 'hosting' + | 'marketing' + | 'other' + | 'social' + | 'tag-manager' + | 'utility' + | 'video' + [k: string]: unknown + } + readonly graphql?: { + readonly operationType: 'query' | 'mutation' | 'subscription' + readonly operationName?: string + payload?: string + variables?: string + [k: string]: unknown + } + [k: string]: unknown + } + readonly _dd?: { + readonly span_id?: string + readonly trace_id?: string + readonly rule_psr?: number + readonly discarded?: boolean + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 14bb5f0929..4b4fad8835 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,143 +1,152 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEvent - -## RumViewEvent type - -Schema of all properties of a View event - -**Signature:** - -```typescript -export type RumViewEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'view'; - readonly view: { - readonly loading_time?: number; - readonly network_settled_time?: number; - readonly interaction_to_next_view_time?: number; - readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; - readonly time_spent: number; - readonly first_contentful_paint?: number; - readonly largest_contentful_paint?: number; - readonly largest_contentful_paint_target_selector?: string; - readonly first_input_delay?: number; - readonly first_input_time?: number; - readonly first_input_target_selector?: string; - readonly interaction_to_next_paint?: number; - readonly interaction_to_next_paint_time?: number; - readonly interaction_to_next_paint_target_selector?: string; - readonly cumulative_layout_shift?: number; - readonly cumulative_layout_shift_time?: number; - readonly cumulative_layout_shift_target_selector?: string; - readonly dom_complete?: number; - readonly dom_content_loaded?: number; - readonly dom_interactive?: number; - readonly load_event?: number; - readonly first_byte?: number; - readonly custom_timings?: { - [k: string]: number; - }; - readonly is_active?: boolean; - readonly is_slow_rendered?: boolean; - readonly action: { - readonly count: number; - [k: string]: unknown; - }; - readonly error: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly frozen_frame?: { - readonly count: number; - [k: string]: unknown; - }; - readonly slow_frames?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly resource: { - readonly count: number; - [k: string]: unknown; - }; - readonly frustration?: { - readonly count: number; - [k: string]: unknown; - }; - readonly in_foreground_periods?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly memory_average?: number; - readonly memory_max?: number; - readonly cpu_ticks_count?: number; - readonly cpu_ticks_per_second?: number; - readonly refresh_rate_average?: number; - readonly refresh_rate_min?: number; - readonly slow_frames_rate?: number; - readonly freeze_rate?: number; - flutter_build_time?: RumPerfMetric; - flutter_raster_time?: RumPerfMetric; - js_refresh_rate?: RumPerfMetric; - performance?: ViewPerformanceData; - [k: string]: unknown; - }; - readonly session?: { - readonly is_active?: boolean; - readonly sampled_for_replay?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - readonly privacy?: { - readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; - [k: string]: unknown; - }; - readonly _dd: { - readonly document_version: number; - readonly page_states?: { - readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; - readonly start: number; - [k: string]: unknown; - }[]; - replay_stats?: { - records_count?: number; - segments_count?: number; - segments_total_raw_size?: number; - [k: string]: unknown; - }; - readonly cls?: { - readonly device_pixel_ratio?: number; - [k: string]: unknown; - }; - readonly configuration?: { - readonly start_session_replay_recording_manually?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly display?: { - readonly scroll?: { - readonly max_depth: number; - readonly max_depth_scroll_top: number; - readonly max_scroll_height: number; - readonly max_scroll_height_time: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumViewEvent + +## RumViewEvent type + +Schema of all properties of a View event + +**Signature:** + +```typescript +export type RumViewEvent = CommonProperties & + ViewContainerSchema & { + readonly type: 'view' + readonly view: { + readonly loading_time?: number + readonly network_settled_time?: number + readonly interaction_to_next_view_time?: number + readonly loading_type?: + | 'initial_load' + | 'route_change' + | 'activity_display' + | 'activity_redisplay' + | 'fragment_display' + | 'fragment_redisplay' + | 'view_controller_display' + | 'view_controller_redisplay' + readonly time_spent: number + readonly first_contentful_paint?: number + readonly largest_contentful_paint?: number + readonly largest_contentful_paint_target_selector?: string + readonly first_input_delay?: number + readonly first_input_time?: number + readonly first_input_target_selector?: string + readonly interaction_to_next_paint?: number + readonly interaction_to_next_paint_time?: number + readonly interaction_to_next_paint_target_selector?: string + readonly cumulative_layout_shift?: number + readonly cumulative_layout_shift_time?: number + readonly cumulative_layout_shift_target_selector?: string + readonly dom_complete?: number + readonly dom_content_loaded?: number + readonly dom_interactive?: number + readonly load_event?: number + readonly first_byte?: number + readonly custom_timings?: { + [k: string]: number + } + readonly is_active?: boolean + readonly is_slow_rendered?: boolean + readonly action: { + readonly count: number + [k: string]: unknown + } + readonly error: { + readonly count: number + [k: string]: unknown + } + readonly crash?: { + readonly count: number + [k: string]: unknown + } + readonly long_task?: { + readonly count: number + [k: string]: unknown + } + readonly frozen_frame?: { + readonly count: number + [k: string]: unknown + } + readonly slow_frames?: { + readonly start: number + readonly duration: number + [k: string]: unknown + }[] + readonly resource: { + readonly count: number + [k: string]: unknown + } + readonly frustration?: { + readonly count: number + [k: string]: unknown + } + readonly in_foreground_periods?: { + readonly start: number + readonly duration: number + [k: string]: unknown + }[] + readonly memory_average?: number + readonly memory_max?: number + readonly cpu_ticks_count?: number + readonly cpu_ticks_per_second?: number + readonly refresh_rate_average?: number + readonly refresh_rate_min?: number + readonly slow_frames_rate?: number + readonly freeze_rate?: number + flutter_build_time?: RumPerfMetric + flutter_raster_time?: RumPerfMetric + js_refresh_rate?: RumPerfMetric + performance?: ViewPerformanceData + [k: string]: unknown + } + readonly session?: { + readonly is_active?: boolean + readonly sampled_for_replay?: boolean + [k: string]: unknown + } + readonly feature_flags?: { + [k: string]: unknown + } + readonly privacy?: { + readonly replay_level: 'allow' | 'mask' | 'mask-user-input' + [k: string]: unknown + } + readonly _dd: { + readonly document_version: number + readonly page_states?: { + readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated' + readonly start: number + [k: string]: unknown + }[] + replay_stats?: { + records_count?: number + segments_count?: number + segments_total_raw_size?: number + [k: string]: unknown + } + readonly cls?: { + readonly device_pixel_ratio?: number + [k: string]: unknown + } + readonly configuration?: { + readonly start_session_replay_recording_manually?: boolean + [k: string]: unknown + } + [k: string]: unknown + } + readonly display?: { + readonly scroll?: { + readonly max_depth: number + readonly max_depth_scroll_top: number + readonly max_scroll_height: number + readonly max_scroll_height_time: number + [k: string]: unknown + } + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 0a299087a6..661aeef2a7 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext > location - -## RumViewEventDomainContext.location property - -**Signature:** - -```typescript -location: Readonly; -``` + + +[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext > location + +## RumViewEventDomainContext.location property + +**Signature:** + +```typescript +location: Readonly +``` diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index ae2b2ac0b9..f7264adf5f 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,48 +1,41 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext - -## RumViewEventDomainContext interface - -**Signature:** - -```typescript -export interface RumViewEventDomainContext -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
location - - - - -Readonly<Location> - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext + +## RumViewEventDomainContext interface + +**Signature:** + +```typescript +export interface RumViewEventDomainContext +``` + +## Properties + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
location + + + +Readonly<Location> + + + +
diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 509c35669e..d8b0ded056 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,36 +1,37 @@ - - -[Home](index.html) > @datadog/browser-rum > RumVitalEvent - -## RumVitalEvent type - -Schema of all properties of a Vital event - -**Signature:** - -```typescript -export type RumVitalEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'vital'; - readonly vital: { - readonly type: 'duration'; - readonly id: string; - readonly name?: string; - readonly description?: string; - readonly duration?: number; - readonly custom?: { - [k: string]: number; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly vital?: { - readonly computed_value?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; -}; -``` -**References:** [CommonProperties](./browser-rum.commonproperties.md) - + + +[Home](index.html) > @datadog/browser-rum > RumVitalEvent + +## RumVitalEvent type + +Schema of all properties of a Vital event + +**Signature:** + +```typescript +export type RumVitalEvent = CommonProperties & + ViewContainerSchema & { + readonly type: 'vital' + readonly vital: { + readonly type: 'duration' + readonly id: string + readonly name?: string + readonly description?: string + readonly duration?: number + readonly custom?: { + [k: string]: number + } + [k: string]: unknown + } + readonly _dd?: { + readonly vital?: { + readonly computed_value?: boolean + [k: string]: unknown + } + [k: string]: unknown + } + [k: string]: unknown + } +``` + +**References:** [CommonProperties](./browser-rum.commonproperties.md) diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 9a2e017726..691593bbf8 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack - -## RumXhrResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack + +## RumXhrResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 8a340f8fdc..28fc7c27f7 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted - -## RumXhrResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean; -``` + + +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted + +## RumXhrResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 0077ebaeb3..0242997241 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,88 +1,72 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext - -## RumXhrResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumXhrResourceEventDomainContext -``` - -## Properties - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
handlingStack? - - - - -string - - - - -_(Optional)_ - - -
isAborted - - - - -boolean - - - - - -
performanceEntry? - - - - -PerformanceEntry - - - - -_(Optional)_ - - -
xhr - - - - -XMLHttpRequest - - - - - -
+ + +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext + +## RumXhrResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumXhrResourceEventDomainContext +``` + +## Properties + + + + + + +
+ +Property + + + +Modifiers + + + +Type + + + +Description + +
handlingStack? + + + +string + + + +_(Optional)_ + +
isAborted + + + +boolean + + + +
performanceEntry? + + + +PerformanceEntry + + + +_(Optional)_ + +
xhr + + + +XMLHttpRequest + + + +
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 5d5035b4f5..44258dd111 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry - -## RumXhrResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` + + +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry + +## RumXhrResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 868bd506bd..adaa4ba492 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr - -## RumXhrResourceEventDomainContext.xhr property - -**Signature:** - -```typescript -xhr: XMLHttpRequest; -``` + + +[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr + +## RumXhrResourceEventDomainContext.xhr property + +**Signature:** + +```typescript +xhr: XMLHttpRequest +``` diff --git a/docs/index.md b/docs/index.md index 96cc580467..b2603ded60 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,30 +1,30 @@ - - -[Home](index.html) - -## API Reference - -## Packages - - - - - - -
- -Package - - - -Description - -
@datadog/browser-logs - -
@datadog/browser-rum - -
@datadog/browser-rum-react - -
@datadog/browser-rum-slim - -
+ + +[Home](index.html) + +## API Reference + +## Packages + + + + + + +
+ +Package + + + +Description + +
@datadog/browser-logs + +
@datadog/browser-rum + +
@datadog/browser-rum-react + +
@datadog/browser-rum-slim + +
diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json index d7dec6a2d3..ff1321a4d4 100644 --- a/etc/browser-logs.api.json +++ b/etc/browser-logs.api.json @@ -1,3521 +1,3521 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-logs!", - "docComment": "", - "name": "@datadog/browser-logs", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-logs!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!datadogLogs:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogLogs: " - }, - { - "kind": "Reference", - "text": "LogsPublicApi", - "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface" - } - ], - "fileUrlPath": "packages/logs/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogLogs", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!HandlerType:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type HandlerType = " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:var" - }, - { - "kind": "Content", - "text": ")[keyof typeof " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:var" - }, - { - "kind": "Content", - "text": "]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "HandlerType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!HandlerType:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "HandlerType: " - }, - { - "kind": "Content", - "text": "{\n readonly console: \"console\";\n readonly http: \"http\";\n readonly silent: \"silent\";\n}" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "HandlerType", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "@datadog/browser-logs!Logger:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Logger " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "Logger", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@datadog/browser-logs!Logger:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Logger` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(handleLogStrategy: " - }, - { - "kind": "Content", - "text": "(logsMessage: " - }, - { - "kind": "Reference", - "text": "LogsMessage", - "canonicalReference": "@datadog/browser-logs!LogsMessage:interface" - }, - { - "kind": "Content", - "text": ", logger: " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ", handlingStack?: string) => void" - }, - { - "kind": "Content", - "text": ", name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", handlerType?: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ", level?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", loggerContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handleLogStrategy", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "handlerType", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "isOptional": true - }, - { - "parameterName": "level", - "parameterTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 - }, - "isOptional": true - }, - { - "parameterName": "loggerContext", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ] - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#clearContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearContext(): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "clearContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getContext(): " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getHandler:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getHandler(): " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getHandler" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getLevel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLevel(): " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getLevel" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#log:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "log(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", status?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "status", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "log" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#logImplementation:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "logImplementation(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", status?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "status", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "handlingStack", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "logImplementation" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#removeContextProperty:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeContextProperty(key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "removeContextProperty" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setContext(context: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setContextProperty:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setContextProperty(key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", value: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "value", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setContextProperty" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setHandler:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setHandler(handler: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setHandler" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setLevel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setLevel(level: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "level", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setLevel" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!Logger:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Logger " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "Logger", - "preserveMemberOrder": false, - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "alert(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "alert" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "critical(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "critical" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "debug(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "debug" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "emerg(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "emerg" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "error" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "info(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "info" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "notice(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "notice" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ok(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "ok" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "warn(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "warn" - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LoggerConfiguration " - } - ], - "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", - "releaseTag": "Public", - "name": "LoggerConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#handler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handler?: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#level:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "level?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "level", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsEvent " - } - ], - "fileUrlPath": "packages/logs/esm/logsEvent.types.d.ts", - "releaseTag": "Public", - "name": "LogsEvent", - "preserveMemberOrder": false, - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#application_id:member", - "docComment": "/**\n * UUID of the application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "application_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "application_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#date:member", - "docComment": "/**\n * Start of the log in ms from epoch\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "date: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#error:member", - "docComment": "/**\n * Error properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "error?: " - }, - { - "kind": "Content", - "text": "{\n kind?: string;\n stack?: string;\n fingerprint?: string;\n message?: string;\n causes?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<{\n message: string;\n source: string;\n type?: string;\n stack?: string;\n }>;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#http:member", - "docComment": "/**\n * Resource properties of the error\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "http?: " - }, - { - "kind": "Content", - "text": "{\n method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH';\n status_code: number;\n url: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "http", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#logger:member", - "docComment": "/**\n * Logger properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "logger?: " - }, - { - "kind": "Content", - "text": "{\n name: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "logger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#message:member", - "docComment": "/**\n * The log message\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#origin:member", - "docComment": "/**\n * Origin of the log\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "origin: " - }, - { - "kind": "Content", - "text": "'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "origin", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#service:member", - "docComment": "/**\n * The service name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#session_id:member", - "docComment": "/**\n * UUID of the session (deprecated in favor of session.id)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "session_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "session_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#session:member", - "docComment": "/**\n * Session properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "session?: " - }, - { - "kind": "Content", - "text": "{\n id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "session", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#status:member", - "docComment": "/**\n * The log status\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "status: " - }, - { - "kind": "Content", - "text": "'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "status", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#view:member", - "docComment": "/**\n * View properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "view: " - }, - { - "kind": "Content", - "text": "{\n referrer?: string;\n url: string;\n id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type LogsEventDomainContext = " - }, - { - "kind": "Content", - "text": "T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.NETWORK", - "canonicalReference": "@datadog/browser-core!__type#NETWORK:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "NetworkLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~NetworkLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.CONSOLE", - "canonicalReference": "@datadog/browser-core!__type#CONSOLE:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "ConsoleLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~ConsoleLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.LOGGER", - "canonicalReference": "@datadog/browser-core!__type#LOGGER:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "LoggerLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~LoggerLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : never" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "LogsEventDomainContext", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 18 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsPublicApi extends " - }, - { - "kind": "Reference", - "text": "PublicApi", - "canonicalReference": "@datadog/browser-core!PublicApi:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", - "releaseTag": "Public", - "name": "LogsGlobal", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearAccount:member", - "docComment": "/**\n * Clear all account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearAccount: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearGlobalContext:member", - "docComment": "/**\n * Clear the global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearGlobalContext: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearUser:member", - "docComment": "/**\n * Clear all user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearUser: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#createLogger:member", - "docComment": "/**\n * The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones.\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "createLogger: " - }, - { - "kind": "Content", - "text": "(name: string, conf?: " - }, - { - "kind": "Reference", - "text": "LoggerConfiguration", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "createLogger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getAccount:member", - "docComment": "/**\n * Get account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAccount: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getGlobalContext:member", - "docComment": "/**\n * Get the global Context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getGlobalContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInitConfiguration:member", - "docComment": "/**\n * Get the init configuration\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInitConfiguration: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "LogsInitConfiguration", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInitConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInternalContext:member", - "docComment": "/**\n * [Internal API] Get the internal SDK context\n *\n * See [Access internal context](https://docs.datadoghq.com/logs/log_collection/javascript/#access-internal-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Content", - "text": "(startTime?: number) => " - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-logs!~InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getLogger:member", - "docComment": "/**\n * Get a logger\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLogger: " - }, - { - "kind": "Content", - "text": "(name: string) => " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getLogger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getUser:member", - "docComment": "/**\n * Get user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getUser: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#init:member", - "docComment": "/**\n * Init the Logs browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [Browser Log Collection](https://docs.datadoghq.com/logs/log_collection/javascript) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "LogsInitConfiguration", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#logger:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "logger: " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "logger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeAccountProperty:member", - "docComment": "/**\n * Remove an account property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeGlobalContextProperty:member", - "docComment": "/**\n * Remove a global context property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeUserProperty:member", - "docComment": "/**\n * Remove a user property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccount:member", - "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccount: " - }, - { - "kind": "Content", - "text": "(newAccount: " - }, - { - "kind": "Reference", - "text": "Account", - "canonicalReference": "@datadog/browser-core!Account:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccountProperty:member", - "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContext:member", - "docComment": "/**\n * Set the global context information to all logs, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContext: " - }, - { - "kind": "Content", - "text": "(context: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContextProperty:member", - "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setTrackingConsent:member", - "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Logs will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTrackingConsent: " - }, - { - "kind": "Content", - "text": "(trackingConsent: " - }, - { - "kind": "Reference", - "text": "TrackingConsent", - "canonicalReference": "@datadog/browser-core!TrackingConsent:type" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setTrackingConsent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(1)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": " & {\n id: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(2)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specified a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUserProperty:member", - "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsInitConfiguration extends " - }, - { - "kind": "Reference", - "text": "InitConfiguration", - "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/logs/esm/domain/configuration.d.ts", - "releaseTag": "Public", - "name": "LogsInitConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#beforeSend:member", - "docComment": "/**\n * Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "beforeSend?: " - }, - { - "kind": "Content", - "text": "((event: " - }, - { - "kind": "Reference", - "text": "LogsEvent", - "canonicalReference": "@datadog/browser-logs!LogsEvent:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "LogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": ") => boolean) | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "beforeSend", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardConsoleLogs:member", - "docComment": "/**\n * Forward logs from console.* to Datadog. Use \"all\" to forward everything or an array of console API names to forward only a subset.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardConsoleLogs?: " - }, - { - "kind": "Reference", - "text": "ConsoleApiName", - "canonicalReference": "@datadog/browser-core!ConsoleApiName:type" - }, - { - "kind": "Content", - "text": "[] | 'all' | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardConsoleLogs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardErrorsToLogs:member", - "docComment": "/**\n * Forward console.error logs, uncaught exceptions and network errors to Datadog. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardErrorsToLogs?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardErrorsToLogs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardReports:member", - "docComment": "/**\n * Forward reports from the [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) to Datadog. Use \"all\" to forward everything or an array of report types to forward only a subset.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardReports?: " - }, - { - "kind": "Reference", - "text": "RawReportType", - "canonicalReference": "@datadog/browser-core!RawReportType:type" - }, - { - "kind": "Content", - "text": "[] | 'all' | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardReports", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#usePciIntake:member", - "docComment": "/**\n * Use PCI-compliant intake. See [PCI DSS Compliance](https://docs.datadoghq.com/data_security/pci_compliance/?tab=logmanagement) for further information. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "usePciIntake?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "usePciIntake", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsMessage " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "LogsMessage", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "status: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "status", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!StatusType:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type StatusType = " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:var" - }, - { - "kind": "Content", - "text": ")[keyof typeof " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:var" - }, - { - "kind": "Content", - "text": "]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", - "releaseTag": "Public", - "name": "StatusType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!StatusType:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "StatusType: " - }, - { - "kind": "Content", - "text": "{\n readonly ok: \"ok\";\n readonly debug: \"debug\";\n readonly info: \"info\";\n readonly notice: \"notice\";\n readonly warn: \"warn\";\n readonly error: \"error\";\n readonly critical: \"critical\";\n readonly alert: \"alert\";\n readonly emerg: \"emerg\";\n}" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "StatusType", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-logs!", + "docComment": "", + "name": "@datadog/browser-logs", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-logs!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!datadogLogs:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogLogs: " + }, + { + "kind": "Reference", + "text": "LogsPublicApi", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface" + } + ], + "fileUrlPath": "packages/logs/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogLogs", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!HandlerType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type HandlerType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "HandlerType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!HandlerType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "HandlerType: " + }, + { + "kind": "Content", + "text": "{\n readonly console: \"console\";\n readonly http: \"http\";\n readonly silent: \"silent\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "HandlerType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-logs!Logger:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-logs!Logger:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Logger` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(handleLogStrategy: " + }, + { + "kind": "Content", + "text": "(logsMessage: " + }, + { + "kind": "Reference", + "text": "LogsMessage", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface" + }, + { + "kind": "Content", + "text": ", logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ", handlingStack?: string) => void" + }, + { + "kind": "Content", + "text": ", name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", handlerType?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ", level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", loggerContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handleLogStrategy", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlerType", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "isOptional": true + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "isOptional": true + }, + { + "parameterName": "loggerContext", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#clearContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearContext(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "clearContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContext(): " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHandler(): " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLevel(): " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getLevel" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#log:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "log(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "log" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#logImplementation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logImplementation(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlingStack", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "logImplementation" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#removeContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "removeContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContext(context: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", value: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setHandler(handler: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setLevel(level: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setLevel" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!Logger:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "alert(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "alert" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "critical(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "critical" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "debug(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "debug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "emerg(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "emerg" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "error" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "info(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "info" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "notice(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "notice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ok(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "ok" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "warn(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "warn" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LoggerConfiguration " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LoggerConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#handler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handler?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#level:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsEvent " + } + ], + "fileUrlPath": "packages/logs/esm/logsEvent.types.d.ts", + "releaseTag": "Public", + "name": "LogsEvent", + "preserveMemberOrder": false, + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#application_id:member", + "docComment": "/**\n * UUID of the application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "application_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "application_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#date:member", + "docComment": "/**\n * Start of the log in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#error:member", + "docComment": "/**\n * Error properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Content", + "text": "{\n kind?: string;\n stack?: string;\n fingerprint?: string;\n message?: string;\n causes?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<{\n message: string;\n source: string;\n type?: string;\n stack?: string;\n }>;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#http:member", + "docComment": "/**\n * Resource properties of the error\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "http?: " + }, + { + "kind": "Content", + "text": "{\n method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH';\n status_code: number;\n url: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "http", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#logger:member", + "docComment": "/**\n * Logger properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger?: " + }, + { + "kind": "Content", + "text": "{\n name: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#message:member", + "docComment": "/**\n * The log message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#origin:member", + "docComment": "/**\n * Origin of the log\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "origin: " + }, + { + "kind": "Content", + "text": "'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "origin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#service:member", + "docComment": "/**\n * The service name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session_id:member", + "docComment": "/**\n * UUID of the session (deprecated in favor of session.id)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session?: " + }, + { + "kind": "Content", + "text": "{\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#status:member", + "docComment": "/**\n * The log status\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Content", + "text": "'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "view: " + }, + { + "kind": "Content", + "text": "{\n referrer?: string;\n url: string;\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type LogsEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.NETWORK", + "canonicalReference": "@datadog/browser-core!__type#NETWORK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "NetworkLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~NetworkLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.CONSOLE", + "canonicalReference": "@datadog/browser-core!__type#CONSOLE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "ConsoleLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~ConsoleLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.LOGGER", + "canonicalReference": "@datadog/browser-core!__type#LOGGER:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "LoggerLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~LoggerLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "LogsEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 18 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LogsGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#createLogger:member", + "docComment": "/**\n * The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones.\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createLogger: " + }, + { + "kind": "Content", + "text": "(name: string, conf?: " + }, + { + "kind": "Reference", + "text": "LoggerConfiguration", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "createLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n *\n * See [Access internal context](https://docs.datadoghq.com/logs/log_collection/javascript/#access-internal-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-logs!~InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getLogger:member", + "docComment": "/**\n * Get a logger\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLogger: " + }, + { + "kind": "Content", + "text": "(name: string) => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#init:member", + "docComment": "/**\n * Init the Logs browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [Browser Log Collection](https://docs.datadoghq.com/logs/log_collection/javascript) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#logger:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all logs, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Logs will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specified a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/domain/configuration.d.ts", + "releaseTag": "Public", + "name": "LogsInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "LogsEvent", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "LogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardConsoleLogs:member", + "docComment": "/**\n * Forward logs from console.* to Datadog. Use \"all\" to forward everything or an array of console API names to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardConsoleLogs?: " + }, + { + "kind": "Reference", + "text": "ConsoleApiName", + "canonicalReference": "@datadog/browser-core!ConsoleApiName:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardConsoleLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardErrorsToLogs:member", + "docComment": "/**\n * Forward console.error logs, uncaught exceptions and network errors to Datadog. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardErrorsToLogs?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardErrorsToLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardReports:member", + "docComment": "/**\n * Forward reports from the [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) to Datadog. Use \"all\" to forward everything or an array of report types to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardReports?: " + }, + { + "kind": "Reference", + "text": "RawReportType", + "canonicalReference": "@datadog/browser-core!RawReportType:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardReports", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#usePciIntake:member", + "docComment": "/**\n * Use PCI-compliant intake. See [PCI DSS Compliance](https://docs.datadoghq.com/data_security/pci_compliance/?tab=logmanagement) for further information. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "usePciIntake?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "usePciIntake", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsMessage " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "LogsMessage", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!StatusType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type StatusType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "releaseTag": "Public", + "name": "StatusType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!StatusType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "StatusType: " + }, + { + "kind": "Content", + "text": "{\n readonly ok: \"ok\";\n readonly debug: \"debug\";\n readonly info: \"info\";\n readonly notice: \"notice\";\n readonly warn: \"warn\";\n readonly error: \"error\";\n readonly critical: \"critical\";\n readonly alert: \"alert\";\n readonly emerg: \"emerg\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "StatusType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json index 4a4c131f61..b7e3f0d317 100644 --- a/etc/browser-rum-react.api.json +++ b/etc/browser-rum-react.api.json @@ -1,625 +1,625 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum-react!", - "docComment": "", - "name": "@datadog/browser-rum-react", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum-react!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function addReactError(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", info: " - }, - { - "kind": "Reference", - "text": "ErrorInfo", - "canonicalReference": "@types/react!React.ErrorInfo:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/error/addReactError.d.ts", - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "info", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "name": "addReactError" - }, - { - "kind": "Class", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ErrorBoundary extends " - }, - { - "kind": "Reference", - "text": "React.Component", - "canonicalReference": "@types/react!React.Component:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Props", - "canonicalReference": "@datadog/browser-rum-react!~Props:interface" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@datadog/browser-rum-react!~State:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/error/errorBoundary.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "ErrorBoundary", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `ErrorBoundary` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(props: " - }, - { - "kind": "Reference", - "text": "Props", - "canonicalReference": "@datadog/browser-rum-react!~Props:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "props", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#componentDidCatch:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "componentDidCatch(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", errorInfo: " - }, - { - "kind": "Reference", - "text": "ErrorInfo", - "canonicalReference": "@types/react!React.ErrorInfo:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "errorInfo", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "componentDidCatch" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary.getDerivedStateFromError:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "static getDerivedStateFromError(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@datadog/browser-rum-react!~State:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": true, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "getDerivedStateFromError" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#render:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "render(): " - }, - { - "kind": "Reference", - "text": "React.ReactNode", - "canonicalReference": "@types/react!React.ReactNode:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "render" - }, - { - "kind": "Property", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#resetError:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "resetError: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "resetError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 7 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function reactPlugin(configuration?: " - }, - { - "kind": "Reference", - "text": "ReactPluginConfiguration", - "canonicalReference": "@datadog/browser-rum-react!~ReactPluginConfiguration:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "{\n name: string;\n onInit({ publicApi, initConfiguration }: {\n initConfiguration: import(\"@datadog/browser-rum-core\")." - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ";\n publicApi: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - }, - { - "kind": "Content", - "text": ";\n }): void;\n onRumStart({ strategy }: {\n strategy: " - }, - { - "kind": "Reference", - "text": "Strategy", - "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" - }, - { - "kind": "Content", - "text": ";\n }): void;\n getConfigurationTelemetry(): {\n router: boolean;\n };\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/reactPlugin.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "configuration", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": true - } - ], - "name": "reactPlugin" - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UNSTABLE_ReactComponentTracker: " - }, - { - "kind": "Content", - "text": "({ " - }, - { - "kind": "Reference", - "text": "name", - "canonicalReference": "@datadog/browser-rum-react!~__type#name" - }, - { - "kind": "Content", - "text": ": componentName, children, }: {\n name: string;\n children?: " - }, - { - "kind": "Reference", - "text": "React.ReactNode", - "canonicalReference": "@types/react!React.ReactNode:type" - }, - { - "kind": "Content", - "text": ";\n}) => " - }, - { - "kind": "Reference", - "text": "React.JSX.Element", - "canonicalReference": "@types/react!React.JSX.Element:interface" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/performance/reactComponentTracker.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "UNSTABLE_ReactComponentTracker", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-react!", + "docComment": "", + "name": "@datadog/browser-rum-react", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-react!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function addReactError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", info: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/addReactError.d.ts", + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "info", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "name": "addReactError" + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ErrorBoundary extends " + }, + { + "kind": "Reference", + "text": "React.Component", + "canonicalReference": "@types/react!React.Component:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/errorBoundary.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "ErrorBoundary", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `ErrorBoundary` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(props: " + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "props", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#componentDidCatch:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentDidCatch(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", errorInfo: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "errorInfo", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "componentDidCatch" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary.getDerivedStateFromError:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "static getDerivedStateFromError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "getDerivedStateFromError" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#render:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "render(): " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "render" + }, + { + "kind": "Property", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#resetError:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "resetError: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "resetError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 7 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function reactPlugin(configuration?: " + }, + { + "kind": "Reference", + "text": "ReactPluginConfiguration", + "canonicalReference": "@datadog/browser-rum-react!~ReactPluginConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "{\n name: string;\n onInit({ publicApi, initConfiguration }: {\n initConfiguration: import(\"@datadog/browser-rum-core\")." + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n publicApi: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n onRumStart({ strategy }: {\n strategy: " + }, + { + "kind": "Reference", + "text": "Strategy", + "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n getConfigurationTelemetry(): {\n router: boolean;\n };\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/reactPlugin.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": true + } + ], + "name": "reactPlugin" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UNSTABLE_ReactComponentTracker: " + }, + { + "kind": "Content", + "text": "({ " + }, + { + "kind": "Reference", + "text": "name", + "canonicalReference": "@datadog/browser-rum-react!~__type#name" + }, + { + "kind": "Content", + "text": ": componentName, children, }: {\n name: string;\n children?: " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";\n}) => " + }, + { + "kind": "Reference", + "text": "React.JSX.Element", + "canonicalReference": "@types/react!React.JSX.Element:interface" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/performance/reactComponentTracker.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "UNSTABLE_ReactComponentTracker", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-slim.api.json b/etc/browser-rum-slim.api.json index 0789ce2570..4de64a9086 100644 --- a/etc/browser-rum-slim.api.json +++ b/etc/browser-rum-slim.api.json @@ -1,202 +1,202 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum-slim!", - "docComment": "", - "name": "@datadog/browser-rum-slim", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum-slim!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogRum: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - } - ], - "fileUrlPath": "packages/rum-slim/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogRum", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-slim!", + "docComment": "", + "name": "@datadog/browser-rum-slim", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-slim!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + } + ], + "fileUrlPath": "packages/rum-slim/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index f36409f11a..7ed5ae614f 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -1,3872 +1,3872 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum!", - "docComment": "", - "name": "@datadog/browser-rum", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface", - "docComment": "/**\n * Schema of common properties of RUM events\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CommonProperties " - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "CommonProperties", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#_dd:member", - "docComment": "/**\n * Internal properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly _dd: " - }, - { - "kind": "Content", - "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "_dd", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#account:member", - "docComment": "/**\n * Account properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly account?: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "account", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#application:member", - "docComment": "/**\n * Application properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly application: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "application", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#build_id:member", - "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#build_version:member", - "docComment": "/**\n * The build version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#ci_test:member", - "docComment": "/**\n * CI Visibility properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly ci_test?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "ci_test", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#connectivity:member", - "docComment": "/**\n * Device connectivity properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "connectivity?: " - }, - { - "kind": "Content", - "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "connectivity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#context:member", - "docComment": "/**\n * User provided context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Content", - "text": "{\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#date:member", - "docComment": "/**\n * Start of the event in ms from epoch\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly date: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#device:member", - "docComment": "/**\n * Device properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "device?: " - }, - { - "kind": "Content", - "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "device", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#display:member", - "docComment": "/**\n * Display properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "display?: " - }, - { - "kind": "Content", - "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "display", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#os:member", - "docComment": "/**\n * Operating system properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "os?: " - }, - { - "kind": "Content", - "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "os", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#service:member", - "docComment": "/**\n * The service name for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#session:member", - "docComment": "/**\n * Session properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly session: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "session", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#source:member", - "docComment": "/**\n * The source of this event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly source?: " - }, - { - "kind": "Content", - "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "source", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#synthetics:member", - "docComment": "/**\n * Synthetics properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly synthetics?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "synthetics", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#usr:member", - "docComment": "/**\n * User properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly usr?: " - }, - { - "kind": "Content", - "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "usr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#version:member", - "docComment": "/**\n * The version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#view:member", - "docComment": "/**\n * View properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly view: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum!datadogRum:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogRum: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum!RumGlobal:interface" - } - ], - "fileUrlPath": "packages/rum/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogRum", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumActionEvent:type", - "docComment": "/**\n * Schema of all properties of an Action event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumActionEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumActionEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "events?: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "!Event:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "events", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type", - "docComment": "/**\n * Schema of all properties of an Error event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumErrorEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumErrorEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumEvent:type", - "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEvent = " - }, - { - "kind": "Reference", - "text": "RumActionEvent", - "canonicalReference": "@datadog/browser-rum!RumActionEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumErrorEvent", - "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumLongTaskEvent", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumResourceEvent", - "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumViewEvent", - "canonicalReference": "@datadog/browser-rum!RumViewEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumVitalEvent", - "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 12 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEventDomainContext = " - }, - { - "kind": "Content", - "text": "T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VIEW", - "canonicalReference": "@datadog/browser-rum!RumEventType.VIEW:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumViewEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ACTION", - "canonicalReference": "@datadog/browser-rum!RumEventType.ACTION:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumActionEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.RESOURCE", - "canonicalReference": "@datadog/browser-rum!RumEventType.RESOURCE:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumFetchResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumXhrResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumOtherResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ERROR", - "canonicalReference": "@datadog/browser-rum!RumEventType.ERROR:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumErrorEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.LONG_TASK", - "canonicalReference": "@datadog/browser-rum!RumEventType.LONG_TASK:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumLongTaskEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VITAL", - "canonicalReference": "@datadog/browser-rum!RumEventType.VITAL:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumVitalEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : never" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumEventDomainContext", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 34 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumFetchResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumFetchResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInit?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "requestInit", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInput: " - }, - { - "kind": "Reference", - "text": "RequestInfo", - "canonicalReference": "!RequestInfo:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "requestInput", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "response?: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "!Response:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "response", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumPublicApi extends " - }, - { - "kind": "Reference", - "text": "PublicApi", - "canonicalReference": "@datadog/browser-core!PublicApi:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "RumGlobal", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addAction:member", - "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addAction: " - }, - { - "kind": "Content", - "text": "(name: string, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addAction", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addDurationVital:member", - "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addError:member", - "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addError: " - }, - { - "kind": "Content", - "text": "(error: unknown, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addFeatureFlagEvaluation:member", - "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addFeatureFlagEvaluation: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addFeatureFlagEvaluation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addTiming:member", - "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addTiming: " - }, - { - "kind": "Content", - "text": "(name: string, time?: number) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addTiming", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearAccount:member", - "docComment": "/**\n * Clear all account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearAccount: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearGlobalContext:member", - "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearGlobalContext: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearUser:member", - "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearUser: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getAccount:member", - "docComment": "/**\n * Get account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAccount: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getGlobalContext:member", - "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getGlobalContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getInitConfiguration:member", - "docComment": "/**\n * Get the init configuration\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInitConfiguration: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInitConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getInternalContext:member", - "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Content", - "text": "(startTime?: number) => " - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-rum!InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getSessionReplayLink:member", - "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getSessionReplayLink: " - }, - { - "kind": "Content", - "text": "() => string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getSessionReplayLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getUser:member", - "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getUser: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getViewContext:member", - "docComment": "/**\n * Get View Context.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getViewContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#init:member", - "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeAccountProperty:member", - "docComment": "/**\n * Remove an account property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeGlobalContextProperty:member", - "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeUserProperty:member", - "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccount:member", - "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccount: " - }, - { - "kind": "Content", - "text": "(newAccount: " - }, - { - "kind": "Reference", - "text": "Account", - "canonicalReference": "@datadog/browser-core!Account:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccountProperty:member", - "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContext:member", - "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContext: " - }, - { - "kind": "Content", - "text": "(context: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContextProperty:member", - "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setTrackingConsent:member", - "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTrackingConsent: " - }, - { - "kind": "Content", - "text": "(trackingConsent: " - }, - { - "kind": "Reference", - "text": "TrackingConsent", - "canonicalReference": "@datadog/browser-core!TrackingConsent:type" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setTrackingConsent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(1)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": " & {\n id: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(2)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUserProperty:member", - "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContext:member", - "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContext: " - }, - { - "kind": "Content", - "text": "(context: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContextProperty:member", - "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContextProperty: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewName:member", - "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewName: " - }, - { - "kind": "Content", - "text": "(name: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startDurationVital:member", - "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startSessionReplayRecording:member", - "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "(options?: " - }, - { - "kind": "Reference", - "text": "StartRecordingOptions", - "canonicalReference": "@datadog/browser-rum!StartRecordingOptions:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", - "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startView: " - }, - { - "kind": "Content", - "text": "{\n (name?: string): void;\n (options: " - }, - { - "kind": "Reference", - "text": "ViewOptions", - "canonicalReference": "@datadog/browser-rum!ViewOptions:interface" - }, - { - "kind": "Content", - "text": "): void;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startView", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopDurationVital:member", - "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopDurationVital: " - }, - { - "kind": "Content", - "text": "(nameOrRef: string | " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSession:member", - "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSession: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSession", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSessionReplayRecording:member", - "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumInitConfiguration extends " - }, - { - "kind": "Reference", - "text": "InitConfiguration", - "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", - "releaseTag": "Public", - "name": "RumInitConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#actionNameAttribute:member", - "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "actionNameAttribute?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "actionNameAttribute", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#allowedTracingUrls:member", - "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "allowedTracingUrls?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "TracingOption", - "canonicalReference": "@datadog/browser-rum!TracingOption:type" - }, - { - "kind": "Content", - "text": "> | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "allowedTracingUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#applicationId:member", - "docComment": "/**\n * The RUM application ID.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "applicationId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "applicationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#beforeSend:member", - "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "beforeSend?: " - }, - { - "kind": "Content", - "text": "((event: " - }, - { - "kind": "Reference", - "text": "RumEvent", - "canonicalReference": "@datadog/browser-rum!RumEvent:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "RumEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type" - }, - { - "kind": "Content", - "text": ") => boolean) | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "beforeSend", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#compressIntakeRequests:member", - "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "compressIntakeRequests?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "compressIntakeRequests", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#defaultPrivacyLevel:member", - "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "defaultPrivacyLevel?: " - }, - { - "kind": "Reference", - "text": "DefaultPrivacyLevel", - "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "defaultPrivacyLevel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#enablePrivacyForActionName:member", - "docComment": "/**\n * Enables privacy control for action names.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "enablePrivacyForActionName?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "enablePrivacyForActionName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#excludedActivityUrls:member", - "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "excludedActivityUrls?: " - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "excludedActivityUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#plugins:member", - "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "plugins?: " - }, - { - "kind": "Reference", - "text": "RumPlugin", - "canonicalReference": "@datadog/browser-rum!RumPlugin:interface" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "plugins", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#profilingSampleRate:member", - "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "profilingSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "profilingSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#propagateTraceBaggage:member", - "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "propagateTraceBaggage?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "propagateTraceBaggage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#remoteConfigurationId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "remoteConfigurationId?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "remoteConfigurationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#sessionReplaySampleRate:member", - "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "sessionReplaySampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "sessionReplaySampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#startSessionReplayRecordingManually:member", - "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecordingManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "startSessionReplayRecordingManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#subdomain:member", - "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "subdomain?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "subdomain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceContextInjection:member", - "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceContextInjection?: " - }, - { - "kind": "Reference", - "text": "TraceContextInjection", - "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceContextInjection", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceSampleRate:member", - "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackBfcacheViews:member", - "docComment": "/**\n * Enable the creation of dedicated views for pages restored from the Back-Forward cache. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackBfcacheViews?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackBfcacheViews", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackFeatureFlagsForEvents:member", - "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackFeatureFlagsForEvents?: " - }, - { - "kind": "Reference", - "text": "FeatureFlagsForEvents", - "canonicalReference": "@datadog/browser-rum!FeatureFlagsForEvents:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackFeatureFlagsForEvents", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackLongTasks:member", - "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackLongTasks?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackLongTasks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackResources:member", - "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackResources?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackResources", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackUserInteractions:member", - "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackUserInteractions?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackUserInteractions", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackViewsManually:member", - "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackViewsManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackViewsManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#workerUrl:member", - "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "workerUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "workerUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type", - "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumLongTaskEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumLongTaskEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumOtherResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumOtherResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type", - "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumResourceEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumResourceEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumViewEvent:type", - "docComment": "/**\n * Schema of all properties of a View event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumViewEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n flutter_raster_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n js_refresh_rate?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n performance?: " - }, - { - "kind": "Reference", - "text": "ViewPerformanceData", - "canonicalReference": "@datadog/browser-rum!ViewPerformanceData:interface" - }, - { - "kind": "Content", - "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 13 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumViewEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "location: " - }, - { - "kind": "Reference", - "text": "Readonly", - "canonicalReference": "!Readonly:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Location", - "canonicalReference": "!Location:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "location", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type", - "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumVitalEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumVitalEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumXhrResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumXhrResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "xhr: " - }, - { - "kind": "Reference", - "text": "XMLHttpRequest", - "canonicalReference": "!XMLHttpRequest:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "xhr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum!", + "docComment": "", + "name": "@datadog/browser-rum", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface", + "docComment": "/**\n * Schema of common properties of RUM events\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CommonProperties " + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "CommonProperties", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#_dd:member", + "docComment": "/**\n * Internal properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly _dd: " + }, + { + "kind": "Content", + "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "_dd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#account:member", + "docComment": "/**\n * Account properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly account?: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "account", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#application:member", + "docComment": "/**\n * Application properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly application: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_id:member", + "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_version:member", + "docComment": "/**\n * The build version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#ci_test:member", + "docComment": "/**\n * CI Visibility properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly ci_test?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "ci_test", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#connectivity:member", + "docComment": "/**\n * Device connectivity properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "connectivity?: " + }, + { + "kind": "Content", + "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "connectivity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#context:member", + "docComment": "/**\n * User provided context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "{\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#date:member", + "docComment": "/**\n * Start of the event in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#device:member", + "docComment": "/**\n * Device properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "device?: " + }, + { + "kind": "Content", + "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "device", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#display:member", + "docComment": "/**\n * Display properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "display?: " + }, + { + "kind": "Content", + "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "display", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#os:member", + "docComment": "/**\n * Operating system properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "os?: " + }, + { + "kind": "Content", + "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "os", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#service:member", + "docComment": "/**\n * The service name for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly session: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#source:member", + "docComment": "/**\n * The source of this event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly source?: " + }, + { + "kind": "Content", + "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "source", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#synthetics:member", + "docComment": "/**\n * Synthetics properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly synthetics?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "synthetics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#usr:member", + "docComment": "/**\n * User properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly usr?: " + }, + { + "kind": "Content", + "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "usr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#version:member", + "docComment": "/**\n * The version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly view: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface" + } + ], + "fileUrlPath": "packages/rum/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type", + "docComment": "/**\n * Schema of all properties of an Action event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumActionEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumActionEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "events?: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "!Event:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "events", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type", + "docComment": "/**\n * Schema of all properties of an Error event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumErrorEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumErrorEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEvent:type", + "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEvent = " + }, + { + "kind": "Reference", + "text": "RumActionEvent", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumErrorEvent", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumLongTaskEvent", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumResourceEvent", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumViewEvent", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumVitalEvent", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VIEW", + "canonicalReference": "@datadog/browser-rum!RumEventType.VIEW:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumViewEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ACTION", + "canonicalReference": "@datadog/browser-rum!RumEventType.ACTION:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumActionEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.RESOURCE", + "canonicalReference": "@datadog/browser-rum!RumEventType.RESOURCE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumFetchResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumXhrResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumOtherResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ERROR", + "canonicalReference": "@datadog/browser-rum!RumEventType.ERROR:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumErrorEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.LONG_TASK", + "canonicalReference": "@datadog/browser-rum!RumEventType.LONG_TASK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumLongTaskEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VITAL", + "canonicalReference": "@datadog/browser-rum!RumEventType.VITAL:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumVitalEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 34 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumFetchResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumFetchResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInit?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "requestInit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInput: " + }, + { + "kind": "Reference", + "text": "RequestInfo", + "canonicalReference": "!RequestInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "requestInput", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "response?: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "response", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "RumGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addAction:member", + "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addAction: " + }, + { + "kind": "Content", + "text": "(name: string, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addDurationVital:member", + "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addError:member", + "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addError: " + }, + { + "kind": "Content", + "text": "(error: unknown, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addFeatureFlagEvaluation:member", + "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addFeatureFlagEvaluation: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addFeatureFlagEvaluation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addTiming:member", + "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addTiming: " + }, + { + "kind": "Content", + "text": "(name: string, time?: number) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addTiming", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-rum!InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getSessionReplayLink:member", + "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSessionReplayLink: " + }, + { + "kind": "Content", + "text": "() => string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getSessionReplayLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getViewContext:member", + "docComment": "/**\n * Get View Context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getViewContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#init:member", + "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContext:member", + "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContext: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContextProperty:member", + "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContextProperty: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewName:member", + "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewName: " + }, + { + "kind": "Content", + "text": "(name: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startDurationVital:member", + "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startSessionReplayRecording:member", + "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "(options?: " + }, + { + "kind": "Reference", + "text": "StartRecordingOptions", + "canonicalReference": "@datadog/browser-rum!StartRecordingOptions:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", + "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startView: " + }, + { + "kind": "Content", + "text": "{\n (name?: string): void;\n (options: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum!ViewOptions:interface" + }, + { + "kind": "Content", + "text": "): void;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopDurationVital:member", + "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopDurationVital: " + }, + { + "kind": "Content", + "text": "(nameOrRef: string | " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSession:member", + "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSession: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSessionReplayRecording:member", + "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", + "releaseTag": "Public", + "name": "RumInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#actionNameAttribute:member", + "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionNameAttribute?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "actionNameAttribute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#allowedTracingUrls:member", + "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "allowedTracingUrls?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "TracingOption", + "canonicalReference": "@datadog/browser-rum!TracingOption:type" + }, + { + "kind": "Content", + "text": "> | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "allowedTracingUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#applicationId:member", + "docComment": "/**\n * The RUM application ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applicationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "RumEvent", + "canonicalReference": "@datadog/browser-rum!RumEvent:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "RumEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#compressIntakeRequests:member", + "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "compressIntakeRequests?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "compressIntakeRequests", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#defaultPrivacyLevel:member", + "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPrivacyLevel?: " + }, + { + "kind": "Reference", + "text": "DefaultPrivacyLevel", + "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "defaultPrivacyLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#enablePrivacyForActionName:member", + "docComment": "/**\n * Enables privacy control for action names.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enablePrivacyForActionName?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "enablePrivacyForActionName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#excludedActivityUrls:member", + "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "excludedActivityUrls?: " + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "excludedActivityUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#plugins:member", + "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "plugins?: " + }, + { + "kind": "Reference", + "text": "RumPlugin", + "canonicalReference": "@datadog/browser-rum!RumPlugin:interface" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "plugins", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#profilingSampleRate:member", + "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "profilingSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "profilingSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#propagateTraceBaggage:member", + "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propagateTraceBaggage?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "propagateTraceBaggage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#remoteConfigurationId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "remoteConfigurationId?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "remoteConfigurationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#sessionReplaySampleRate:member", + "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionReplaySampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "sessionReplaySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#startSessionReplayRecordingManually:member", + "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecordingManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "startSessionReplayRecordingManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#subdomain:member", + "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subdomain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "subdomain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceContextInjection:member", + "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceContextInjection?: " + }, + { + "kind": "Reference", + "text": "TraceContextInjection", + "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceContextInjection", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceSampleRate:member", + "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackBfcacheViews:member", + "docComment": "/**\n * Enable the creation of dedicated views for pages restored from the Back-Forward cache. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackBfcacheViews?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackBfcacheViews", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackFeatureFlagsForEvents:member", + "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackFeatureFlagsForEvents?: " + }, + { + "kind": "Reference", + "text": "FeatureFlagsForEvents", + "canonicalReference": "@datadog/browser-rum!FeatureFlagsForEvents:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackFeatureFlagsForEvents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackLongTasks:member", + "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackLongTasks?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackLongTasks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackResources:member", + "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackResources?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackUserInteractions:member", + "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackUserInteractions?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackUserInteractions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackViewsManually:member", + "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackViewsManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackViewsManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#workerUrl:member", + "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workerUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "workerUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type", + "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumLongTaskEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumLongTaskEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumOtherResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumOtherResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type", + "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumResourceEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumResourceEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type", + "docComment": "/**\n * Schema of all properties of a View event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumViewEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n flutter_raster_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n js_refresh_rate?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n performance?: " + }, + { + "kind": "Reference", + "text": "ViewPerformanceData", + "canonicalReference": "@datadog/browser-rum!ViewPerformanceData:interface" + }, + { + "kind": "Content", + "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 13 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumViewEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Location", + "canonicalReference": "!Location:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type", + "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumVitalEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumVitalEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumXhrResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumXhrResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "xhr: " + }, + { + "kind": "Reference", + "text": "XMLHttpRequest", + "canonicalReference": "!XMLHttpRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "xhr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/scripts/fix-api-docs.js b/scripts/fix-api-docs.js deleted file mode 100644 index 89f68ba24e..0000000000 --- a/scripts/fix-api-docs.js +++ /dev/null @@ -1,83 +0,0 @@ -const fs = require('fs') -const path = require('path') - -function fixMarkdownLinks(content) { - // Remplacer les tables HTML complexes par des tables markdown simples - // ou convertir les liens markdown en HTML dans les cellules - - // Pattern pour trouver les liens markdown [text](url) - const linkPattern = /\[([^\]]+)\]\(([^)]+)\)/g - - // Remplacer les liens dans les cellules de table - content = content.replace(/\s*\n*\s*\[([^\]]+)\]\(([^)]+)\)\s*\n*\s*<\/td>/g, (_match, text, url) => { - // Corriger l'URL si nécessaire - let fixedUrl = url - if (url.startsWith('./')) { - fixedUrl = url.substring(2) - } - if (fixedUrl.endsWith('.md')) { - fixedUrl = fixedUrl.replace('.md', '.html') - } - - return `${text}` - }) - - // Gérer les cas où il y a du texte supplémentaire dans les cellules - content = content.replace(/([\s\S]*?)<\/td>/g, (_match, cellContent) => { - const fixedContent = cellContent.replace(linkPattern, (_linkMatch, text, url) => { - let fixedUrl = url - if (url.startsWith('./')) { - fixedUrl = url.substring(2) - } - if (fixedUrl.endsWith('.md')) { - fixedUrl = fixedUrl.replace('.md', '.html') - } - return `${text}` - }) - return `${fixedContent}` - }) - - // Corriger aussi les liens en dehors des tables - content = content.replace(/\[Home\]\(\.\/(index\.md)\)/g, '[Home](index.html)') - content = content.replace(/> \[([^\]]+)\]\(\.\/([^)]+)\.md\)/g, '> $1') - - return content -} - -function processDirectory(dirPath) { - const files = fs.readdirSync(dirPath) - - files.forEach((file) => { - const filePath = path.join(dirPath, file) - const stat = fs.statSync(filePath) - - if (stat.isDirectory() && !file.startsWith('_') && file !== '.git') { - processDirectory(filePath) - } else if (stat.isFile() && file.endsWith('.md') && file !== 'README.md') { - console.log(`Processing: ${filePath}`) - - let content = fs.readFileSync(filePath, 'utf-8') - const fixedContent = fixMarkdownLinks(content) - - if (content !== fixedContent) { - fs.writeFileSync(filePath, fixedContent, 'utf-8') - console.log(` ✓ Fixed links in ${file}`) - } - } - }) -} - -function runMain() { - // Traiter le dossier docs - const docsPath = path.join(__dirname, '..', 'docs') - if (fs.existsSync(docsPath)) { - console.log('Fixing API documentation links...') - processDirectory(docsPath) - console.log('Done!') - } else { - console.error('Error: docs directory not found') - process.exit(1) - } -} - -runMain() From 0088e7595821645d720bcb2cdebc6352685c542d Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 13:59:22 +0200 Subject: [PATCH 10/21] update --- docs/browser-logs.datadoglogs.md | 22 +- docs/browser-logs.handlertype.md | 30 +- docs/browser-logs.logger._constructor_.md | 200 +- docs/browser-logs.logger.alert.md | 149 +- docs/browser-logs.logger.clearcontext.md | 30 +- docs/browser-logs.logger.critical.md | 149 +- docs/browser-logs.logger.debug.md | 149 +- docs/browser-logs.logger.emerg.md | 149 +- docs/browser-logs.logger.error.md | 149 +- docs/browser-logs.logger.getcontext.md | 30 +- docs/browser-logs.logger.gethandler.md | 30 +- docs/browser-logs.logger.getlevel.md | 30 +- docs/browser-logs.logger.info.md | 149 +- docs/browser-logs.logger.log.md | 174 +- docs/browser-logs.logger.logimplementation.md | 203 +- docs/browser-logs.logger.md | 158 +- docs/browser-logs.logger.notice.md | 149 +- docs/browser-logs.logger.ok.md | 149 +- ...owser-logs.logger.removecontextproperty.md | 91 +- docs/browser-logs.logger.setcontext.md | 91 +- .../browser-logs.logger.setcontextproperty.md | 116 +- docs/browser-logs.logger.sethandler.md | 91 +- docs/browser-logs.logger.setlevel.md | 87 +- docs/browser-logs.logger.warn.md | 149 +- ...rowser-logs.loggerconfiguration.context.md | 22 +- ...rowser-logs.loggerconfiguration.handler.md | 22 +- .../browser-logs.loggerconfiguration.level.md | 22 +- docs/browser-logs.loggerconfiguration.md | 154 +- docs/browser-logs.logsevent.application_id.md | 26 +- docs/browser-logs.logsevent.date.md | 26 +- docs/browser-logs.logsevent.error.md | 50 +- docs/browser-logs.logsevent.http.md | 36 +- docs/browser-logs.logsevent.logger.md | 32 +- docs/browser-logs.logsevent.md | 428 +- docs/browser-logs.logsevent.message.md | 26 +- docs/browser-logs.logsevent.origin.md | 26 +- docs/browser-logs.logsevent.service.md | 26 +- docs/browser-logs.logsevent.session.md | 32 +- docs/browser-logs.logsevent.session_id.md | 26 +- docs/browser-logs.logsevent.status.md | 26 +- docs/browser-logs.logsevent.view.md | 36 +- docs/browser-logs.logseventdomaincontext.md | 28 +- docs/browser-logs.logsglobal.clearaccount.md | 26 +- ...wser-logs.logsglobal.clearglobalcontext.md | 30 +- docs/browser-logs.logsglobal.clearuser.md | 30 +- docs/browser-logs.logsglobal.createlogger.md | 30 +- docs/browser-logs.logsglobal.getaccount.md | 26 +- ...rowser-logs.logsglobal.getglobalcontext.md | 30 +- ...er-logs.logsglobal.getinitconfiguration.md | 26 +- ...wser-logs.logsglobal.getinternalcontext.md | 30 +- docs/browser-logs.logsglobal.getlogger.md | 30 +- docs/browser-logs.logsglobal.getuser.md | 30 +- docs/browser-logs.logsglobal.init.md | 26 +- docs/browser-logs.logsglobal.logger.md | 22 +- docs/browser-logs.logsglobal.md | 793 +- ...r-logs.logsglobal.removeaccountproperty.md | 26 +- ....logsglobal.removeglobalcontextproperty.md | 30 +- ...wser-logs.logsglobal.removeuserproperty.md | 30 +- docs/browser-logs.logsglobal.setaccount.md | 26 +- ...wser-logs.logsglobal.setaccountproperty.md | 26 +- ...rowser-logs.logsglobal.setglobalcontext.md | 26 +- ...ogs.logsglobal.setglobalcontextproperty.md | 26 +- ...wser-logs.logsglobal.settrackingconsent.md | 26 +- docs/browser-logs.logsglobal.setuser.md | 103 +- docs/browser-logs.logsglobal.setuser_1.md | 104 +- ...browser-logs.logsglobal.setuserproperty.md | 26 +- ...r-logs.logsinitconfiguration.beforesend.md | 26 +- ...ogsinitconfiguration.forwardconsolelogs.md | 26 +- ...gsinitconfiguration.forwarderrorstologs.md | 26 +- ...gs.logsinitconfiguration.forwardreports.md | 26 +- docs/browser-logs.logsinitconfiguration.md | 221 +- ...logs.logsinitconfiguration.usepciintake.md | 26 +- docs/browser-logs.logsmessage.context.md | 22 +- docs/browser-logs.logsmessage.md | 146 +- docs/browser-logs.logsmessage.message.md | 22 +- docs/browser-logs.logsmessage.status.md | 22 +- docs/browser-logs.md | 278 +- docs/browser-logs.statustype.md | 42 +- docs/browser-rum-react.addreacterror.md | 116 +- ...r-rum-react.errorboundary._constructor_.md | 88 +- ...m-react.errorboundary.componentdidcatch.md | 116 +- ....errorboundary.getderivedstatefromerror.md | 91 +- docs/browser-rum-react.errorboundary.md | 247 +- .../browser-rum-react.errorboundary.render.md | 30 +- ...wser-rum-react.errorboundary.reseterror.md | 22 +- docs/browser-rum-react.md | 142 +- docs/browser-rum-react.reactplugin.md | 120 +- ...um-react.unstable_reactcomponenttracker.md | 26 +- docs/browser-rum-slim.datadogrum.md | 22 +- docs/browser-rum-slim.md | 50 +- docs/browser-rum.commonproperties._dd.md | 54 +- docs/browser-rum.commonproperties.account.md | 34 +- ...rowser-rum.commonproperties.application.md | 32 +- docs/browser-rum.commonproperties.build_id.md | 26 +- ...wser-rum.commonproperties.build_version.md | 26 +- docs/browser-rum.commonproperties.ci_test.md | 32 +- ...owser-rum.commonproperties.connectivity.md | 46 +- docs/browser-rum.commonproperties.context.md | 30 +- docs/browser-rum.commonproperties.date.md | 26 +- docs/browser-rum.commonproperties.device.md | 40 +- docs/browser-rum.commonproperties.display.md | 40 +- docs/browser-rum.commonproperties.md | 690 +- docs/browser-rum.commonproperties.os.md | 38 +- docs/browser-rum.commonproperties.service.md | 26 +- docs/browser-rum.commonproperties.session.md | 36 +- docs/browser-rum.commonproperties.source.md | 26 +- ...browser-rum.commonproperties.synthetics.md | 36 +- docs/browser-rum.commonproperties.usr.md | 38 +- docs/browser-rum.commonproperties.version.md | 26 +- docs/browser-rum.commonproperties.view.md | 38 +- docs/browser-rum.datadogrum.md | 22 +- docs/browser-rum.md | 354 +- docs/browser-rum.rumactionevent.md | 147 +- ...-rum.rumactioneventdomaincontext.events.md | 22 +- ...mactioneventdomaincontext.handlingstack.md | 22 +- ...browser-rum.rumactioneventdomaincontext.md | 128 +- docs/browser-rum.rumerrorevent.md | 213 +- ...er-rum.rumerroreventdomaincontext.error.md | 22 +- ...umerroreventdomaincontext.handlingstack.md | 22 +- .../browser-rum.rumerroreventdomaincontext.md | 124 +- docs/browser-rum.rumevent.md | 36 +- docs/browser-rum.rumeventdomaincontext.md | 38 +- ...umfetchresourceeventdomaincontext.error.md | 22 +- ...esourceeventdomaincontext.handlingstack.md | 22 +- ...tchresourceeventdomaincontext.isaborted.md | 22 +- ...-rum.rumfetchresourceeventdomaincontext.md | 270 +- ...urceeventdomaincontext.performanceentry.md | 22 +- ...hresourceeventdomaincontext.requestinit.md | 22 +- ...resourceeventdomaincontext.requestinput.md | 22 +- ...etchresourceeventdomaincontext.response.md | 22 +- docs/browser-rum.rumglobal.addaction.md | 26 +- .../browser-rum.rumglobal.adddurationvital.md | 36 +- docs/browser-rum.rumglobal.adderror.md | 26 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 26 +- docs/browser-rum.rumglobal.addtiming.md | 26 +- docs/browser-rum.rumglobal.clearaccount.md | 26 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 30 +- docs/browser-rum.rumglobal.clearuser.md | 30 +- docs/browser-rum.rumglobal.getaccount.md | 26 +- .../browser-rum.rumglobal.getglobalcontext.md | 30 +- ...wser-rum.rumglobal.getinitconfiguration.md | 26 +- ...rowser-rum.rumglobal.getinternalcontext.md | 26 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 30 +- docs/browser-rum.rumglobal.getuser.md | 30 +- docs/browser-rum.rumglobal.getviewcontext.md | 26 +- docs/browser-rum.rumglobal.init.md | 26 +- docs/browser-rum.rumglobal.md | 1207 ++- ...ser-rum.rumglobal.removeaccountproperty.md | 26 +- ...m.rumglobal.removeglobalcontextproperty.md | 30 +- ...rowser-rum.rumglobal.removeuserproperty.md | 30 +- docs/browser-rum.rumglobal.setaccount.md | 26 +- ...rowser-rum.rumglobal.setaccountproperty.md | 26 +- .../browser-rum.rumglobal.setglobalcontext.md | 26 +- ...-rum.rumglobal.setglobalcontextproperty.md | 26 +- ...rowser-rum.rumglobal.settrackingconsent.md | 26 +- docs/browser-rum.rumglobal.setuser.md | 103 +- docs/browser-rum.rumglobal.setuser_1.md | 104 +- docs/browser-rum.rumglobal.setuserproperty.md | 26 +- docs/browser-rum.rumglobal.setviewcontext.md | 30 +- ...er-rum.rumglobal.setviewcontextproperty.md | 30 +- docs/browser-rum.rumglobal.setviewname.md | 30 +- ...rowser-rum.rumglobal.startdurationvital.md | 39 +- ...m.rumglobal.startsessionreplayrecording.md | 30 +- docs/browser-rum.rumglobal.startview.md | 32 +- ...browser-rum.rumglobal.stopdurationvital.md | 32 +- docs/browser-rum.rumglobal.stopsession.md | 26 +- ...um.rumglobal.stopsessionreplayrecording.md | 30 +- ...uminitconfiguration.actionnameattribute.md | 26 +- ...ruminitconfiguration.allowedtracingurls.md | 26 +- ...-rum.ruminitconfiguration.applicationid.md | 26 +- ...ser-rum.ruminitconfiguration.beforesend.md | 30 +- ...nitconfiguration.compressintakerequests.md | 26 +- ...uminitconfiguration.defaultprivacylevel.md | 26 +- ...onfiguration.enableprivacyforactionname.md | 26 +- ...minitconfiguration.excludedactivityurls.md | 26 +- docs/browser-rum.ruminitconfiguration.md | 776 +- ...rowser-rum.ruminitconfiguration.plugins.md | 26 +- ...uminitconfiguration.profilingsamplerate.md | 26 +- ...initconfiguration.propagatetracebaggage.md | 26 +- ...initconfiguration.remoteconfigurationid.md | 24 +- ...itconfiguration.sessionreplaysamplerate.md | 26 +- ...ion.startsessionreplayrecordingmanually.md | 26 +- ...wser-rum.ruminitconfiguration.subdomain.md | 26 +- ...initconfiguration.tracecontextinjection.md | 26 +- ...um.ruminitconfiguration.tracesamplerate.md | 26 +- ....ruminitconfiguration.trackbfcacheviews.md | 13 - ...onfiguration.trackfeatureflagsforevents.md | 26 +- ...rum.ruminitconfiguration.tracklongtasks.md | 26 +- ...rum.ruminitconfiguration.trackresources.md | 26 +- ...initconfiguration.trackuserinteractions.md | 26 +- ...ruminitconfiguration.trackviewsmanually.md | 26 +- ...wser-rum.ruminitconfiguration.workerurl.md | 26 +- docs/browser-rum.rumlongtaskevent.md | 104 +- ...owser-rum.rumlongtaskeventdomaincontext.md | 94 +- ...taskeventdomaincontext.performanceentry.md | 22 +- ...-rum.rumotherresourceeventdomaincontext.md | 94 +- ...urceeventdomaincontext.performanceentry.md | 22 +- docs/browser-rum.rumresourceevent.md | 205 +- docs/browser-rum.rumviewevent.md | 295 +- ...-rum.rumvieweventdomaincontext.location.md | 22 +- docs/browser-rum.rumvieweventdomaincontext.md | 94 +- docs/browser-rum.rumvitalevent.md | 73 +- ...esourceeventdomaincontext.handlingstack.md | 22 +- ...xhrresourceeventdomaincontext.isaborted.md | 22 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 180 +- ...urceeventdomaincontext.performanceentry.md | 22 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 22 +- docs/index.md | 86 +- etc/browser-logs.api.json | 7042 +++++++-------- etc/browser-rum-react.api.json | 1250 +-- etc/browser-rum-slim.api.json | 404 +- etc/browser-rum.api.json | 7717 ++++++++--------- package.json | 2 +- .../src/domain/configuration/configuration.ts | 12 +- .../src/domain/configuration/configuration.ts | 33 +- packages/rum-core/src/domainContext.types.ts | 27 +- scripts/fix-doc-links.js | 25 + 217 files changed, 16820 insertions(+), 15054 deletions(-) delete mode 100644 docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md create mode 100644 scripts/fix-doc-links.js diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index 3f3d9c053b..73c75109d4 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > datadogLogs - -## datadogLogs variable - -**Signature:** - -```typescript -datadogLogs: LogsPublicApi -``` + + +Home > @datadog/browser-logs > datadogLogs + +## datadogLogs variable + +**Signature:** + +```typescript +datadogLogs: LogsPublicApi +``` diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index d0de6dab81..e785bbea81 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > HandlerType - -## HandlerType variable - -**Signature:** - -```typescript -HandlerType: { - readonly console: "console"; - readonly http: "http"; - readonly silent: "silent"; -} -``` + + +Home > @datadog/browser-logs > HandlerType + +## HandlerType variable + +**Signature:** + +```typescript +HandlerType: { + readonly console: "console"; + readonly http: "http"; + readonly silent: "silent"; +} +``` diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 5970ee666a..879799d217 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,89 +1,111 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > (constructor) - -## Logger.(constructor) - -Constructs a new instance of the `Logger` class - -**Signature:** - -```typescript -constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void, name?: string, handlerType?: HandlerType | HandlerType[], level?: StatusType, loggerContext?: object); -``` - -## Parameters - - - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -handleLogStrategy - - - -(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void - - - -
- -name - - - -string - - - -_(Optional)_ - -
- -handlerType - - - -HandlerType \| HandlerType\[\] - - - -_(Optional)_ - -
- -level - -StatusType - -_(Optional)_ - -
- -loggerContext - - - -object - - - -_(Optional)_ - -
+ + +Home > @datadog/browser-logs > Logger > (constructor) + +## Logger.(constructor) + +Constructs a new instance of the `Logger` class + +**Signature:** + +```typescript +constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void, name?: string, handlerType?: HandlerType | HandlerType[], level?: StatusType, loggerContext?: object); +``` + +## Parameters + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +handleLogStrategy + + + + +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void + + + + + +
+ +name + + + + +string + + + + +_(Optional)_ + + +
+ +handlerType + + + + +HandlerType \| HandlerType\[\] + + + + +_(Optional)_ + + +
+ +level + + + + +StatusType + + + + +_(Optional)_ + + +
+ +loggerContext + + + + +object + + + + +_(Optional)_ + + +
diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index f5b2b4f1ed..211e88b279 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > alert - -## Logger.alert() method - -**Signature:** - -```typescript -alert(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > alert + +## Logger.alert() method + +**Signature:** + +```typescript +alert(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 6c3a62ba38..fa4b060fcc 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > clearContext - -## Logger.clearContext() method - -**Signature:** - -```typescript -clearContext(): void; -``` - -**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > clearContext + +## Logger.clearContext() method + +**Signature:** + +```typescript +clearContext(): void; +``` +**Returns:** + +void + diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index a505bffade..380d6a52dd 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > critical - -## Logger.critical() method - -**Signature:** - -```typescript -critical(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > critical + +## Logger.critical() method + +**Signature:** + +```typescript +critical(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 895fe96a64..66ff6c796d 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > debug - -## Logger.debug() method - -**Signature:** - -```typescript -debug(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > debug + +## Logger.debug() method + +**Signature:** + +```typescript +debug(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index 64248145ed..04baaee635 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > emerg - -## Logger.emerg() method - -**Signature:** - -```typescript -emerg(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > emerg + +## Logger.emerg() method + +**Signature:** + +```typescript +emerg(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index f289672eae..e646c8b82e 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > error - -## Logger.error() method - -**Signature:** - -```typescript -error(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > error + +## Logger.error() method + +**Signature:** + +```typescript +error(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index b1f45693dc..f5f833e913 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getContext - -## Logger.getContext() method - -**Signature:** - -```typescript -getContext(): Context; -``` - -**Returns:** - -Context + + +Home > @datadog/browser-logs > Logger > getContext + +## Logger.getContext() method + +**Signature:** + +```typescript +getContext(): Context; +``` +**Returns:** + +Context + diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index a3853eb735..4d27f246ae 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getHandler - -## Logger.getHandler() method - -**Signature:** - -```typescript -getHandler(): HandlerType | HandlerType[]; -``` - -**Returns:** - -[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)\[\] + + +Home > @datadog/browser-logs > Logger > getHandler + +## Logger.getHandler() method + +**Signature:** + +```typescript +getHandler(): HandlerType | HandlerType[]; +``` +**Returns:** + +HandlerType \| HandlerType\[\] + diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 95d3da646e..7257c909a3 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > getLevel - -## Logger.getLevel() method - -**Signature:** - -```typescript -getLevel(): StatusType; -``` - -**Returns:** - -[StatusType](./browser-logs.statustype.md) + + +Home > @datadog/browser-logs > Logger > getLevel + +## Logger.getLevel() method + +**Signature:** + +```typescript +getLevel(): StatusType; +``` +**Returns:** + +StatusType + diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index 43a20fe038..b21b99594a 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > info - -## Logger.info() method - -**Signature:** - -```typescript -info(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > info + +## Logger.info() method + +**Signature:** + +```typescript +info(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index a4e6c9a9d5..2de8b52878 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,77 +1,97 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > log - -## Logger.log() method - -**Signature:** - -```typescript -log(message: string, messageContext?: object, status?: StatusType, error?: Error): void; -``` - -## Parameters - - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -status - -StatusType - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > log + +## Logger.log() method + +**Signature:** + +```typescript +log(message: string, messageContext?: object, status?: StatusType, error?: Error): void; +``` + +## Parameters + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +status + + + + +StatusType + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 179489398f..5f4cf2d3e2 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,90 +1,113 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > logImplementation - -## Logger.logImplementation() method - -**Signature:** - -```typescript -logImplementation(message: string, messageContext?: object, status?: StatusType, error?: Error, handlingStack?: string): void; -``` - -## Parameters - - - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -status - -StatusType - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
- -handlingStack - - - -string - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > logImplementation + +## Logger.logImplementation() method + +**Signature:** + +```typescript +logImplementation(message: string, messageContext?: object, status?: StatusType, error?: Error, handlingStack?: string): void; +``` + +## Parameters + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +status + + + + +StatusType + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+ +handlingStack + + + + +string + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index bcff527ff0..779fa20d50 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,51 +1,107 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger - -## Logger interface - -**Signature:** - -```typescript -export interface Logger -``` - -## Methods - - - - - - - - - - - -
- -Method - - - -Description - -
alert(message, messageContext, error) - -
critical(message, messageContext, error) - -
debug(message, messageContext, error) - -
emerg(message, messageContext, error) - -
error(message, messageContext, error) - -
info(message, messageContext, error) - -
notice(message, messageContext, error) - -
ok(message, messageContext, error) - -
warn(message, messageContext, error) - -
+ + +Home > @datadog/browser-logs > Logger + +## Logger interface + +**Signature:** + +```typescript +export interface Logger +``` + +## Methods + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +alert(message, messageContext, error) + + + + + +
+ +critical(message, messageContext, error) + + + + + +
+ +debug(message, messageContext, error) + + + + + +
+ +emerg(message, messageContext, error) + + + + + +
+ +error(message, messageContext, error) + + + + + +
+ +info(message, messageContext, error) + + + + + +
+ +notice(message, messageContext, error) + + + + + +
+ +ok(message, messageContext, error) + + + + + +
+ +warn(message, messageContext, error) + + + + + +
diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index 76eed5a8df..ceabd316ce 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > notice - -## Logger.notice() method - -**Signature:** - -```typescript -notice(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > notice + +## Logger.notice() method + +**Signature:** + +```typescript +notice(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 2de5ca7d2c..d5fd44e57a 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > ok - -## Logger.ok() method - -**Signature:** - -```typescript -ok(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > ok + +## Logger.ok() method + +**Signature:** + +```typescript +ok(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index fed6805d54..d682bc1ba4 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,42 +1,49 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > removeContextProperty - -## Logger.removeContextProperty() method - -**Signature:** - -```typescript -removeContextProperty(key: string): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -key - - - -string - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > removeContextProperty + +## Logger.removeContextProperty() method + +**Signature:** + +```typescript +removeContextProperty(key: string): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +key + + + + +string + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 82debf2d90..858068eea3 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,42 +1,49 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setContext - -## Logger.setContext() method - -**Signature:** - -```typescript -setContext(context: object): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -context - - - -object - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > setContext + +## Logger.setContext() method + +**Signature:** + +```typescript +setContext(context: object): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +context + + + + +object + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 5c651cd847..91cd7ed56c 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,53 +1,63 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setContextProperty - -## Logger.setContextProperty() method - -**Signature:** - -```typescript -setContextProperty(key: string, value: any): void; -``` - -## Parameters - - - - -
- -Parameter - - - -Type - - - -Description - -
- -key - - - -string - - - -
- -value - - - -any - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > setContextProperty + +## Logger.setContextProperty() method + +**Signature:** + +```typescript +setContextProperty(key: string, value: any): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +key + + + + +string + + + + + +
+ +value + + + + +any + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index 20953e86df..e77ea9fe81 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,42 +1,49 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setHandler - -## Logger.setHandler() method - -**Signature:** - -```typescript -setHandler(handler: HandlerType | HandlerType[]): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -handler - - - -HandlerType \| HandlerType\[\] - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > setHandler + +## Logger.setHandler() method + +**Signature:** + +```typescript +setHandler(handler: HandlerType | HandlerType[]): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +handler + + + + +HandlerType \| HandlerType\[\] + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 10b8f1d2ad..d8ba2d6c80 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,38 +1,49 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > setLevel - -## Logger.setLevel() method - -**Signature:** - -```typescript -setLevel(level: StatusType): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -level - -StatusType - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > setLevel + +## Logger.setLevel() method + +**Signature:** + +```typescript +setLevel(level: StatusType): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +level + + + + +StatusType + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index de11798515..a825c2b0d0 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,68 +1,81 @@ - - -[Home](index.html) > @datadog/browser-logs > Logger > warn - -## Logger.warn() method - -**Signature:** - -```typescript -warn(message: string, messageContext?: object, error?: Error): void; -``` - -## Parameters - - - - - -
- -Parameter - - - -Type - - - -Description - -
- -message - - - -string - - - -
- -messageContext - - - -object - - - -_(Optional)_ - -
- -error - - - -Error - - - -_(Optional)_ - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > Logger > warn + +## Logger.warn() method + +**Signature:** + +```typescript +warn(message: string, messageContext?: object, error?: Error): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +message + + + + +string + + + + + +
+ +messageContext + + + + +object + + + + +_(Optional)_ + + +
+ +error + + + + +Error + + + + +_(Optional)_ + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index c8205b3be5..95fd9ca076 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > context - -## LoggerConfiguration.context property - -**Signature:** - -```typescript -context?: object; -``` + + +Home > @datadog/browser-logs > LoggerConfiguration > context + +## LoggerConfiguration.context property + +**Signature:** + +```typescript +context?: object; +``` diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 214933b1ba..c1a95e9d9a 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > handler - -## LoggerConfiguration.handler property - -**Signature:** - -```typescript -handler?: HandlerType | HandlerType[]; -``` + + +Home > @datadog/browser-logs > LoggerConfiguration > handler + +## LoggerConfiguration.handler property + +**Signature:** + +```typescript +handler?: HandlerType | HandlerType[]; +``` diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 552e831b2a..6f09cfebf3 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration > level - -## LoggerConfiguration.level property - -**Signature:** - -```typescript -level?: StatusType; -``` + + +Home > @datadog/browser-logs > LoggerConfiguration > level + +## LoggerConfiguration.level property + +**Signature:** + +```typescript +level?: StatusType; +``` diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 5adc2f3197..006800365f 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,61 +1,93 @@ - - -[Home](index.html) > @datadog/browser-logs > LoggerConfiguration - -## LoggerConfiguration interface - -**Signature:** - -```typescript -export interface LoggerConfiguration -``` - -## Properties - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
context? - - - -object - - - -_(Optional)_ - -
handler? - - - -HandlerType \| HandlerType\[\] - - - -_(Optional)_ - -
level? - -StatusType - -_(Optional)_ - -
+ + +Home > @datadog/browser-logs > LoggerConfiguration + +## LoggerConfiguration interface + +**Signature:** + +```typescript +export interface LoggerConfiguration +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +context? + + + + + + + +object + + + + +_(Optional)_ + + +
+ +handler? + + + + + + + +HandlerType \| HandlerType\[\] + + + + +_(Optional)_ + + +
+ +level? + + + + + + + +StatusType + + + + +_(Optional)_ + + +
diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index ff55b34c48..9261e9daad 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > application_id - -## LogsEvent.application_id property - -UUID of the application - -**Signature:** - -```typescript -application_id?: string; -``` + + +Home > @datadog/browser-logs > LogsEvent > application\_id + +## LogsEvent.application\_id property + +UUID of the application + +**Signature:** + +```typescript +application_id?: string; +``` diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index c6c14da41f..3d8471ead7 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > date - -## LogsEvent.date property - -Start of the log in ms from epoch - -**Signature:** - -```typescript -date: number -``` + + +Home > @datadog/browser-logs > LogsEvent > date + +## LogsEvent.date property + +Start of the log in ms from epoch + +**Signature:** + +```typescript +date: number; +``` diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index c7230046ce..c06c412cf0 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,25 +1,25 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > error - -## LogsEvent.error property - -Error properties - -**Signature:** - -```typescript -error?: { - kind?: string; - stack?: string; - fingerprint?: string; - message?: string; - causes?: Array<{ - message: string; - source: string; - type?: string; - stack?: string; - }>; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-logs > LogsEvent > error + +## LogsEvent.error property + +Error properties + +**Signature:** + +```typescript +error?: { + kind?: string; + stack?: string; + fingerprint?: string; + message?: string; + causes?: Array<{ + message: string; + source: string; + type?: string; + stack?: string; + }>; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 9e8787d7ae..0c797a0d8b 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > http - -## LogsEvent.http property - -Resource properties of the error - -**Signature:** - -```typescript -http?: { - method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; - status_code: number; - url: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-logs > LogsEvent > http + +## LogsEvent.http property + +Resource properties of the error + +**Signature:** + +```typescript +http?: { + method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; + status_code: number; + url: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 6886141dbb..56883d5c09 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > logger - -## LogsEvent.logger property - -Logger properties - -**Signature:** - -```typescript -logger?: { - name: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-logs > LogsEvent > logger + +## LogsEvent.logger property + +Logger properties + +**Signature:** + +```typescript +logger?: { + name: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 1e04fb5a0d..579f1b0f69 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,164 +1,264 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent - -## LogsEvent interface - -**Signature:** - -```typescript -export interface LogsEvent -``` - -## Properties - - - - - - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
application\_id? - - - -string - - - -_(Optional)_ UUID of the application - -
date - - - -number - - - -Start of the log in ms from epoch - -
error? - - - -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } - - - -_(Optional)_ Error properties - -
http? - - - -{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status_code: number; url: string; \[k: string\]: unknown; } - - - -_(Optional)_ Resource properties of the error - -
logger? - - - -{ name: string; \[k: string\]: unknown; } - - - -_(Optional)_ Logger properties - -
message - - - -string - - - -The log message - -
origin - - - -'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' - - - -Origin of the log - -
service? - - - -string - - - -_(Optional)_ The service name - -
session\_id? - - - -string - - - -_(Optional)_ UUID of the session (deprecated in favor of session.id) - -
session? - - - -{ id?: string; \[k: string\]: unknown; } - - - -_(Optional)_ Session properties - -
status - - - -'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' - - - -The log status - -
view - - - -{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } - - - -View properties - -
+ + +Home > @datadog/browser-logs > LogsEvent + +## LogsEvent interface + +**Signature:** + +```typescript +export interface LogsEvent +``` + +## Properties + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +application\_id? + + + + + + + +string + + + + +_(Optional)_ UUID of the application + + +
+ +date + + + + + + + +number + + + + +Start of the log in ms from epoch + + +
+ +error? + + + + + + + +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } + + + + +_(Optional)_ Error properties + + +
+ +http? + + + + + + + +{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Resource properties of the error + + +
+ +logger? + + + + + + + +{ name: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Logger properties + + +
+ +message + + + + + + + +string + + + + +The log message + + +
+ +origin + + + + + + + +'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' + + + + +Origin of the log + + +
+ +service? + + + + + + + +string + + + + +_(Optional)_ The service name + + +
+ +session\_id? + + + + + + + +string + + + + +_(Optional)_ UUID of the session (deprecated in favor of session.id) + + +
+ +session? + + + + + + + +{ id?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Session properties + + +
+ +status + + + + + + + +'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' + + + + +The log status + + +
+ +view + + + + + + + +{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } + + + + +View properties + + +
diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 394350ea5c..bb21c2541e 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > message - -## LogsEvent.message property - -The log message - -**Signature:** - -```typescript -message: string -``` + + +Home > @datadog/browser-logs > LogsEvent > message + +## LogsEvent.message property + +The log message + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index cd278a0140..b540f3d07b 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > origin - -## LogsEvent.origin property - -Origin of the log - -**Signature:** - -```typescript -origin: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'report' -``` + + +Home > @datadog/browser-logs > LogsEvent > origin + +## LogsEvent.origin property + +Origin of the log + +**Signature:** + +```typescript +origin: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'; +``` diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index fadcffe6f2..b916022ddc 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > service - -## LogsEvent.service property - -The service name - -**Signature:** - -```typescript -service?: string; -``` + + +Home > @datadog/browser-logs > LogsEvent > service + +## LogsEvent.service property + +The service name + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 1c2c52875e..72ff086047 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > session - -## LogsEvent.session property - -Session properties - -**Signature:** - -```typescript -session?: { - id?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-logs > LogsEvent > session + +## LogsEvent.session property + +Session properties + +**Signature:** + +```typescript +session?: { + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index b4670e9984..0c6edd6078 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > session_id - -## LogsEvent.session_id property - -UUID of the session (deprecated in favor of session.id) - -**Signature:** - -```typescript -session_id?: string; -``` + + +Home > @datadog/browser-logs > LogsEvent > session\_id + +## LogsEvent.session\_id property + +UUID of the session (deprecated in favor of session.id) + +**Signature:** + +```typescript +session_id?: string; +``` diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 13ba53044d..14e90a397e 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > status - -## LogsEvent.status property - -The log status - -**Signature:** - -```typescript -status: 'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg' -``` + + +Home > @datadog/browser-logs > LogsEvent > status + +## LogsEvent.status property + +The log status + +**Signature:** + +```typescript +status: 'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'; +``` diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 99247cb077..bf758a7694 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEvent > view - -## LogsEvent.view property - -View properties - -**Signature:** - -```typescript -view: { - referrer?: string; - url: string; - id?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-logs > LogsEvent > view + +## LogsEvent.view property + +View properties + +**Signature:** + +```typescript +view: { + referrer?: string; + url: string; + id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index bf864623bc..3ee14e37a8 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,17 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsEventDomainContext - -## LogsEventDomainContext type - -**Signature:** - -```typescript -export type LogsEventDomainContext = T extends typeof ErrorSource.NETWORK - ? NetworkLogsEventDomainContext - : T extends typeof ErrorSource.CONSOLE - ? ConsoleLogsEventDomainContext - : T extends typeof ErrorSource.LOGGER - ? LoggerLogsEventDomainContext - : never -``` + + +Home > @datadog/browser-logs > LogsEventDomainContext + +## LogsEventDomainContext type + +**Signature:** + +```typescript +export type LogsEventDomainContext = T extends typeof ErrorSource.NETWORK ? NetworkLogsEventDomainContext : T extends typeof ErrorSource.CONSOLE ? ConsoleLogsEventDomainContext : T extends typeof ErrorSource.LOGGER ? LoggerLogsEventDomainContext : never; +``` diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index e5ef238851..d73c20c261 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearAccount - -## LogsGlobal.clearAccount property - -Clear all account information - -**Signature:** - -```typescript -clearAccount: () => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > clearAccount + +## LogsGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index 1e923365f3..f9cd6cfc9b 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearGlobalContext - -## LogsGlobal.clearGlobalContext property - -Clear the global context - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -clearGlobalContext: () => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext + +## LogsGlobal.clearGlobalContext property + +Clear the global context + +See \Overwrite context\ for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 85fe0e263a..27f4dcc96f 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > clearUser - -## LogsGlobal.clearUser property - -Clear all user information - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -clearUser: () => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > clearUser + +## LogsGlobal.clearUser property + +Clear all user information + +See \User context\ for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 13dc1bd145..886a7149f9 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > createLogger - -## LogsGlobal.createLogger property - -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. - -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. - -**Signature:** - -```typescript -createLogger: (name: string, conf?: LoggerConfiguration) => Logger -``` + + +Home > @datadog/browser-logs > LogsGlobal > createLogger + +## LogsGlobal.createLogger property + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \Define multiple loggers\ for further information. + +**Signature:** + +```typescript +createLogger: (name: string, conf?: LoggerConfiguration) => Logger; +``` diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 3b3e786884..fe5af94145 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getAccount - -## LogsGlobal.getAccount property - -Get account information - -**Signature:** - -```typescript -getAccount: () => Context -``` + + +Home > @datadog/browser-logs > LogsGlobal > getAccount + +## LogsGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context; +``` diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index c46b41ee12..a0c80f58dc 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getGlobalContext - -## LogsGlobal.getGlobalContext property - -Get the global Context - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -getGlobalContext: () => Context -``` + + +Home > @datadog/browser-logs > LogsGlobal > getGlobalContext + +## LogsGlobal.getGlobalContext property + +Get the global Context + +See \Overwrite context\ for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context; +``` diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index 2e5f481305..16c0a8f987 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInitConfiguration - -## LogsGlobal.getInitConfiguration property - -Get the init configuration - -**Signature:** - -```typescript -getInitConfiguration: () => LogsInitConfiguration | undefined -``` + + +Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration + +## LogsGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => LogsInitConfiguration | undefined; +``` diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index 2da6711fa1..c11193b734 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getInternalContext - -## LogsGlobal.getInternalContext property - -\[Internal API\] Get the internal SDK context - -See \[Access internal context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#access-internal-context) for further information. - -**Signature:** - -```typescript -getInternalContext: (startTime?: number) => InternalContext | undefined -``` + + +Home > @datadog/browser-logs > LogsGlobal > getInternalContext + +## LogsGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +See \Access internal context\ for further information. + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined; +``` diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 514f8a3a96..1ec13e743e 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getLogger - -## LogsGlobal.getLogger property - -Get a logger - -See \[Define multiple loggers\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#define-multiple-loggers) for further information. - -**Signature:** - -```typescript -getLogger: (name: string) => Logger | undefined -``` + + +Home > @datadog/browser-logs > LogsGlobal > getLogger + +## LogsGlobal.getLogger property + +Get a logger + +See \Define multiple loggers\ for further information. + +**Signature:** + +```typescript +getLogger: (name: string) => Logger | undefined; +``` diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index be59a26aeb..ef646069e3 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > getUser - -## LogsGlobal.getUser property - -Get user information - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -getUser: () => Context -``` + + +Home > @datadog/browser-logs > LogsGlobal > getUser + +## LogsGlobal.getUser property + +Get user information + +See \User context\ for further information. + +**Signature:** + +```typescript +getUser: () => Context; +``` diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 4834422baf..21fadf7a49 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > init - -## LogsGlobal.init property - -Init the Logs browser SDK. - -**Signature:** - -```typescript -init: (initConfiguration: LogsInitConfiguration) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > init + +## LogsGlobal.init property + +Init the Logs browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: LogsInitConfiguration) => void; +``` diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index 374867635c..58b9668092 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > logger - -## LogsGlobal.logger property - -**Signature:** - -```typescript -logger: Logger -``` + + +Home > @datadog/browser-logs > LogsGlobal > logger + +## LogsGlobal.logger property + +**Signature:** + +```typescript +logger: Logger; +``` diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 805b2748b5..f76d7a73fe 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,302 +1,491 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal - -## LogsGlobal interface - -**Signature:** - -```typescript -export interface LogsPublicApi extends PublicApi -``` - -**Extends:** PublicApi - -## Properties - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
clearAccount - - - -() => void - - - -Clear all account information - -
clearGlobalContext - - - -() => void - - - -Clear the global context - -See \Overwrite context\ for further information. - -
clearUser - - - -() => void - - - -Clear all user information - -See \User context\ for further information. - -
createLogger - - - -(name: string, conf?: LoggerConfiguration) => Logger - - - -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. - -See \Define multiple loggers\ for further information. - -
getAccount - - - -() => Context - - - -Get account information - -
getGlobalContext - - - -() => Context - - - -Get the global Context - -See \Overwrite context\ for further information. - -
getInitConfiguration - - - -() => LogsInitConfiguration \| undefined - - - -Get the init configuration - -
getInternalContext - - - -(startTime?: number) => InternalContext \| undefined - - - -\[Internal API\] Get the internal SDK context - -See \Access internal context\ for further information. - -
getLogger - - - -(name: string) => Logger \| undefined - - - -Get a logger - -See \Define multiple loggers\ for further information. - -
getUser - - - -() => Context - - - -Get user information - -See \User context\ for further information. - -
init - - - -(initConfiguration: LogsInitConfiguration) => void - - - -Init the Logs browser SDK. - -
logger - -Logger - -
removeAccountProperty - - - -(key: string) => void - - - -Remove an account property - -
removeGlobalContextProperty - - - -(key: any) => void - - - -Remove a global context property - -See \Overwrite context\ for further information. - -
removeUserProperty - - - -(key: any) => void - - - -Remove a user property - -See \User context\ for further information. - -
setAccount - - - -(newAccount: Account) => void - - - -Set account information to all events, stored in `@account` - -
setAccountProperty - - - -(key: string, property: any) => void - - - -Set or update the account property, stored in `@account.` - -
setGlobalContext - - - -(context: any) => void - - - -Set the global context information to all logs, stored in `@context` - -
setGlobalContextProperty - - - -(key: any, value: any) => void - - - -Set or update a global context property, stored in `@context.` - -
setTrackingConsent - - - -(trackingConsent: TrackingConsent) => void - - - -Set the tracking consent of the current user. - -
setUserProperty - - - -(key: any, property: any) => void - - - -Set or update the user property, stored in `@usr.` - -
- -## Methods - - - - -
- -Method - - - -Description - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -See \User context\ for further information. - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -
+ + +Home > @datadog/browser-logs > LogsGlobal + +## LogsGlobal interface + +**Signature:** + +```typescript +export interface LogsPublicApi extends PublicApi +``` +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +clearAccount + + + + + + + +() => void + + + + +Clear all account information + + +
+ +clearGlobalContext + + + + + + + +() => void + + + + +Clear the global context + +See \Overwrite context\ for further information. + + +
+ +clearUser + + + + + + + +() => void + + + + +Clear all user information + +See \User context\ for further information. + + +
+ +createLogger + + + + + + + +(name: string, conf?: LoggerConfiguration) => Logger + + + + +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. + +See \Define multiple loggers\ for further information. + + +
+ +getAccount + + + + + + + +() => Context + + + + +Get account information + + +
+ +getGlobalContext + + + + + + + +() => Context + + + + +Get the global Context + +See \Overwrite context\ for further information. + + +
+ +getInitConfiguration + + + + + + + +() => LogsInitConfiguration \| undefined + + + + +Get the init configuration + + +
+ +getInternalContext + + + + + + + +(startTime?: number) => InternalContext \| undefined + + + + +\[Internal API\] Get the internal SDK context + +See \Access internal context\ for further information. + + +
+ +getLogger + + + + + + + +(name: string) => Logger \| undefined + + + + +Get a logger + +See \Define multiple loggers\ for further information. + + +
+ +getUser + + + + + + + +() => Context + + + + +Get user information + +See \User context\ for further information. + + +
+ +init + + + + + + + +(initConfiguration: LogsInitConfiguration) => void + + + + +Init the Logs browser SDK. + + +
+ +logger + + + + + + + +Logger + + + + + +
+ +removeAccountProperty + + + + + + + +(key: string) => void + + + + +Remove an account property + + +
+ +removeGlobalContextProperty + + + + + + + +(key: any) => void + + + + +Remove a global context property + +See \Overwrite context\ for further information. + + +
+ +removeUserProperty + + + + + + + +(key: any) => void + + + + +Remove a user property + +See \User context\ for further information. + + +
+ +setAccount + + + + + + + +(newAccount: Account) => void + + + + +Set account information to all events, stored in `@account` + + +
+ +setAccountProperty + + + + + + + +(key: string, property: any) => void + + + + +Set or update the account property, stored in `@account.` + + +
+ +setGlobalContext + + + + + + + +(context: any) => void + + + + +Set the global context information to all logs, stored in `@context` + + +
+ +setGlobalContextProperty + + + + + + + +(key: any, value: any) => void + + + + +Set or update a global context property, stored in `@context.` + + +
+ +setTrackingConsent + + + + + + + +(trackingConsent: TrackingConsent) => void + + + + +Set the tracking consent of the current user. + + +
+ +setUserProperty + + + + + + + +(key: any, property: any) => void + + + + +Set or update the user property, stored in `@usr.` + + +
+ +## Methods + + + + +
+ +Method + + + + +Description + + +
+ +setUser(newUser) + + + + +Set user information to all events, stored in `@usr` + +See \User context\ for further information. + + +
+ +setUser(newUser) + + + + +Set user information to all events, stored in `@usr` + + +
diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 336adac0f0..1706fe791e 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeAccountProperty - -## LogsGlobal.removeAccountProperty property - -Remove an account property - -**Signature:** - -```typescript -removeAccountProperty: (key: string) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty + +## LogsGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index e66f48c9eb..7670a8c693 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty - -## LogsGlobal.removeGlobalContextProperty property - -Remove a global context property - -See \[Overwrite context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#overwrite-context) for further information. - -**Signature:** - -```typescript -removeGlobalContextProperty: (key: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty + +## LogsGlobal.removeGlobalContextProperty property + +Remove a global context property + +See \Overwrite context\ for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 9c4eed3047..6e3c9bb5fd 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > removeUserProperty - -## LogsGlobal.removeUserProperty property - -Remove a user property - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -removeUserProperty: (key: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > removeUserProperty + +## LogsGlobal.removeUserProperty property + +Remove a user property + +See \User context\ for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index 45780ca434..1a5232dbea 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccount - -## LogsGlobal.setAccount property - -Set account information to all events, stored in `@account` - -**Signature:** - -```typescript -setAccount: (newAccount: Account) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setAccount + +## LogsGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 7e7138eab8..e658f2ce11 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setAccountProperty - -## LogsGlobal.setAccountProperty property - -Set or update the account property, stored in `@account.` - -**Signature:** - -```typescript -setAccountProperty: (key: string, property: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setAccountProperty + +## LogsGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index 5a51722e54..aee7cd9b75 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContext - -## LogsGlobal.setGlobalContext property - -Set the global context information to all logs, stored in `@context` - -**Signature:** - -```typescript -setGlobalContext: (context: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setGlobalContext + +## LogsGlobal.setGlobalContext property + +Set the global context information to all logs, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index e4279fcad9..46c9281012 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty - -## LogsGlobal.setGlobalContextProperty property - -Set or update a global context property, stored in `@context.` - -**Signature:** - -```typescript -setGlobalContextProperty: (key: any, value: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty + +## LogsGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index c41b0f6b44..9958bed2e3 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setTrackingConsent - -## LogsGlobal.setTrackingConsent property - -Set the tracking consent of the current user. - -**Signature:** - -```typescript -setTrackingConsent: (trackingConsent: TrackingConsent) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent + +## LogsGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 48ec0e1813..5a6beb0b32 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,48 +1,55 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser - -## LogsGlobal.setUser() method - -Set user information to all events, stored in `@usr` - -See \[User context\](https://docs.datadoghq.com/logs/log\_collection/javascript/\#user-context) for further information. - -**Signature:** - -```typescript -setUser(newUser: User & { - id: string; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -newUser - - - -User & { id: string; } - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > LogsGlobal > setUser + +## LogsGlobal.setUser() method + +Set user information to all events, stored in `@usr` + +See \User context\ for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User & { id: string; } + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 2ca5fe9992..1c87632aed 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,48 +1,56 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUser - -## LogsGlobal.setUser() method - -> Warning: This API is now obsolete. -> -> You must specified a user id - -Set user information to all events, stored in `@usr` - -**Signature:** - -```typescript -setUser(newUser: User): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -newUser - - - -User - - - -
-**Returns:** - -void + + +Home > @datadog/browser-logs > LogsGlobal > setUser + +## LogsGlobal.setUser() method + +> Warning: This API is now obsolete. +> +> You must specified a user id +> + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 6c59cd2ead..1e10329f16 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsGlobal > setUserProperty - -## LogsGlobal.setUserProperty property - -Set or update the user property, stored in `@usr.` - -**Signature:** - -```typescript -setUserProperty: (key: any, property: any) => void; -``` + + +Home > @datadog/browser-logs > LogsGlobal > setUserProperty + +## LogsGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index bdfd08cb5e..6e523e11c1 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > beforeSend - -## LogsInitConfiguration.beforeSend property - -Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs - -**Signature:** - -```typescript -beforeSend?: ((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined; -``` + + +Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend + +## LogsInitConfiguration.beforeSend property + +Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + +**Signature:** + +```typescript +beforeSend?: ((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index b63fd5e735..01eedfe33d 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs - -## LogsInitConfiguration.forwardConsoleLogs property - -Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. - -**Signature:** - -```typescript -forwardConsoleLogs?: ConsoleApiName[] | 'all' | undefined; -``` + + +Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs + +## LogsInitConfiguration.forwardConsoleLogs property + +Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + +**Signature:** + +```typescript +forwardConsoleLogs?: ConsoleApiName[] | 'all' | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index 5e6f514f59..e4cafecbe8 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs - -## LogsInitConfiguration.forwardErrorsToLogs property - -Forward console.error logs, uncaught exceptions and network errors to Datadog. true - -**Signature:** - -```typescript -forwardErrorsToLogs?: boolean | undefined; -``` + + +Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs + +## LogsInitConfiguration.forwardErrorsToLogs property + +Forward console.error logs, uncaught exceptions and network errors to Datadog. true + +**Signature:** + +```typescript +forwardErrorsToLogs?: boolean | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index ccda58a9ee..c33f30b5f5 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > forwardReports - -## LogsInitConfiguration.forwardReports property - -Forward reports from the \[Reporting API\](https://developer.mozilla.org/en-US/docs/Web/API/Reporting\_API) to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. - -**Signature:** - -```typescript -forwardReports?: RawReportType[] | 'all' | undefined; -``` + + +Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports + +## LogsInitConfiguration.forwardReports property + +Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + +**Signature:** + +```typescript +forwardReports?: RawReportType[] | 'all' | undefined; +``` diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 9f80ee9d1b..23b0b6623c 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,89 +1,132 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration - -## LogsInitConfiguration interface - -**Signature:** - -```typescript -export interface LogsInitConfiguration extends InitConfiguration -``` - -**Extends:** InitConfiguration - -## Properties - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
beforeSend? - - - -((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined - - - -_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs - -
forwardConsoleLogs? - - - -ConsoleApiName\[\] \| 'all' \| undefined - - - -_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. - -
forwardErrorsToLogs? - - - -boolean \| undefined - - - -_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true - -
forwardReports? - - - -RawReportType\[\] \| 'all' \| undefined - - - -_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. - -
usePciIntake? - - - -boolean - - - -_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false - -
+ + +Home > @datadog/browser-logs > LogsInitConfiguration + +## LogsInitConfiguration interface + +**Signature:** + +```typescript +export interface LogsInitConfiguration extends InitConfiguration +``` +**Extends:** InitConfiguration + +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +beforeSend? + + + + + + + +((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined + + + + +_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs + + +
+ +forwardConsoleLogs? + + + + + + + +ConsoleApiName\[\] \| 'all' \| undefined + + + + +_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. + + +
+ +forwardErrorsToLogs? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true + + +
+ +forwardReports? + + + + + + + +RawReportType\[\] \| 'all' \| undefined + + + + +_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. + + +
+ +usePciIntake? + + + + + + + +boolean + + + + +_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false + + +
diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 4c00abf6b6..bd78ec2da1 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsInitConfiguration > usePciIntake - -## LogsInitConfiguration.usePciIntake property - -Use PCI-compliant intake. See \[PCI DSS Compliance\](https://docs.datadoghq.com/data\_security/pci\_compliance/?tab=logmanagement) for further information. false - -**Signature:** - -```typescript -usePciIntake?: boolean; -``` + + +Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake + +## LogsInitConfiguration.usePciIntake property + +Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false + +**Signature:** + +```typescript +usePciIntake?: boolean; +``` diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 926644aa85..15adad9cb6 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > context - -## LogsMessage.context property - -**Signature:** - -```typescript -context?: Context; -``` + + +Home > @datadog/browser-logs > LogsMessage > context + +## LogsMessage.context property + +**Signature:** + +```typescript +context?: Context; +``` diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 3912103932..254f159c1f 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,57 +1,89 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage - -## LogsMessage interface - -**Signature:** - -```typescript -export interface LogsMessage -``` - -## Properties - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
context? - - - -Context - - - -_(Optional)_ - -
message - - - -string - - - -
status - -StatusType - -
+ + +Home > @datadog/browser-logs > LogsMessage + +## LogsMessage interface + +**Signature:** + +```typescript +export interface LogsMessage +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +context? + + + + + + + +Context + + + + +_(Optional)_ + + +
+ +message + + + + + + + +string + + + + + +
+ +status + + + + + + + +StatusType + + + + + +
diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index 64ed2030f4..b94a52709a 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > message - -## LogsMessage.message property - -**Signature:** - -```typescript -message: string -``` + + +Home > @datadog/browser-logs > LogsMessage > message + +## LogsMessage.message property + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 28bee3738c..78ea723cdc 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-logs > LogsMessage > status - -## LogsMessage.status property - -**Signature:** - -```typescript -status: StatusType -``` + + +Home > @datadog/browser-logs > LogsMessage > status + +## LogsMessage.status property + +**Signature:** + +```typescript +status: StatusType; +``` diff --git a/docs/browser-logs.md b/docs/browser-logs.md index e920036754..472d8ec0bd 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,96 +1,182 @@ - - -[Home](index.html) > @datadog/browser-logs - -## browser-logs package - -## Classes - - - -
- -Class - - - -Description - -
Logger - -
- -## Interfaces - - - - - - - - -
- -Interface - - - -Description - -
Logger - -
LoggerConfiguration - -
LogsEvent - -
LogsGlobal - -
LogsInitConfiguration - -
LogsMessage - -
- -## Variables - - - - - -
- -Variable - - - -Description - -
datadogLogs - -
HandlerType - -
StatusType - -
- -## Type Aliases - - - - - -
- -Type Alias - - - -Description - -
HandlerType - -
LogsEventDomainContext - -
StatusType - -
+ + +Home > @datadog/browser-logs + +## browser-logs package + +## Classes + + + +
+ +Class + + + + +Description + + +
+ +Logger + + + + + +
+ +## Interfaces + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +Logger + + + + + +
+ +LoggerConfiguration + + + + + +
+ +LogsEvent + + + + + +
+ +LogsGlobal + + + + + +
+ +LogsInitConfiguration + + + + + +
+ +LogsMessage + + + + + +
+ +## Variables + + + + + +
+ +Variable + + + + +Description + + +
+ +datadogLogs + + + + + +
+ +HandlerType + + + + + +
+ +StatusType + + + + + +
+ +## Type Aliases + + + + + +
+ +Type Alias + + + + +Description + + +
+ +HandlerType + + + + + +
+ +LogsEventDomainContext + + + + + +
+ +StatusType + + + + + +
diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index ced0e4f566..7698dc1187 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,21 +1,21 @@ - - -[Home](index.html) > @datadog/browser-logs > StatusType - -## StatusType variable - -**Signature:** - -```typescript -StatusType: { - readonly ok: "ok"; - readonly debug: "debug"; - readonly info: "info"; - readonly notice: "notice"; - readonly warn: "warn"; - readonly error: "error"; - readonly critical: "critical"; - readonly alert: "alert"; - readonly emerg: "emerg"; -} -``` + + +Home > @datadog/browser-logs > StatusType + +## StatusType variable + +**Signature:** + +```typescript +StatusType: { + readonly ok: "ok"; + readonly debug: "debug"; + readonly info: "info"; + readonly notice: "notice"; + readonly warn: "warn"; + readonly error: "error"; + readonly critical: "critical"; + readonly alert: "alert"; + readonly emerg: "emerg"; +} +``` diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 306b76d171..2ae450fab9 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,53 +1,63 @@ - - -[Home](index.html) > @datadog/browser-rum-react > addReactError - -## addReactError() function - -**Signature:** - -```typescript -export declare function addReactError(error: Error, info: ErrorInfo): void -``` - -## Parameters - - - - -
- -Parameter - - - -Type - - - -Description - -
- -error - - - -Error - - - -
- -info - - - -ErrorInfo - - - -
-**Returns:** - -void + + +Home > @datadog/browser-rum-react > addReactError + +## addReactError() function + +**Signature:** + +```typescript +export declare function addReactError(error: Error, info: ErrorInfo): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+ +info + + + + +ErrorInfo + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index ad92d3680c..89fff592a8 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,41 +1,47 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > (constructor) - -## ErrorBoundary.(constructor) - -Constructs a new instance of the `ErrorBoundary` class - -**Signature:** - -```typescript -constructor(props: Props); -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -props - - - -Props - - - -
+ + +Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) + +## ErrorBoundary.(constructor) + +Constructs a new instance of the `ErrorBoundary` class + +**Signature:** + +```typescript +constructor(props: Props); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +props + + + + +Props + + + + + +
diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 4bf2efd602..5ae66f905d 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,53 +1,63 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch - -## ErrorBoundary.componentDidCatch() method - -**Signature:** - -```typescript -componentDidCatch(error: Error, errorInfo: ErrorInfo): void; -``` - -## Parameters - - - - -
- -Parameter - - - -Type - - - -Description - -
- -error - - - -Error - - - -
- -errorInfo - - - -ErrorInfo - - - -
-**Returns:** - -void + + +Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch + +## ErrorBoundary.componentDidCatch() method + +**Signature:** + +```typescript +componentDidCatch(error: Error, errorInfo: ErrorInfo): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+ +errorInfo + + + + +ErrorInfo + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index dc80c95051..28210d9f52 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,42 +1,49 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError - -## ErrorBoundary.getDerivedStateFromError() method - -**Signature:** - -```typescript -static getDerivedStateFromError(error: Error): State; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -error - - - -Error - - - -
-**Returns:** - -State + + +Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError + +## ErrorBoundary.getDerivedStateFromError() method + +**Signature:** + +```typescript +static getDerivedStateFromError(error: Error): State; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +error + + + + +Error + + + + + +
+**Returns:** + +State + diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 695eccac12..98c80e9daf 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,101 +1,146 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary - -## ErrorBoundary class - -**Signature:** - -```typescript -export declare class ErrorBoundary extends React.Component -``` - -**Extends:** React.Component<Props, State> - -## Constructors - - - -
- -Constructor - - - -Modifiers - - - -Description - -
(constructor)(props) - - - -Constructs a new instance of the `ErrorBoundary` class - -
- -## Properties - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
resetError - - - -() => void - - - -
- -## Methods - - - - - -
- -Method - - - -Modifiers - - - -Description - -
componentDidCatch(error, errorInfo) - - - -
getDerivedStateFromError(error) - -`static` - - - -
render() - - - -
+ + +Home > @datadog/browser-rum-react > ErrorBoundary + +## ErrorBoundary class + +**Signature:** + +```typescript +export declare class ErrorBoundary extends React.Component +``` +**Extends:** React.Component<Props, State> + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +(constructor)(props) + + + + + + + +Constructs a new instance of the `ErrorBoundary` class + + +
+ +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +resetError + + + + + + + +() => void + + + + + +
+ +## Methods + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +componentDidCatch(error, errorInfo) + + + + + + + + +
+ +getDerivedStateFromError(error) + + + + +`static` + + + + + +
+ +render() + + + + + + + + +
diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 5f8a55e0d8..8e2c22cda1 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > render - -## ErrorBoundary.render() method - -**Signature:** - -```typescript -render(): React.ReactNode; -``` - -**Returns:** - -React.ReactNode + + +Home > @datadog/browser-rum-react > ErrorBoundary > render + +## ErrorBoundary.render() method + +**Signature:** + +```typescript +render(): React.ReactNode; +``` +**Returns:** + +React.ReactNode + diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 9d36964745..c363ca6988 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum-react > ErrorBoundary > resetError - -## ErrorBoundary.resetError property - -**Signature:** - -```typescript -resetError: () => void; -``` + + +Home > @datadog/browser-rum-react > ErrorBoundary > resetError + +## ErrorBoundary.resetError property + +**Signature:** + +```typescript +resetError: () => void; +``` diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index e70a74520d..e15d537b12 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,56 +1,86 @@ - - -[Home](index.html) > @datadog/browser-rum-react - -## browser-rum-react package - -## Classes - - - -
- -Class - - - -Description - -
ErrorBoundary - -
- -## Functions - - - - -
- -Function - - - -Description - -
addReactError(error, info) - -
reactPlugin(configuration) - -
- -## Variables - - - -
- -Variable - - - -Description - -
UNSTABLE\_ReactComponentTracker - -
+ + +Home > @datadog/browser-rum-react + +## browser-rum-react package + +## Classes + + + +
+ +Class + + + + +Description + + +
+ +ErrorBoundary + + + + + +
+ +## Functions + + + + +
+ +Function + + + + +Description + + +
+ +addReactError(error, info) + + + + + +
+ +reactPlugin(configuration) + + + + + +
+ +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +UNSTABLE\_ReactComponentTracker + + + + + +
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index abeb4849f9..effb9fb661 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,57 +1,63 @@ - - -[Home](index.html) > @datadog/browser-rum-react > reactPlugin - -## reactPlugin() function - -**Signature:** - -```typescript -export declare function reactPlugin(configuration?: ReactPluginConfiguration): { - name: string - onInit({ - publicApi, - initConfiguration, - }: { - initConfiguration: import('@datadog/browser-rum-core').RumInitConfiguration - publicApi: RumPublicApi - }): void - onRumStart({ strategy }: { strategy: Strategy }): void - getConfigurationTelemetry(): { - router: boolean - } -} -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -configuration - - - -ReactPluginConfiguration - - - -_(Optional)_ - -
-**Returns:** - -{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } + + +Home > @datadog/browser-rum-react > reactPlugin + +## reactPlugin() function + +**Signature:** + +```typescript +export declare function reactPlugin(configuration?: ReactPluginConfiguration): { + name: string; + onInit({ publicApi, initConfiguration }: { + initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; + publicApi: RumPublicApi; + }): void; + onRumStart({ strategy }: { + strategy: Strategy; + }): void; + getConfigurationTelemetry(): { + router: boolean; + }; +}; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +configuration + + + + +ReactPluginConfiguration + + + + +_(Optional)_ + + +
+**Returns:** + +{ name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } + diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 20e3bf8667..05909fb074 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,12 +1,14 @@ - - -[Home](index.html) > @datadog/browser-rum-react > UNSTABLE_ReactComponentTracker - -## UNSTABLE_ReactComponentTracker variable - -**Signature:** - -```typescript -UNSTABLE_ReactComponentTracker: ({ name: componentName, children }: { name: string; children?: React.ReactNode }) => - React.JSX.Element -``` + + +Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker + +## UNSTABLE\_ReactComponentTracker variable + +**Signature:** + +```typescript +UNSTABLE_ReactComponentTracker: ({ name: componentName, children, }: { + name: string; + children?: React.ReactNode; +}) => React.JSX.Element +``` diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index a4075adcf4..b8b3762af6 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum-slim > datadogRum - -## datadogRum variable - -**Signature:** - -```typescript -datadogRum: RumPublicApi -``` + + +Home > @datadog/browser-rum-slim > datadogRum + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index 5bea49891a..d699654061 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,21 +1,29 @@ - - -[Home](index.html) > @datadog/browser-rum-slim - -## browser-rum-slim package - -## Variables - - - -
- -Variable - - - -Description - -
datadogRum - -
+ + +Home > @datadog/browser-rum-slim + +## browser-rum-slim package + +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +datadogRum + + + + + +
diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 9d402cac58..88e2b89143 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,27 +1,27 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > \_dd - -## CommonProperties.\_dd property - -Internal properties - -**Signature:** - -```typescript -readonly _dd: { - readonly format_version: 2; - session?: { - plan?: 1 | 2; - readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; - [k: string]: unknown; - }; - readonly configuration?: { - readonly session_sample_rate: number; - readonly session_replay_sample_rate?: number; - [k: string]: unknown; - }; - readonly browser_sdk_version?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > \_dd + +## CommonProperties.\_dd property + +Internal properties + +**Signature:** + +```typescript +readonly _dd: { + readonly format_version: 2; + session?: { + plan?: 1 | 2; + readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; + [k: string]: unknown; + }; + readonly configuration?: { + readonly session_sample_rate: number; + readonly session_replay_sample_rate?: number; + [k: string]: unknown; + }; + readonly browser_sdk_version?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index dd7e7293af..057fb13130 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,17 +1,17 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > account - -## CommonProperties.account property - -Account properties - -**Signature:** - -```typescript -readonly account?: { - readonly id: string; - readonly name?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > account + +## CommonProperties.account property + +Account properties + +**Signature:** + +```typescript +readonly account?: { + readonly id: string; + readonly name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index 501cfa5b51..14c3639fd1 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > application - -## CommonProperties.application property - -Application properties - -**Signature:** - -```typescript -readonly application: { - readonly id: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > application + +## CommonProperties.application property + +Application properties + +**Signature:** + +```typescript +readonly application: { + readonly id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 9194faf7df..6b682f2f66 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > build_id - -## CommonProperties.build_id property - -Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. - -**Signature:** - -```typescript -readonly build_id?: string; -``` + + +Home > @datadog/browser-rum > CommonProperties > build\_id + +## CommonProperties.build\_id property + +Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + +**Signature:** + +```typescript +readonly build_id?: string; +``` diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index f08912e915..61f5babab6 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > build_version - -## CommonProperties.build_version property - -The build version for this application - -**Signature:** - -```typescript -readonly build_version?: string; -``` + + +Home > @datadog/browser-rum > CommonProperties > build\_version + +## CommonProperties.build\_version property + +The build version for this application + +**Signature:** + +```typescript +readonly build_version?: string; +``` diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 07a148c533..c7d86de9b8 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > ci_test - -## CommonProperties.ci_test property - -CI Visibility properties - -**Signature:** - -```typescript -readonly ci_test?: { - readonly test_execution_id: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > ci\_test + +## CommonProperties.ci\_test property + +CI Visibility properties + +**Signature:** + +```typescript +readonly ci_test?: { + readonly test_execution_id: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index cdd6f0ddfd..cb99da984b 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,23 +1,23 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > connectivity - -## CommonProperties.connectivity property - -Device connectivity properties - -**Signature:** - -```typescript -connectivity?: { - readonly status: 'connected' | 'not_connected' | 'maybe'; - readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; - readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; - readonly cellular?: { - readonly technology?: string; - readonly carrier_name?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > connectivity + +## CommonProperties.connectivity property + +Device connectivity properties + +**Signature:** + +```typescript +connectivity?: { + readonly status: 'connected' | 'not_connected' | 'maybe'; + readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; + readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; + readonly cellular?: { + readonly technology?: string; + readonly carrier_name?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index 35fa30d973..84eea16bce 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > context - -## CommonProperties.context property - -User provided context - -**Signature:** - -```typescript -context?: { - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > context + +## CommonProperties.context property + +User provided context + +**Signature:** + +```typescript +context?: { + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index 22c58addfd..f65cd36b28 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > date - -## CommonProperties.date property - -Start of the event in ms from epoch - -**Signature:** - -```typescript -readonly date: number; -``` + + +Home > @datadog/browser-rum > CommonProperties > date + +## CommonProperties.date property + +Start of the event in ms from epoch + +**Signature:** + +```typescript +readonly date: number; +``` diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index 49d6aa0b6c..8e401ea8a1 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,20 +1,20 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > device - -## CommonProperties.device property - -Device properties - -**Signature:** - -```typescript -device?: { - readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; - readonly name?: string; - readonly model?: string; - readonly brand?: string; - readonly architecture?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > device + +## CommonProperties.device property + +Device properties + +**Signature:** + +```typescript +device?: { + readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; + readonly name?: string; + readonly model?: string; + readonly brand?: string; + readonly architecture?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 4eb03d20e5..9464a61e65 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,20 +1,20 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > display - -## CommonProperties.display property - -Display properties - -**Signature:** - -```typescript -display?: { - readonly viewport?: { - readonly width: number; - readonly height: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > display + +## CommonProperties.display property + +Display properties + +**Signature:** + +```typescript +display?: { + readonly viewport?: { + readonly width: number; + readonly height: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 05cac90147..15b05fa9f5 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,267 +1,423 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties - -## CommonProperties interface - -Schema of common properties of RUM events - -**Signature:** - -```typescript -export interface CommonProperties -``` - -## Properties - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
\_dd - -`readonly` - - - -{ readonly format_version: 2; session?: { plan?: 1 \| 2; readonly session_precondition?: 'user_app_launch' \| 'inactivity_timeout' \| 'max_duration' \| 'background_launch' \| 'prewarm' \| 'from_non_interactive_session' \| 'explicit_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; \[k: string\]: unknown; }; readonly browser_sdk_version?: string; \[k: string\]: unknown; } - - - -Internal properties - -
account? - -`readonly` - - - -{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } - - - -_(Optional)_ Account properties - -
application - -`readonly` - - - -{ readonly id: string; \[k: string\]: unknown; } - - - -Application properties - -
build\_id? - -`readonly` - - - -string - - - -_(Optional)_ Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. - -
build\_version? - -`readonly` - - - -string - - - -_(Optional)_ The build version for this application - -
ci\_test? - -`readonly` - - - -{ readonly test_execution_id: string; \[k: string\]: unknown; } - - - -_(Optional)_ CI Visibility properties - -
connectivity? - - - -{ readonly status: 'connected' \| 'not_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } - - - -_(Optional)_ Device connectivity properties - -
context? - - - -{ \[k: string\]: unknown; } - - - -_(Optional)_ User provided context - -
date - -`readonly` - - - -number - - - -Start of the event in ms from epoch - -
device? - - - -{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } - - - -_(Optional)_ Device properties - -
display? - - - -{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } - - - -_(Optional)_ Display properties - -
os? - - - -{ readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; \[k: string\]: unknown; } - - - -_(Optional)_ Operating system properties - -
service? - - - -string - - - -_(Optional)_ The service name for this application - -
session - -`readonly` - - - -{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci_test'; readonly has_replay?: boolean; \[k: string\]: unknown; } - - - -Session properties - -
source? - -`readonly` - - - -'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' - - - -_(Optional)_ The source of this event - -
synthetics? - -`readonly` - - - -{ readonly test_id: string; readonly result_id: string; readonly injected?: boolean; \[k: string\]: unknown; } - - - -_(Optional)_ Synthetics properties - -
usr? - -`readonly` - - - -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; \[k: string\]: unknown; } - - - -_(Optional)_ User properties - -
version? - - - -string - - - -_(Optional)_ The version for this application - -
view - -`readonly` - - - -{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } - - - -View properties - -
+ + +Home > @datadog/browser-rum > CommonProperties + +## CommonProperties interface + +Schema of common properties of RUM events + +**Signature:** + +```typescript +export interface CommonProperties +``` + +## Properties + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +\_dd + + + + +`readonly` + + + + +{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } + + + + +Internal properties + + +
+ +account? + + + + +`readonly` + + + + +{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Account properties + + +
+ +application + + + + +`readonly` + + + + +{ readonly id: string; \[k: string\]: unknown; } + + + + +Application properties + + +
+ +build\_id? + + + + +`readonly` + + + + +string + + + + +_(Optional)_ Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. + + +
+ +build\_version? + + + + +`readonly` + + + + +string + + + + +_(Optional)_ The build version for this application + + +
+ +ci\_test? + + + + +`readonly` + + + + +{ readonly test\_execution\_id: string; \[k: string\]: unknown; } + + + + +_(Optional)_ CI Visibility properties + + +
+ +connectivity? + + + + + + + +{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + + +_(Optional)_ Device connectivity properties + + +
+ +context? + + + + + + + +{ \[k: string\]: unknown; } + + + + +_(Optional)_ User provided context + + +
+ +date + + + + +`readonly` + + + + +number + + + + +Start of the event in ms from epoch + + +
+ +device? + + + + + + + +{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Device properties + + +
+ +display? + + + + + + + +{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } + + + + +_(Optional)_ Display properties + + +
+ +os? + + + + + + + +{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } + + + + +_(Optional)_ Operating system properties + + +
+ +service? + + + + + + + +string + + + + +_(Optional)_ The service name for this application + + +
+ +session + + + + +`readonly` + + + + +{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } + + + + +Session properties + + +
+ +source? + + + + +`readonly` + + + + +'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' + + + + +_(Optional)_ The source of this event + + +
+ +synthetics? + + + + +`readonly` + + + + +{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } + + + + +_(Optional)_ Synthetics properties + + +
+ +usr? + + + + +`readonly` + + + + +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } + + + + +_(Optional)_ User properties + + +
+ +version? + + + + + + + +string + + + + +_(Optional)_ The version for this application + + +
+ +view + + + + +`readonly` + + + + +{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } + + + + +View properties + + +
diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index c4294b5ad8..00294236b5 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > os - -## CommonProperties.os property - -Operating system properties - -**Signature:** - -```typescript -os?: { - readonly name: string; - readonly version: string; - readonly build?: string; - readonly version_major: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > os + +## CommonProperties.os property + +Operating system properties + +**Signature:** + +```typescript +os?: { + readonly name: string; + readonly version: string; + readonly build?: string; + readonly version_major: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index d7db1f5d4d..ef0953d474 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > service - -## CommonProperties.service property - -The service name for this application - -**Signature:** - -```typescript -service?: string; -``` + + +Home > @datadog/browser-rum > CommonProperties > service + +## CommonProperties.service property + +The service name for this application + +**Signature:** + +```typescript +service?: string; +``` diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index 555f71d4ae..d045a95840 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > session - -## CommonProperties.session property - -Session properties - -**Signature:** - -```typescript -readonly session: { - readonly id: string; - readonly type: 'user' | 'synthetics' | 'ci_test'; - readonly has_replay?: boolean; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > session + +## CommonProperties.session property + +Session properties + +**Signature:** + +```typescript +readonly session: { + readonly id: string; + readonly type: 'user' | 'synthetics' | 'ci_test'; + readonly has_replay?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index aed2324e5b..508696b233 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > source - -## CommonProperties.source property - -The source of this event - -**Signature:** - -```typescript -readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'; -``` + + +Home > @datadog/browser-rum > CommonProperties > source + +## CommonProperties.source property + +The source of this event + +**Signature:** + +```typescript +readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'; +``` diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 233cc3e07e..b137541474 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > synthetics - -## CommonProperties.synthetics property - -Synthetics properties - -**Signature:** - -```typescript -readonly synthetics?: { - readonly test_id: string; - readonly result_id: string; - readonly injected?: boolean; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > synthetics + +## CommonProperties.synthetics property + +Synthetics properties + +**Signature:** + +```typescript +readonly synthetics?: { + readonly test_id: string; + readonly result_id: string; + readonly injected?: boolean; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 32b980eaf8..0ae00dd0d2 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > usr - -## CommonProperties.usr property - -User properties - -**Signature:** - -```typescript -readonly usr?: { - readonly id?: string; - readonly name?: string; - readonly email?: string; - readonly anonymous_id?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > usr + +## CommonProperties.usr property + +User properties + +**Signature:** + +```typescript +readonly usr?: { + readonly id?: string; + readonly name?: string; + readonly email?: string; + readonly anonymous_id?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 512f5d693c..ca62a92935 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > version - -## CommonProperties.version property - -The version for this application - -**Signature:** - -```typescript -version?: string; -``` + + +Home > @datadog/browser-rum > CommonProperties > version + +## CommonProperties.version property + +The version for this application + +**Signature:** + +```typescript +version?: string; +``` diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index b4b2d8df5c..7318e0b8a4 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,19 +1,19 @@ - - -[Home](index.html) > @datadog/browser-rum > CommonProperties > view - -## CommonProperties.view property - -View properties - -**Signature:** - -```typescript -readonly view: { - readonly id: string; - referrer?: string; - url: string; - name?: string; - [k: string]: unknown; - }; -``` + + +Home > @datadog/browser-rum > CommonProperties > view + +## CommonProperties.view property + +View properties + +**Signature:** + +```typescript +readonly view: { + readonly id: string; + referrer?: string; + url: string; + name?: string; + [k: string]: unknown; + }; +``` diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 3377ae68e9..4565292752 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > datadogRum - -## datadogRum variable - -**Signature:** - -```typescript -datadogRum: RumPublicApi -``` + + +Home > @datadog/browser-rum > datadogRum + +## datadogRum variable + +**Signature:** + +```typescript +datadogRum: RumPublicApi +``` diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 832230798f..0b939b77ef 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,117 +1,237 @@ - - -[Home](index.html) > @datadog/browser-rum - -## browser-rum package - -## Interfaces - - - - - - - - - - - - -
- -Interface - - - -Description - -
CommonProperties - -Schema of common properties of RUM events - -
RumActionEventDomainContext - -
RumErrorEventDomainContext - -
RumFetchResourceEventDomainContext - -
RumGlobal - -
RumInitConfiguration - -
RumLongTaskEventDomainContext - -
RumOtherResourceEventDomainContext - -
RumViewEventDomainContext - -
RumXhrResourceEventDomainContext - -
- -## Variables - - - -
- -Variable - - - -Description - -
datadogRum - -
- -## Type Aliases - - - - - - - - - - -
- -Type Alias - - - -Description - -
RumActionEvent - -Schema of all properties of an Action event - -
RumErrorEvent - -Schema of all properties of an Error event - -
RumEvent - -Schema of all properties of a RUM event - -
RumEventDomainContext - -
RumLongTaskEvent - -Schema of all properties of a Long Task event - -
RumResourceEvent - -Schema of all properties of a Resource event - -
RumViewEvent - -Schema of all properties of a View event - -
RumVitalEvent - -Schema of all properties of a Vital event - -
+ + +Home > @datadog/browser-rum + +## browser-rum package + +## Interfaces + + + + + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +CommonProperties + + + + +Schema of common properties of RUM events + + +
+ +RumActionEventDomainContext + + + + + +
+ +RumErrorEventDomainContext + + + + + +
+ +RumFetchResourceEventDomainContext + + + + + +
+ +RumGlobal + + + + + +
+ +RumInitConfiguration + + + + + +
+ +RumLongTaskEventDomainContext + + + + + +
+ +RumOtherResourceEventDomainContext + + + + + +
+ +RumViewEventDomainContext + + + + + +
+ +RumXhrResourceEventDomainContext + + + + + +
+ +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +datadogRum + + + + + +
+ +## Type Aliases + + + + + + + + + + +
+ +Type Alias + + + + +Description + + +
+ +RumActionEvent + + + + +Schema of all properties of an Action event + + +
+ +RumErrorEvent + + + + +Schema of all properties of an Error event + + +
+ +RumEvent + + + + +Schema of all properties of a RUM event + + +
+ +RumEventDomainContext + + + + + +
+ +RumLongTaskEvent + + + + +Schema of all properties of a Long Task event + + +
+ +RumResourceEvent + + + + +Schema of all properties of a Resource event + + +
+ +RumViewEvent + + + + +Schema of all properties of a View event + + +
+ +RumVitalEvent + + + + +Schema of all properties of a Vital event + + +
diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 534425ff88..414ce6a0be 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,77 +1,70 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEvent - -## RumActionEvent type - -Schema of all properties of an Action event - -**Signature:** - -```typescript -export type RumActionEvent = CommonProperties & - ViewContainerSchema & { - readonly type: 'action' - readonly action: { - readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back' - readonly id?: string - readonly loading_time?: number - readonly target?: { - name: string - [k: string]: unknown - } - readonly frustration?: { - readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[] - [k: string]: unknown - } - readonly error?: { - readonly count: number - [k: string]: unknown - } - readonly crash?: { - readonly count: number - [k: string]: unknown - } - readonly long_task?: { - readonly count: number - [k: string]: unknown - } - readonly resource?: { - readonly count: number - [k: string]: unknown - } - [k: string]: unknown - } - readonly view?: { - readonly in_foreground?: boolean - [k: string]: unknown - } - _dd?: { - readonly action?: { - readonly position?: { - readonly x: number - readonly y: number - [k: string]: unknown - } - target?: { - readonly selector?: string - readonly width?: number - readonly height?: number - [k: string]: unknown - } - name_source?: - | 'custom_attribute' - | 'mask_placeholder' - | 'standard_attribute' - | 'text_content' - | 'mask_disallowed' - | 'blank' - [k: string]: unknown - } - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumActionEvent + +## RumActionEvent type + +Schema of all properties of an Action event + +**Signature:** + +```typescript +export type RumActionEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'action'; + readonly action: { + readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; + readonly id?: string; + readonly loading_time?: number; + readonly target?: { + name: string; + [k: string]: unknown; + }; + readonly frustration?: { + readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; + [k: string]: unknown; + }; + readonly error?: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly resource?: { + readonly count: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + _dd?: { + readonly action?: { + readonly position?: { + readonly x: number; + readonly y: number; + [k: string]: unknown; + }; + target?: { + readonly selector?: string; + readonly width?: number; + readonly height?: number; + [k: string]: unknown; + }; + name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 84db3c77de..5c6be32141 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > events - -## RumActionEventDomainContext.events property - -**Signature:** - -```typescript -events?: Event[]; -``` + + +Home > @datadog/browser-rum > RumActionEventDomainContext > events + +## RumActionEventDomainContext.events property + +**Signature:** + +```typescript +events?: Event[]; +``` diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index d7c03fe471..6ed3f79069 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext > handlingStack - -## RumActionEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack + +## RumActionEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 1549fb2ca2..f197257642 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,54 +1,74 @@ - - -[Home](index.html) > @datadog/browser-rum > RumActionEventDomainContext - -## RumActionEventDomainContext interface - -**Signature:** - -```typescript -export interface RumActionEventDomainContext -``` - -## Properties - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
events? - - - -Event\[\] - - - -_(Optional)_ - -
handlingStack? - - - -string - - - -_(Optional)_ - -
+ + +Home > @datadog/browser-rum > RumActionEventDomainContext + +## RumActionEventDomainContext interface + +**Signature:** + +```typescript +export interface RumActionEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +events? + + + + + + + +Event\[\] + + + + +_(Optional)_ + + +
+ +handlingStack? + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index ad1edd4639..67ca589e50 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,119 +1,94 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEvent - -## RumErrorEvent type - -Schema of all properties of an Error event - -**Signature:** - -```typescript -export type RumErrorEvent = CommonProperties & - ActionChildProperties & - ViewContainerSchema & { - readonly type: 'error' - readonly error: { - readonly id?: string - message: string - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report' - stack?: string - causes?: { - message: string - readonly type?: string - stack?: string - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report' - [k: string]: unknown - }[] - readonly is_crash?: boolean - fingerprint?: string - readonly type?: string - readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning' - readonly handling?: 'handled' | 'unhandled' - readonly handling_stack?: string - readonly source_type?: - | 'android' - | 'browser' - | 'ios' - | 'react-native' - | 'flutter' - | 'roku' - | 'ndk' - | 'ios+il2cpp' - | 'ndk+il2cpp' - readonly resource?: { - readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT' - readonly status_code: number - url: string - readonly provider?: { - readonly domain?: string - readonly name?: string - readonly type?: - | 'ad' - | 'advertising' - | 'analytics' - | 'cdn' - | 'content' - | 'customer-success' - | 'first party' - | 'hosting' - | 'marketing' - | 'other' - | 'social' - | 'tag-manager' - | 'utility' - | 'video' - [k: string]: unknown - } - [k: string]: unknown - } - threads?: { - readonly name: string - readonly crashed: boolean - readonly stack: string - readonly state?: string - [k: string]: unknown - }[] - readonly binary_images?: { - readonly uuid: string - readonly name: string - readonly is_system: boolean - readonly load_address?: string - readonly max_address?: string - readonly arch?: string - [k: string]: unknown - }[] - readonly was_truncated?: boolean - readonly meta?: { - readonly code_type?: string - readonly parent_process?: string - readonly incident_identifier?: string - readonly process?: string - readonly exception_type?: string - readonly exception_codes?: string - readonly path?: string - [k: string]: unknown - } - readonly csp?: { - readonly disposition?: 'enforce' | 'report' - [k: string]: unknown - } - readonly time_since_app_start?: number - [k: string]: unknown - } - readonly freeze?: { - readonly duration: number - [k: string]: unknown - } - readonly view?: { - readonly in_foreground?: boolean - [k: string]: unknown - } - readonly feature_flags?: { - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumErrorEvent + +## RumErrorEvent type + +Schema of all properties of an Error event + +**Signature:** + +```typescript +export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'error'; + readonly error: { + readonly id?: string; + message: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + stack?: string; + causes?: { + message: string; + readonly type?: string; + stack?: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + [k: string]: unknown; + }[]; + readonly is_crash?: boolean; + fingerprint?: string; + readonly type?: string; + readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; + readonly handling?: 'handled' | 'unhandled'; + readonly handling_stack?: string; + readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; + readonly resource?: { + readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + readonly status_code: number; + url: string; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + threads?: { + readonly name: string; + readonly crashed: boolean; + readonly stack: string; + readonly state?: string; + [k: string]: unknown; + }[]; + readonly binary_images?: { + readonly uuid: string; + readonly name: string; + readonly is_system: boolean; + readonly load_address?: string; + readonly max_address?: string; + readonly arch?: string; + [k: string]: unknown; + }[]; + readonly was_truncated?: boolean; + readonly meta?: { + readonly code_type?: string; + readonly parent_process?: string; + readonly incident_identifier?: string; + readonly process?: string; + readonly exception_type?: string; + readonly exception_codes?: string; + readonly path?: string; + [k: string]: unknown; + }; + readonly csp?: { + readonly disposition?: 'enforce' | 'report'; + [k: string]: unknown; + }; + readonly time_since_app_start?: number; + [k: string]: unknown; + }; + readonly freeze?: { + readonly duration: number; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index ce98ebfb2e..22dc44c516 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > error - -## RumErrorEventDomainContext.error property - -**Signature:** - -```typescript -error: unknown -``` + + +Home > @datadog/browser-rum > RumErrorEventDomainContext > error + +## RumErrorEventDomainContext.error property + +**Signature:** + +```typescript +error: unknown; +``` diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 40040e52c0..122191ec1c 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack - -## RumErrorEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack + +## RumErrorEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 3bd11be761..9ea16a5d9a 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,52 +1,72 @@ - - -[Home](index.html) > @datadog/browser-rum > RumErrorEventDomainContext - -## RumErrorEventDomainContext interface - -**Signature:** - -```typescript -export interface RumErrorEventDomainContext -``` - -## Properties - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
error - - - -unknown - - - -
handlingStack? - - - -string - - - -_(Optional)_ - -
+ + +Home > @datadog/browser-rum > RumErrorEventDomainContext + +## RumErrorEventDomainContext interface + +**Signature:** + +```typescript +export interface RumErrorEventDomainContext +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +error + + + + + + + +unknown + + + + + +
+ +handlingStack? + + + + + + + +string + + + + +_(Optional)_ + + +
diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index d7e3f0ca25..5acfcc0430 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,21 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumEvent - -## RumEvent type - -Schema of all properties of a RUM event - -**Signature:** - -```typescript -export type RumEvent = - | RumActionEvent - | RumErrorEvent - | RumLongTaskEvent - | RumResourceEvent - | RumViewEvent - | RumVitalEvent -``` - -**References:** [RumActionEvent](./browser-rum.rumactionevent.md), [RumErrorEvent](./browser-rum.rumerrorevent.md), [RumLongTaskEvent](./browser-rum.rumlongtaskevent.md), [RumResourceEvent](./browser-rum.rumresourceevent.md), [RumViewEvent](./browser-rum.rumviewevent.md), [RumVitalEvent](./browser-rum.rumvitalevent.md) + + +Home > @datadog/browser-rum > RumEvent + +## RumEvent type + +Schema of all properties of a RUM event + +**Signature:** + +```typescript +export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; +``` +**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent + diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index bca352f4df..d8bce59c10 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,25 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumEventDomainContext - -## RumEventDomainContext type - -**Signature:** - -```typescript -export type RumEventDomainContext = T extends RumEventType.VIEW - ? RumViewEventDomainContext - : T extends RumEventType.ACTION - ? RumActionEventDomainContext - : T extends RumEventType.RESOURCE - ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext - : T extends RumEventType.ERROR - ? RumErrorEventDomainContext - : T extends RumEventType.LONG_TASK - ? RumLongTaskEventDomainContext - : T extends RumEventType.VITAL - ? RumVitalEventDomainContext - : never -``` - -**References:** [RumViewEventDomainContext](./browser-rum.rumvieweventdomaincontext.md), [RumActionEventDomainContext](./browser-rum.rumactioneventdomaincontext.md), [RumFetchResourceEventDomainContext](./browser-rum.rumfetchresourceeventdomaincontext.md), [RumXhrResourceEventDomainContext](./browser-rum.rumxhrresourceeventdomaincontext.md), [RumOtherResourceEventDomainContext](./browser-rum.rumotherresourceeventdomaincontext.md), [RumErrorEventDomainContext](./browser-rum.rumerroreventdomaincontext.md), [RumLongTaskEventDomainContext](./browser-rum.rumlongtaskeventdomaincontext.md) + + +Home > @datadog/browser-rum > RumEventDomainContext + +## RumEventDomainContext type + +**Signature:** + +```typescript +export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; +``` +**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext + diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 94e0a7c531..dd1a274562 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > error - -## RumFetchResourceEventDomainContext.error property - -**Signature:** - -```typescript -error?: Error; -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error + +## RumFetchResourceEventDomainContext.error property + +**Signature:** + +```typescript +error?: Error; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index 7575f76fa4..1e76d40f19 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack - -## RumFetchResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack + +## RumFetchResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 8e6bc6f383..cb92722d47 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted - -## RumFetchResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted + +## RumFetchResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index a8d998e08e..cb3c5f44d9 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,105 +1,165 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext - -## RumFetchResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumFetchResourceEventDomainContext -``` - -## Properties - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
error? - - - -Error - - - -_(Optional)_ - -
handlingStack? - - - -string - - - -_(Optional)_ - -
isAborted - - - -boolean - - - -
performanceEntry? - - - -PerformanceEntry - - - -_(Optional)_ - -
requestInit? - - - -RequestInit - - - -_(Optional)_ - -
requestInput - - - -RequestInfo - - - -
response? - - - -Response - - - -_(Optional)_ - -
+ + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext + +## RumFetchResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumFetchResourceEventDomainContext +``` + +## Properties + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +error? + + + + + + + +Error + + + + +_(Optional)_ + + +
+ +handlingStack? + + + + + + + +string + + + + +_(Optional)_ + + +
+ +isAborted + + + + + + + +boolean + + + + + +
+ +performanceEntry? + + + + + + + +PerformanceEntry + + + + +_(Optional)_ + + +
+ +requestInit? + + + + + + + +RequestInit + + + + +_(Optional)_ + + +
+ +requestInput + + + + + + + +RequestInfo + + + + + +
+ +response? + + + + + + + +Response + + + + +_(Optional)_ + + +
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 4d8eac7ed3..076459b7e5 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry - -## RumFetchResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry + +## RumFetchResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 5077a77e46..74da7d248a 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit - -## RumFetchResourceEventDomainContext.requestInit property - -**Signature:** - -```typescript -requestInit?: RequestInit; -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit + +## RumFetchResourceEventDomainContext.requestInit property + +**Signature:** + +```typescript +requestInit?: RequestInit; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 06b6890b79..83a2842053 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput - -## RumFetchResourceEventDomainContext.requestInput property - -**Signature:** - -```typescript -requestInput: RequestInfo -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput + +## RumFetchResourceEventDomainContext.requestInput property + +**Signature:** + +```typescript +requestInput: RequestInfo; +``` diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index b5fc662d3c..22c0702218 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumFetchResourceEventDomainContext > response - -## RumFetchResourceEventDomainContext.response property - -**Signature:** - -```typescript -response?: Response; -``` + + +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response + +## RumFetchResourceEventDomainContext.response property + +**Signature:** + +```typescript +response?: Response; +``` diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index c73ab4b095..19f1d379a5 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addAction - -## RumGlobal.addAction property - -Add a custom action, stored in `@action` - -**Signature:** - -```typescript -addAction: (name: string, context?: object) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > addAction + +## RumGlobal.addAction property + +Add a custom action, stored in `@action` + +**Signature:** + +```typescript +addAction: (name: string, context?: object) => void; +``` diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index 77342d362d..e0a85965c6 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,18 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addDurationVital - -## RumGlobal.addDurationVital property - -Add a custom duration vital - -**Signature:** - -```typescript -addDurationVital: (name: string, options: { - startTime: number; - duration: number; - context?: object; - description?: string; - }) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > addDurationVital + +## RumGlobal.addDurationVital property + +Add a custom duration vital + +**Signature:** + +```typescript +addDurationVital: (name: string, options: { + startTime: number; + duration: number; + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index 7154181633..146b024d05 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addError - -## RumGlobal.addError property - -Add a custom error, stored in `@error`. - -**Signature:** - -```typescript -addError: (error: unknown, context?: object) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > addError + +## RumGlobal.addError property + +Add a custom error, stored in `@error`. + +**Signature:** + +```typescript +addError: (error: unknown, context?: object) => void; +``` diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 41f53c3541..3899838032 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation - -## RumGlobal.addFeatureFlagEvaluation property - -Add a feature flag evaluation, stored in `@feature_flags.` - -**Signature:** - -```typescript -addFeatureFlagEvaluation: (key: string, value: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation + +## RumGlobal.addFeatureFlagEvaluation property + +Add a feature flag evaluation, stored in `@feature_flags.` + +**Signature:** + +```typescript +addFeatureFlagEvaluation: (key: string, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 7b23629781..5dde6180d9 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > addTiming - -## RumGlobal.addTiming property - -Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` - -**Signature:** - -```typescript -addTiming: (name: string, time?: number) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > addTiming + +## RumGlobal.addTiming property + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + +**Signature:** + +```typescript +addTiming: (name: string, time?: number) => void; +``` diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 3526bf77d9..42e191063d 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearAccount - -## RumGlobal.clearAccount property - -Clear all account information - -**Signature:** - -```typescript -clearAccount: () => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > clearAccount + +## RumGlobal.clearAccount property + +Clear all account information + +**Signature:** + +```typescript +clearAccount: () => void; +``` diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index 14dbe38626..2069f0ce16 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearGlobalContext - -## RumGlobal.clearGlobalContext property - -Clear the global context - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -clearGlobalContext: () => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > clearGlobalContext + +## RumGlobal.clearGlobalContext property + +Clear the global context + +See \Global context\ for further information. + +**Signature:** + +```typescript +clearGlobalContext: () => void; +``` diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 78fae53ee2..130b111172 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > clearUser - -## RumGlobal.clearUser property - -Clear all user information - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -clearUser: () => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > clearUser + +## RumGlobal.clearUser property + +Clear all user information + +See \User session\ for further information. + +**Signature:** + +```typescript +clearUser: () => void; +``` diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index 63825b4aa8..efce77d3e2 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getAccount - -## RumGlobal.getAccount property - -Get account information - -**Signature:** - -```typescript -getAccount: () => Context -``` + + +Home > @datadog/browser-rum > RumGlobal > getAccount + +## RumGlobal.getAccount property + +Get account information + +**Signature:** + +```typescript +getAccount: () => Context; +``` diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 913130ce90..b267db79c9 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getGlobalContext - -## RumGlobal.getGlobalContext property - -Get the global Context - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -getGlobalContext: () => Context -``` + + +Home > @datadog/browser-rum > RumGlobal > getGlobalContext + +## RumGlobal.getGlobalContext property + +Get the global Context + +See \Global context\ for further information. + +**Signature:** + +```typescript +getGlobalContext: () => Context; +``` diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index e4baeafa1f..c9c0e442c1 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getInitConfiguration - -## RumGlobal.getInitConfiguration property - -Get the init configuration - -**Signature:** - -```typescript -getInitConfiguration: () => RumInitConfiguration | undefined -``` + + +Home > @datadog/browser-rum > RumGlobal > getInitConfiguration + +## RumGlobal.getInitConfiguration property + +Get the init configuration + +**Signature:** + +```typescript +getInitConfiguration: () => RumInitConfiguration | undefined; +``` diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index be48ed076f..90a2c53730 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getInternalContext - -## RumGlobal.getInternalContext property - -\[Internal API\] Get the internal SDK context - -**Signature:** - -```typescript -getInternalContext: (startTime?: number) => InternalContext | undefined -``` + + +Home > @datadog/browser-rum > RumGlobal > getInternalContext + +## RumGlobal.getInternalContext property + +\[Internal API\] Get the internal SDK context + +**Signature:** + +```typescript +getInternalContext: (startTime?: number) => InternalContext | undefined; +``` diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 21a2243808..97a36f4437 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getSessionReplayLink - -## RumGlobal.getSessionReplayLink property - -Get the Session Replay Link. - -See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. - -**Signature:** - -```typescript -getSessionReplayLink: () => string | undefined -``` + + +Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink + +## RumGlobal.getSessionReplayLink property + +Get the Session Replay Link. + +See \Connect Session Replay To Your Third-Party Tools\ for further information. + +**Signature:** + +```typescript +getSessionReplayLink: () => string | undefined; +``` diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index 45c2d66e37..c49e15cecf 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getUser - -## RumGlobal.getUser property - -Get user information - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -getUser: () => Context -``` + + +Home > @datadog/browser-rum > RumGlobal > getUser + +## RumGlobal.getUser property + +Get user information + +See \User session\ for further information. + +**Signature:** + +```typescript +getUser: () => Context; +``` diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index c222d32a38..00c5ab8661 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > getViewContext - -## RumGlobal.getViewContext property - -Get View Context. - -**Signature:** - -```typescript -getViewContext: () => Context -``` + + +Home > @datadog/browser-rum > RumGlobal > getViewContext + +## RumGlobal.getViewContext property + +Get View Context. + +**Signature:** + +```typescript +getViewContext: () => Context; +``` diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 4f8891a801..e03d8e6a9d 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > init - -## RumGlobal.init property - -Init the RUM browser SDK. - -**Signature:** - -```typescript -init: (initConfiguration: RumInitConfiguration) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > init + +## RumGlobal.init property + +Init the RUM browser SDK. + +**Signature:** + +```typescript +init: (initConfiguration: RumInitConfiguration) => void; +``` diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index cbd271e81d..7fd303ed7a 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,459 +1,748 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal - -## RumGlobal interface - -**Signature:** - -```typescript -export interface RumPublicApi extends PublicApi -``` - -**Extends:** PublicApi - -## Properties - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
addAction - - - -(name: string, context?: object) => void - - - -Add a custom action, stored in `@action` - -
addDurationVital - - - -(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void - - - -Add a custom duration vital - -
addError - - - -(error: unknown, context?: object) => void - - - -Add a custom error, stored in `@error`. - -
addFeatureFlagEvaluation - - - -(key: string, value: any) => void - - - -Add a feature flag evaluation, stored in `@feature_flags.` - -
addTiming - - - -(name: string, time?: number) => void - - - -Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` - -
clearAccount - - - -() => void - - - -Clear all account information - -
clearGlobalContext - - - -() => void - - - -Clear the global context - -See \Global context\ for further information. - -
clearUser - - - -() => void - - - -Clear all user information - -See \User session\ for further information. - -
getAccount - - - -() => Context - - - -Get account information - -
getGlobalContext - - - -() => Context - - - -Get the global Context - -See \Global context\ for further information. - -
getInitConfiguration - - - -() => RumInitConfiguration \| undefined - - - -Get the init configuration - -
getInternalContext - - - -(startTime?: number) => InternalContext \| undefined - - - -\[Internal API\] Get the internal SDK context - -
getSessionReplayLink - - - -() => string \| undefined - - - -Get the Session Replay Link. - -See \Connect Session Replay To Your Third-Party Tools\ for further information. - -
getUser - - - -() => Context - - - -Get user information - -See \User session\ for further information. - -
getViewContext - - - -() => Context - - - -Get View Context. - -
init - - - -(initConfiguration: RumInitConfiguration) => void - - - -Init the RUM browser SDK. - -
removeAccountProperty - - - -(key: string) => void - - - -Remove an account property - -
removeGlobalContextProperty - - - -(key: any) => void - - - -Remove a global context property - -See \Global context\ for further information. - -
removeUserProperty - - - -(key: any) => void - - - -Remove a user property - -See \User session\ for further information. - -
setAccount - - - -(newAccount: Account) => void - - - -Set account information to all events, stored in `@account` - -
setAccountProperty - - - -(key: string, property: any) => void - - - -Set or update the account property, stored in `@account.` - -
setGlobalContext - - - -(context: any) => void - - - -Set the global context information to all events, stored in `@context` - -
setGlobalContextProperty - - - -(key: any, value: any) => void - - - -Set or update a global context property, stored in `@context.` - -
setTrackingConsent - - - -(trackingConsent: TrackingConsent) => void - - - -Set the tracking consent of the current user. - -
setUserProperty - - - -(key: any, property: any) => void - - - -Set or update the user property, stored in `@usr.` - -
setViewContext - - - -(context: Context) => void - - - -Set View Context. - -Enable to manually set the context of the current view. - -
setViewContextProperty - - - -(key: string, value: any) => void - - - -Set View Context Property. - -Enable to manually set a property of the context of the current view. - -
setViewName - - - -(name: string) => void - - - -Set View Name. - -Enable to manually change the name of the current view. - -
startDurationVital - - - -(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference - - - -Start a custom duration vital. - -If you plan to have multiple durations for the same vital, you should use the reference returned by this method. - -
startSessionReplayRecording - - - -(options?: StartRecordingOptions) => void - - - -Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` - -See \Browser Session Replay\ for further information. - -
startView - - - -{ (name?: string): void; (options: ViewOptions): void; } - - - -Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. - -
stopDurationVital - - - -(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void - - - -Stop a custom duration vital - -
stopSession - - - -() => void - - - -Stop the session. A new session will start at the next user interaction with the page. - -
stopSessionReplayRecording - - - -() => void - - - -Stop Session Replay recording. - -See \Browser Session Replay\ for further information. - -
- -## Methods - - - - -
- -Method - - - -Description - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -See \User session\ for further information. - -
setUser(newUser) - -Set user information to all events, stored in `@usr` - -
+ + +Home > @datadog/browser-rum > RumGlobal + +## RumGlobal interface + +**Signature:** + +```typescript +export interface RumPublicApi extends PublicApi +``` +**Extends:** PublicApi + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +addAction + + + + + + + +(name: string, context?: object) => void + + + + +Add a custom action, stored in `@action` + + +
+ +addDurationVital + + + + + + + +(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void + + + + +Add a custom duration vital + + +
+ +addError + + + + + + + +(error: unknown, context?: object) => void + + + + +Add a custom error, stored in `@error`. + + +
+ +addFeatureFlagEvaluation + + + + + + + +(key: string, value: any) => void + + + + +Add a feature flag evaluation, stored in `@feature_flags.` + + +
+ +addTiming + + + + + + + +(name: string, time?: number) => void + + + + +Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` + + +
+ +clearAccount + + + + + + + +() => void + + + + +Clear all account information + + +
+ +clearGlobalContext + + + + + + + +() => void + + + + +Clear the global context + +See \Global context\ for further information. + + +
+ +clearUser + + + + + + + +() => void + + + + +Clear all user information + +See \User session\ for further information. + + +
+ +getAccount + + + + + + + +() => Context + + + + +Get account information + + +
+ +getGlobalContext + + + + + + + +() => Context + + + + +Get the global Context + +See \Global context\ for further information. + + +
+ +getInitConfiguration + + + + + + + +() => RumInitConfiguration \| undefined + + + + +Get the init configuration + + +
+ +getInternalContext + + + + + + + +(startTime?: number) => InternalContext \| undefined + + + + +\[Internal API\] Get the internal SDK context + + +
+ +getSessionReplayLink + + + + + + + +() => string \| undefined + + + + +Get the Session Replay Link. + +See \Connect Session Replay To Your Third-Party Tools\ for further information. + + +
+ +getUser + + + + + + + +() => Context + + + + +Get user information + +See \User session\ for further information. + + +
+ +getViewContext + + + + + + + +() => Context + + + + +Get View Context. + + +
+ +init + + + + + + + +(initConfiguration: RumInitConfiguration) => void + + + + +Init the RUM browser SDK. + + +
+ +removeAccountProperty + + + + + + + +(key: string) => void + + + + +Remove an account property + + +
+ +removeGlobalContextProperty + + + + + + + +(key: any) => void + + + + +Remove a global context property + +See \Global context\ for further information. + + +
+ +removeUserProperty + + + + + + + +(key: any) => void + + + + +Remove a user property + +See \User session\ for further information. + + +
+ +setAccount + + + + + + + +(newAccount: Account) => void + + + + +Set account information to all events, stored in `@account` + + +
+ +setAccountProperty + + + + + + + +(key: string, property: any) => void + + + + +Set or update the account property, stored in `@account.` + + +
+ +setGlobalContext + + + + + + + +(context: any) => void + + + + +Set the global context information to all events, stored in `@context` + + +
+ +setGlobalContextProperty + + + + + + + +(key: any, value: any) => void + + + + +Set or update a global context property, stored in `@context.` + + +
+ +setTrackingConsent + + + + + + + +(trackingConsent: TrackingConsent) => void + + + + +Set the tracking consent of the current user. + + +
+ +setUserProperty + + + + + + + +(key: any, property: any) => void + + + + +Set or update the user property, stored in `@usr.` + + +
+ +setViewContext + + + + + + + +(context: Context) => void + + + + +Set View Context. + +Enable to manually set the context of the current view. + + +
+ +setViewContextProperty + + + + + + + +(key: string, value: any) => void + + + + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + + +
+ +setViewName + + + + + + + +(name: string) => void + + + + +Set View Name. + +Enable to manually change the name of the current view. + + +
+ +startDurationVital + + + + + + + +(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference + + + + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + + +
+ +startSessionReplayRecording + + + + + + + +(options?: StartRecordingOptions) => void + + + + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \Browser Session Replay\ for further information. + + +
+ +startView + + + + + + + +{ (name?: string): void; (options: ViewOptions): void; } + + + + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + + +
+ +stopDurationVital + + + + + + + +(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void + + + + +Stop a custom duration vital + + +
+ +stopSession + + + + + + + +() => void + + + + +Stop the session. A new session will start at the next user interaction with the page. + + +
+ +stopSessionReplayRecording + + + + + + + +() => void + + + + +Stop Session Replay recording. + +See \Browser Session Replay\ for further information. + + +
+ +## Methods + + + + +
+ +Method + + + + +Description + + +
+ +setUser(newUser) + + + + +Set user information to all events, stored in `@usr` + +See \User session\ for further information. + + +
+ +setUser(newUser) + + + + +Set user information to all events, stored in `@usr` + + +
diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index 3229acdd52..f9629df37d 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeAccountProperty - -## RumGlobal.removeAccountProperty property - -Remove an account property - -**Signature:** - -```typescript -removeAccountProperty: (key: string) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > removeAccountProperty + +## RumGlobal.removeAccountProperty property + +Remove an account property + +**Signature:** + +```typescript +removeAccountProperty: (key: string) => void; +``` diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index ab0ba0fdf0..0f8fcc3b7c 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty - -## RumGlobal.removeGlobalContextProperty property - -Remove a global context property - -See \[Global context\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#global-context) for further information. - -**Signature:** - -```typescript -removeGlobalContextProperty: (key: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty + +## RumGlobal.removeGlobalContextProperty property + +Remove a global context property + +See \Global context\ for further information. + +**Signature:** + +```typescript +removeGlobalContextProperty: (key: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index b0a63b22df..aaecbf8e8a 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > removeUserProperty - -## RumGlobal.removeUserProperty property - -Remove a user property - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -removeUserProperty: (key: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > removeUserProperty + +## RumGlobal.removeUserProperty property + +Remove a user property + +See \User session\ for further information. + +**Signature:** + +```typescript +removeUserProperty: (key: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 9f8804585f..19a18f65cd 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccount - -## RumGlobal.setAccount property - -Set account information to all events, stored in `@account` - -**Signature:** - -```typescript -setAccount: (newAccount: Account) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setAccount + +## RumGlobal.setAccount property + +Set account information to all events, stored in `@account` + +**Signature:** + +```typescript +setAccount: (newAccount: Account) => void; +``` diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index a446b62b6e..c9abc2cb8b 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setAccountProperty - -## RumGlobal.setAccountProperty property - -Set or update the account property, stored in `@account.` - -**Signature:** - -```typescript -setAccountProperty: (key: string, property: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setAccountProperty + +## RumGlobal.setAccountProperty property + +Set or update the account property, stored in `@account.` + +**Signature:** + +```typescript +setAccountProperty: (key: string, property: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 857940d732..65590e98ed 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContext - -## RumGlobal.setGlobalContext property - -Set the global context information to all events, stored in `@context` - -**Signature:** - -```typescript -setGlobalContext: (context: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setGlobalContext + +## RumGlobal.setGlobalContext property + +Set the global context information to all events, stored in `@context` + +**Signature:** + +```typescript +setGlobalContext: (context: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index ef95f594da..8b9735e6b1 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setGlobalContextProperty - -## RumGlobal.setGlobalContextProperty property - -Set or update a global context property, stored in `@context.` - -**Signature:** - -```typescript -setGlobalContextProperty: (key: any, value: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty + +## RumGlobal.setGlobalContextProperty property + +Set or update a global context property, stored in `@context.` + +**Signature:** + +```typescript +setGlobalContextProperty: (key: any, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 9293309a45..2add318c5f 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setTrackingConsent - -## RumGlobal.setTrackingConsent property - -Set the tracking consent of the current user. - -**Signature:** - -```typescript -setTrackingConsent: (trackingConsent: TrackingConsent) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setTrackingConsent + +## RumGlobal.setTrackingConsent property + +Set the tracking consent of the current user. + +**Signature:** + +```typescript +setTrackingConsent: (trackingConsent: TrackingConsent) => void; +``` diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index 2f179184c4..416df3338c 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,48 +1,55 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser - -## RumGlobal.setUser() method - -Set user information to all events, stored in `@usr` - -See \[User session\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/\#user-session) for further information. - -**Signature:** - -```typescript -setUser(newUser: User & { - id: string; - }): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -newUser - - - -User & { id: string; } - - - -
-**Returns:** - -void + + +Home > @datadog/browser-rum > RumGlobal > setUser + +## RumGlobal.setUser() method + +Set user information to all events, stored in `@usr` + +See \User session\ for further information. + +**Signature:** + +```typescript +setUser(newUser: User & { + id: string; + }): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User & { id: string; } + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 5e9e46f565..71ff2fcf74 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,48 +1,56 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUser - -## RumGlobal.setUser() method - -> Warning: This API is now obsolete. -> -> You must specify a user id - -Set user information to all events, stored in `@usr` - -**Signature:** - -```typescript -setUser(newUser: User): void; -``` - -## Parameters - - - -
- -Parameter - - - -Type - - - -Description - -
- -newUser - - - -User - - - -
-**Returns:** - -void + + +Home > @datadog/browser-rum > RumGlobal > setUser + +## RumGlobal.setUser() method + +> Warning: This API is now obsolete. +> +> You must specify a user id +> + +Set user information to all events, stored in `@usr` + +**Signature:** + +```typescript +setUser(newUser: User): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newUser + + + + +User + + + + + +
+**Returns:** + +void + diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index efde1da55e..f7a7ed64a9 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setUserProperty - -## RumGlobal.setUserProperty property - -Set or update the user property, stored in `@usr.` - -**Signature:** - -```typescript -setUserProperty: (key: any, property: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setUserProperty + +## RumGlobal.setUserProperty property + +Set or update the user property, stored in `@usr.` + +**Signature:** + +```typescript +setUserProperty: (key: any, property: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index c17e26e89b..8855976153 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContext - -## RumGlobal.setViewContext property - -Set View Context. - -Enable to manually set the context of the current view. - -**Signature:** - -```typescript -setViewContext: (context: Context) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setViewContext + +## RumGlobal.setViewContext property + +Set View Context. + +Enable to manually set the context of the current view. + +**Signature:** + +```typescript +setViewContext: (context: Context) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index f4f92098a8..ba1ad45fd6 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewContextProperty - -## RumGlobal.setViewContextProperty property - -Set View Context Property. - -Enable to manually set a property of the context of the current view. - -**Signature:** - -```typescript -setViewContextProperty: (key: string, value: any) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setViewContextProperty + +## RumGlobal.setViewContextProperty property + +Set View Context Property. + +Enable to manually set a property of the context of the current view. + +**Signature:** + +```typescript +setViewContextProperty: (key: string, value: any) => void; +``` diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 474e6daf54..4ce1212f54 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > setViewName - -## RumGlobal.setViewName property - -Set View Name. - -Enable to manually change the name of the current view. - -**Signature:** - -```typescript -setViewName: (name: string) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > setViewName + +## RumGlobal.setViewName property + +Set View Name. + +Enable to manually change the name of the current view. + +**Signature:** + +```typescript +setViewName: (name: string) => void; +``` diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index bec276e558..a8f43e0f11 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,21 +1,18 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startDurationVital - -## RumGlobal.startDurationVital property - -Start a custom duration vital. - -If you plan to have multiple durations for the same vital, you should use the reference returned by this method. - -**Signature:** - -```typescript -startDurationVital: ( - name: string, - options?: { - context?: object - description?: string - } -) => DurationVitalReference -``` + + +Home > @datadog/browser-rum > RumGlobal > startDurationVital + +## RumGlobal.startDurationVital property + +Start a custom duration vital. + +If you plan to have multiple durations for the same vital, you should use the reference returned by this method. + +**Signature:** + +```typescript +startDurationVital: (name: string, options?: { + context?: object; + description?: string; + }) => DurationVitalReference; +``` diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 802836ee3f..fcf7f54282 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startSessionReplayRecording - -## RumGlobal.startSessionReplayRecording property - -Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` - -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. - -**Signature:** - -```typescript -startSessionReplayRecording: (options?: StartRecordingOptions) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording + +## RumGlobal.startSessionReplayRecording property + +Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` + +See \Browser Session Replay\ for further information. + +**Signature:** + +```typescript +startSessionReplayRecording: (options?: StartRecordingOptions) => void; +``` diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index eb481222a3..8c4287b8d7 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > startView - -## RumGlobal.startView property - -Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. - -**Signature:** - -```typescript -startView: { - (name?: string): void; - (options: ViewOptions): void; - }; -``` + + +Home > @datadog/browser-rum > RumGlobal > startView + +## RumGlobal.startView property + +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + +**Signature:** + +```typescript +startView: { + (name?: string): void; + (options: ViewOptions): void; + }; +``` diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index aab3c12292..2fdc0e4de1 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,16 +1,16 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopDurationVital - -## RumGlobal.stopDurationVital property - -Stop a custom duration vital - -**Signature:** - -```typescript -stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { - context?: object; - description?: string; - }) => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > stopDurationVital + +## RumGlobal.stopDurationVital property + +Stop a custom duration vital + +**Signature:** + +```typescript +stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { + context?: object; + description?: string; + }) => void; +``` diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index f22a562617..7a86d94490 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSession - -## RumGlobal.stopSession property - -Stop the session. A new session will start at the next user interaction with the page. - -**Signature:** - -```typescript -stopSession: () => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > stopSession + +## RumGlobal.stopSession property + +Stop the session. A new session will start at the next user interaction with the page. + +**Signature:** + +```typescript +stopSession: () => void; +``` diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index 5d14e735ed..b521cbae63 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording - -## RumGlobal.stopSessionReplayRecording property - -Stop Session Replay recording. - -See \[Browser Session Replay\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser) for further information. - -**Signature:** - -```typescript -stopSessionReplayRecording: () => void; -``` + + +Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording + +## RumGlobal.stopSessionReplayRecording property + +Stop Session Replay recording. + +See \Browser Session Replay\ for further information. + +**Signature:** + +```typescript +stopSessionReplayRecording: () => void; +``` diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index c35eec5191..9b4d01891e 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute - -## RumInitConfiguration.actionNameAttribute property - -Specify your own attribute to use to name actions. See \[Declare a name for click actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions/\#declare-a-name-for-click-actions) for further information. - -**Signature:** - -```typescript -actionNameAttribute?: string | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute + +## RumInitConfiguration.actionNameAttribute property + +Specify your own attribute to use to name actions. See Declare a name for click actions for further information. + +**Signature:** + +```typescript +actionNameAttribute?: string | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 2f6d5c496c..feb9bdbaac 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls - -## RumInitConfiguration.allowedTracingUrls property - -A list of request URLs used to inject tracing headers. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -allowedTracingUrls?: Array | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls + +## RumInitConfiguration.allowedTracingUrls property + +A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. + +**Signature:** + +```typescript +allowedTracingUrls?: Array | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index a0482ca528..d7c5a6276f 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > applicationId - -## RumInitConfiguration.applicationId property - -The RUM application ID. - -**Signature:** - -```typescript -applicationId: string -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > applicationId + +## RumInitConfiguration.applicationId property + +The RUM application ID. + +**Signature:** + +```typescript +applicationId: string; +``` diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 8bc9714843..bd7bb2d753 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,15 +1,15 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > beforeSend - -## RumInitConfiguration.beforeSend property - -Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events - -See \[Enrich And Control Browser RUM Data With beforeSend\](https://docs.datadoghq.com/real\_user\_monitoring/guide/enrich-and-control-rum-data) for further information. - -**Signature:** - -```typescript -beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > beforeSend + +## RumInitConfiguration.beforeSend property + +Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See Enrich And Control Browser RUM Data With beforeSend for further information. + +**Signature:** + +```typescript +beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 73e2f62b3c..4059840a44 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests - -## RumInitConfiguration.compressIntakeRequests property - -Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. - -**Signature:** - -```typescript -compressIntakeRequests?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests + +## RumInitConfiguration.compressIntakeRequests property + +Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. + +**Signature:** + +```typescript +compressIntakeRequests?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index 2338fd1ac0..fe01ef6825 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel - -## RumInitConfiguration.defaultPrivacyLevel property - -Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \[Replay Privacy Options\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/privacy\_options) for further information. - -**Signature:** - -```typescript -defaultPrivacyLevel?: DefaultPrivacyLevel | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel + +## RumInitConfiguration.defaultPrivacyLevel property + +Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. + +**Signature:** + +```typescript +defaultPrivacyLevel?: DefaultPrivacyLevel | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 34188ab3b8..6d303fda27 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName - -## RumInitConfiguration.enablePrivacyForActionName property - -Enables privacy control for action names. - -**Signature:** - -```typescript -enablePrivacyForActionName?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName + +## RumInitConfiguration.enablePrivacyForActionName property + +Enables privacy control for action names. + +**Signature:** + +```typescript +enablePrivacyForActionName?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index 21d7cbfebd..e9318de8ff 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls - -## RumInitConfiguration.excludedActivityUrls property - -A list of request origins ignored when computing the page activity. See \[How page activity is calculated\](https://docs.datadoghq.com/real\_user\_monitoring/browser/monitoring\_page\_performance/\#how-page-activity-is-calculated) for further information. - -**Signature:** - -```typescript -excludedActivityUrls?: MatchOption[] | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls + +## RumInitConfiguration.excludedActivityUrls property + +A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. + +**Signature:** + +```typescript +excludedActivityUrls?: MatchOption[] | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 197992c6c9..5f7e218e6e 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,300 +1,476 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration - -## RumInitConfiguration interface - -**Signature:** - -```typescript -export interface RumInitConfiguration extends InitConfiguration -``` - -**Extends:** InitConfiguration - -## Properties - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
actionNameAttribute? - - - -string \| undefined - - - -_(Optional)_ Specify your own attribute to use to name actions. See \Declare a name for click actions\ for further information. - -
allowedTracingUrls? - - - -Array<MatchOption \| TracingOption> \| undefined - - - -_(Optional)_ A list of request URLs used to inject tracing headers. See \Connect RUM and Traces\ for further information. - -
applicationId - - - -string - - - -The RUM application ID. - -
beforeSend? - - - -((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined - - - -_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events - -See \Enrich And Control Browser RUM Data With beforeSend\ for further information. - -
compressIntakeRequests? - - - -boolean \| undefined - - - -_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See \Content Security Policy guidelines\ for further information. - -
defaultPrivacyLevel? - - - -DefaultPrivacyLevel \| undefined - - - -_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See \Replay Privacy Options\ for further information. - -
enablePrivacyForActionName? - - - -boolean \| undefined - - - -_(Optional)_ Enables privacy control for action names. - -
excludedActivityUrls? - - - -MatchOption\[\] \| undefined - - - -_(Optional)_ A list of request origins ignored when computing the page activity. See \How page activity is calculated\ for further information. - -
plugins? - - - -RumPlugin\[\] \| undefined - - - -_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. - -
profilingSampleRate? - - - -number \| undefined - - - -_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 - -
propagateTraceBaggage? - - - -boolean \| undefined - - - -_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false - -
remoteConfigurationId? - - - -string \| undefined - - - -_(Optional)_ - -
sessionReplaySampleRate? - - - -number \| undefined - - - -_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See \Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\ for further information. - -
startSessionReplayRecordingManually? - - - -boolean \| undefined - - - -_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \Session Replay Usage\ for further information. - -
subdomain? - - - -string - - - -_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \Connect Session Replay To Your Third-Party Tools\ for further information. - -
traceContextInjection? - - - -TraceContextInjection \| undefined - - - -_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \Connect RUM and Traces\ for further information. - -
traceSampleRate? - - - -number \| undefined - - - -_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See \Connect RUM and Traces\ for further information. - -
trackBfcacheViews? - - - -boolean \| undefined - - - -_(Optional)_ Enable the creation of dedicated views for pages restored from the Back-Forward cache. false - -
trackFeatureFlagsForEvents? - - - -FeatureFlagsForEvents\[\] - - - -_(Optional)_ Enables collection of features flags in chosen events. - -
trackLongTasks? - - - -boolean \| undefined - - - -_(Optional)_ Enables collection of long task events. true - -
trackResources? - - - -boolean \| undefined - - - -_(Optional)_ Enables collection of resource events. true - -
trackUserInteractions? - - - -boolean \| undefined - - - -_(Optional)_ Enables automatic collection of users actions. See \Tracking User Actions\ for further information. true - -
trackViewsManually? - - - -boolean \| undefined - - - -_(Optional)_ Allows you to control RUM views creation. See \Override default RUM view names\ for further information. - -
workerUrl? - - - -string - - - -_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \Content Security Policy guidelines\ for further information. - -
+ + +Home > @datadog/browser-rum > RumInitConfiguration + +## RumInitConfiguration interface + +**Signature:** + +```typescript +export interface RumInitConfiguration extends InitConfiguration +``` +**Extends:** InitConfiguration + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +actionNameAttribute? + + + + + + + +string \| undefined + + + + +_(Optional)_ Specify your own attribute to use to name actions. See Declare a name for click actions for further information. + + +
+ +allowedTracingUrls? + + + + + + + +Array<MatchOption \| TracingOption> \| undefined + + + + +_(Optional)_ A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. + + +
+ +applicationId + + + + + + + +string + + + + +The RUM application ID. + + +
+ +beforeSend? + + + + + + + +((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined + + + + +_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events + +See Enrich And Control Browser RUM Data With beforeSend for further information. + + +
+ +compressIntakeRequests? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. + + +
+ +defaultPrivacyLevel? + + + + + + + +DefaultPrivacyLevel \| undefined + + + + +_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. + + +
+ +enablePrivacyForActionName? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables privacy control for action names. + + +
+ +excludedActivityUrls? + + + + + + + +MatchOption\[\] \| undefined + + + + +_(Optional)_ A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. + + +
+ +plugins? + + + + + + + +RumPlugin\[\] \| undefined + + + + +_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + + +
+ +profilingSampleRate? + + + + + + + +number \| undefined + + + + +_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + + +
+ +propagateTraceBaggage? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false + + +
+ +remoteConfigurationId? + + + + + + + +string \| undefined + + + + +_(Optional)_ Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. + + +
+ +sessionReplaySampleRate? + + + + + + + +number \| undefined + + + + +_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. + + +
+ +startSessionReplayRecordingManually? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. + + +
+ +subdomain? + + + + + + + +string + + + + +_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. + + +
+ +traceContextInjection? + + + + + + + +TraceContextInjection \| undefined + + + + +_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. + + +
+ +traceSampleRate? + + + + + + + +number \| undefined + + + + +_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. + + +
+ +trackFeatureFlagsForEvents? + + + + + + + +FeatureFlagsForEvents\[\] + + + + +_(Optional)_ Enables collection of features flags in chosen events. + + +
+ +trackLongTasks? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables collection of long task events. true + + +
+ +trackResources? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables collection of resource events. true + + +
+ +trackUserInteractions? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Enables automatic collection of users actions. See Tracking User Actions for further information. true + + +
+ +trackViewsManually? + + + + + + + +boolean \| undefined + + + + +_(Optional)_ Allows you to control RUM views creation. See Override default RUM view names for further information. + + +
+ +workerUrl? + + + + + + + +string + + + + +_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. + + +
diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 0224d98ed2..138900b64d 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > plugins - -## RumInitConfiguration.plugins property - -List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. - -**Signature:** - -```typescript -plugins?: RumPlugin[] | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > plugins + +## RumInitConfiguration.plugins property + +List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. + +**Signature:** + +```typescript +plugins?: RumPlugin[] | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index a426c6579a..f2301fc6df 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate - -## RumInitConfiguration.profilingSampleRate property - -Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 - -**Signature:** - -```typescript -profilingSampleRate?: number | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate + +## RumInitConfiguration.profilingSampleRate property + +Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 + +**Signature:** + +```typescript +profilingSampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index d6b6c3e1e9..f4798936b9 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage - -## RumInitConfiguration.propagateTraceBaggage property - -Whether to propagate user and account IDs in the baggage header of trace requests. false - -**Signature:** - -```typescript -propagateTraceBaggage?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage + +## RumInitConfiguration.propagateTraceBaggage property + +Whether to propagate user and account IDs in the baggage header of trace requests. false + +**Signature:** + +```typescript +propagateTraceBaggage?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index d858d83c1b..3ebce68042 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,11 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId - -## RumInitConfiguration.remoteConfigurationId property - -**Signature:** - -```typescript -remoteConfigurationId?: string | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId + +## RumInitConfiguration.remoteConfigurationId property + +Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. + +**Signature:** + +```typescript +remoteConfigurationId?: string | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 19b3e4a295..c40815e40f 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate - -## RumInitConfiguration.sessionReplaySampleRate property - -The percentage of tracked sessions with \[Browser RUM & Session Replay pricing\](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay\#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See \[Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling\](https://docs.datadoghq.com/real\_user\_monitoring/guide/sampling-browser-plans) for further information. - -**Signature:** - -```typescript -sessionReplaySampleRate?: number | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate + +## RumInitConfiguration.sessionReplaySampleRate property + +The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. + +**Signature:** + +```typescript +sessionReplaySampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 7e4bb90082..a0a05d3842 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually - -## RumInitConfiguration.startSessionReplayRecordingManually property - -If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See \[Session Replay Usage\](https://docs.datadoghq.com/real\_user\_monitoring/session\_replay/browser/\#usage) for further information. - -**Signature:** - -```typescript -startSessionReplayRecordingManually?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually + +## RumInitConfiguration.startSessionReplayRecordingManually property + +If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. + +**Signature:** + +```typescript +startSessionReplayRecordingManually?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index a3e5bb6b53..9725b457e5 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > subdomain - -## RumInitConfiguration.subdomain property - -If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See \[Connect Session Replay To Your Third-Party Tools\](https://docs.datadoghq.com/real\_user\_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. - -**Signature:** - -```typescript -subdomain?: string; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > subdomain + +## RumInitConfiguration.subdomain property + +If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. + +**Signature:** + +```typescript +subdomain?: string; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 71de054f74..37b0067289 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceContextInjection - -## RumInitConfiguration.traceContextInjection property - -If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -traceContextInjection?: TraceContextInjection | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection + +## RumInitConfiguration.traceContextInjection property + +If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. + +**Signature:** + +```typescript +traceContextInjection?: TraceContextInjection | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index b1dc951b26..6cab0af3d9 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > traceSampleRate - -## RumInitConfiguration.traceSampleRate property - -The percentage of requests to trace: 100 for all, 0 for none. See \[Connect RUM and Traces\](https://docs.datadoghq.com/real\_user\_monitoring/platform/connect\_rum\_and\_traces/?tab=browserrum) for further information. - -**Signature:** - -```typescript -traceSampleRate?: number | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate + +## RumInitConfiguration.traceSampleRate property + +The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. + +**Signature:** + +```typescript +traceSampleRate?: number | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md b/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md deleted file mode 100644 index a5996d142c..0000000000 --- a/docs/browser-rum.ruminitconfiguration.trackbfcacheviews.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackBfcacheViews - -## RumInitConfiguration.trackBfcacheViews property - -Enable the creation of dedicated views for pages restored from the Back-Forward cache. false - -**Signature:** - -```typescript -trackBfcacheViews?: boolean | undefined; -``` diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 141af07344..2218e7c683 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents - -## RumInitConfiguration.trackFeatureFlagsForEvents property - -Enables collection of features flags in chosen events. - -**Signature:** - -```typescript -trackFeatureFlagsForEvents?: FeatureFlagsForEvents[]; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents + +## RumInitConfiguration.trackFeatureFlagsForEvents property + +Enables collection of features flags in chosen events. + +**Signature:** + +```typescript +trackFeatureFlagsForEvents?: FeatureFlagsForEvents[]; +``` diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 03427fbd78..53abd056be 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackLongTasks - -## RumInitConfiguration.trackLongTasks property - -Enables collection of long task events. true - -**Signature:** - -```typescript -trackLongTasks?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks + +## RumInitConfiguration.trackLongTasks property + +Enables collection of long task events. true + +**Signature:** + +```typescript +trackLongTasks?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index e0c1083fd3..0b664eeccc 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackResources - -## RumInitConfiguration.trackResources property - -Enables collection of resource events. true - -**Signature:** - -```typescript -trackResources?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > trackResources + +## RumInitConfiguration.trackResources property + +Enables collection of resource events. true + +**Signature:** + +```typescript +trackResources?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index dccc0bddcb..caa0fa1228 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions - -## RumInitConfiguration.trackUserInteractions property - -Enables automatic collection of users actions. See \[Tracking User Actions\](https://docs.datadoghq.com/real\_user\_monitoring/browser/tracking\_user\_actions) for further information. true - -**Signature:** - -```typescript -trackUserInteractions?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions + +## RumInitConfiguration.trackUserInteractions property + +Enables automatic collection of users actions. See Tracking User Actions for further information. true + +**Signature:** + +```typescript +trackUserInteractions?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index 873ec22613..034b05d192 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > trackViewsManually - -## RumInitConfiguration.trackViewsManually property - -Allows you to control RUM views creation. See \[Override default RUM view names\](https://docs.datadoghq.com/real\_user\_monitoring/browser/advanced\_configuration/?tab=npm\#override-default-rum-view-names) for further information. - -**Signature:** - -```typescript -trackViewsManually?: boolean | undefined; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually + +## RumInitConfiguration.trackViewsManually property + +Allows you to control RUM views creation. See Override default RUM view names for further information. + +**Signature:** + +```typescript +trackViewsManually?: boolean | undefined; +``` diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index 57d2fb24c5..cb9058951e 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,13 +1,13 @@ - - -[Home](index.html) > @datadog/browser-rum > RumInitConfiguration > workerUrl - -## RumInitConfiguration.workerUrl property - -URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See \[Content Security Policy guidelines\](https://docs.datadoghq.com/integrations/content\_security\_policy\_logs/?tab=firefox\#use-csp-with-real-user-monitoring-and-session-replay) for further information. - -**Signature:** - -```typescript -workerUrl?: string; -``` + + +Home > @datadog/browser-rum > RumInitConfiguration > workerUrl + +## RumInitConfiguration.workerUrl property + +URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. + +**Signature:** + +```typescript +workerUrl?: string; +``` diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 8ec48e81e6..087df04cb1 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,56 +1,48 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEvent - -## RumLongTaskEvent type - -Schema of all properties of a Long Task event - -**Signature:** - -```typescript -export type RumLongTaskEvent = CommonProperties & - ActionChildProperties & - ViewContainerSchema & { - readonly type: 'long_task' - readonly long_task: { - readonly id?: string - readonly start_time?: number - readonly entry_type?: 'long-task' | 'long-animation-frame' - readonly duration: number - readonly blocking_duration?: number - readonly render_start?: number - readonly style_and_layout_start?: number - readonly first_ui_event_timestamp?: number - readonly is_frozen_frame?: boolean - readonly scripts?: { - readonly duration?: number - readonly pause_duration?: number - readonly forced_style_and_layout_duration?: number - readonly start_time?: number - readonly execution_start?: number - source_url?: string - readonly source_function_name?: string - readonly source_char_position?: number - invoker?: string - readonly invoker_type?: - | 'user-callback' - | 'event-listener' - | 'resolve-promise' - | 'reject-promise' - | 'classic-script' - | 'module-script' - readonly window_attribution?: string - [k: string]: unknown - }[] - [k: string]: unknown - } - readonly _dd?: { - readonly discarded?: boolean - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumLongTaskEvent + +## RumLongTaskEvent type + +Schema of all properties of a Long Task event + +**Signature:** + +```typescript +export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'long_task'; + readonly long_task: { + readonly id?: string; + readonly start_time?: number; + readonly entry_type?: 'long-task' | 'long-animation-frame'; + readonly duration: number; + readonly blocking_duration?: number; + readonly render_start?: number; + readonly style_and_layout_start?: number; + readonly first_ui_event_timestamp?: number; + readonly is_frozen_frame?: boolean; + readonly scripts?: { + readonly duration?: number; + readonly pause_duration?: number; + readonly forced_style_and_layout_duration?: number; + readonly start_time?: number; + readonly execution_start?: number; + source_url?: string; + readonly source_function_name?: string; + readonly source_char_position?: number; + invoker?: string; + readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; + readonly window_attribution?: string; + [k: string]: unknown; + }[]; + [k: string]: unknown; + }; + readonly _dd?: { + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index c71b171430..5cbedaa0de 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,41 +1,53 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext - -## RumLongTaskEventDomainContext interface - -**Signature:** - -```typescript -export interface RumLongTaskEventDomainContext -``` - -## Properties - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
performanceEntry - - - -PerformanceEntry - - - -
+ + +Home > @datadog/browser-rum > RumLongTaskEventDomainContext + +## RumLongTaskEventDomainContext interface + +**Signature:** + +```typescript +export interface RumLongTaskEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +performanceEntry + + + + + + + +PerformanceEntry + + + + + +
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 9f956a4d5f..b021dcdd15 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry - -## RumLongTaskEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry -``` + + +Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry + +## RumLongTaskEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index ad64f7eeee..9a9f01ed4f 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,41 +1,53 @@ - - -[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext - -## RumOtherResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumOtherResourceEventDomainContext -``` - -## Properties - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
performanceEntry - - - -PerformanceEntry - - - -
+ + +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext + +## RumOtherResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumOtherResourceEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +performanceEntry + + + + + + + +PerformanceEntry + + + + + +
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index ef8646f396..34f298af97 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry - -## RumOtherResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry: PerformanceEntry -``` + + +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry + +## RumOtherResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 5ee6548e2f..95c4221084 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,116 +1,89 @@ - - -[Home](index.html) > @datadog/browser-rum > RumResourceEvent - -## RumResourceEvent type - -Schema of all properties of a Resource event - -**Signature:** - -```typescript -export type RumResourceEvent = CommonProperties & - ActionChildProperties & - ViewContainerSchema & { - readonly type: 'resource' - readonly resource: { - readonly id?: string - readonly type: - | 'document' - | 'xhr' - | 'beacon' - | 'fetch' - | 'css' - | 'js' - | 'image' - | 'font' - | 'media' - | 'other' - | 'native' - readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT' - url: string - readonly status_code?: number - readonly duration?: number - readonly size?: number - readonly encoded_body_size?: number - readonly decoded_body_size?: number - readonly transfer_size?: number - readonly render_blocking_status?: 'blocking' | 'non-blocking' - readonly worker?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly redirect?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly dns?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly connect?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly ssl?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly first_byte?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly download?: { - readonly duration: number - readonly start: number - [k: string]: unknown - } - readonly protocol?: string - readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other' - readonly provider?: { - readonly domain?: string - readonly name?: string - readonly type?: - | 'ad' - | 'advertising' - | 'analytics' - | 'cdn' - | 'content' - | 'customer-success' - | 'first party' - | 'hosting' - | 'marketing' - | 'other' - | 'social' - | 'tag-manager' - | 'utility' - | 'video' - [k: string]: unknown - } - readonly graphql?: { - readonly operationType: 'query' | 'mutation' | 'subscription' - readonly operationName?: string - payload?: string - variables?: string - [k: string]: unknown - } - [k: string]: unknown - } - readonly _dd?: { - readonly span_id?: string - readonly trace_id?: string - readonly rule_psr?: number - readonly discarded?: boolean - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumResourceEvent + +## RumResourceEvent type + +Schema of all properties of a Resource event + +**Signature:** + +```typescript +export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { + readonly type: 'resource'; + readonly resource: { + readonly id?: string; + readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; + readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + url: string; + readonly status_code?: number; + readonly duration?: number; + readonly size?: number; + readonly encoded_body_size?: number; + readonly decoded_body_size?: number; + readonly transfer_size?: number; + readonly render_blocking_status?: 'blocking' | 'non-blocking'; + readonly worker?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly redirect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly dns?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly connect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly ssl?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly first_byte?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly download?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly protocol?: string; + readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + readonly graphql?: { + readonly operationType: 'query' | 'mutation' | 'subscription'; + readonly operationName?: string; + payload?: string; + variables?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly span_id?: string; + readonly trace_id?: string; + readonly rule_psr?: number; + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 4b4fad8835..ed9e9f1f36 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,152 +1,143 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEvent - -## RumViewEvent type - -Schema of all properties of a View event - -**Signature:** - -```typescript -export type RumViewEvent = CommonProperties & - ViewContainerSchema & { - readonly type: 'view' - readonly view: { - readonly loading_time?: number - readonly network_settled_time?: number - readonly interaction_to_next_view_time?: number - readonly loading_type?: - | 'initial_load' - | 'route_change' - | 'activity_display' - | 'activity_redisplay' - | 'fragment_display' - | 'fragment_redisplay' - | 'view_controller_display' - | 'view_controller_redisplay' - readonly time_spent: number - readonly first_contentful_paint?: number - readonly largest_contentful_paint?: number - readonly largest_contentful_paint_target_selector?: string - readonly first_input_delay?: number - readonly first_input_time?: number - readonly first_input_target_selector?: string - readonly interaction_to_next_paint?: number - readonly interaction_to_next_paint_time?: number - readonly interaction_to_next_paint_target_selector?: string - readonly cumulative_layout_shift?: number - readonly cumulative_layout_shift_time?: number - readonly cumulative_layout_shift_target_selector?: string - readonly dom_complete?: number - readonly dom_content_loaded?: number - readonly dom_interactive?: number - readonly load_event?: number - readonly first_byte?: number - readonly custom_timings?: { - [k: string]: number - } - readonly is_active?: boolean - readonly is_slow_rendered?: boolean - readonly action: { - readonly count: number - [k: string]: unknown - } - readonly error: { - readonly count: number - [k: string]: unknown - } - readonly crash?: { - readonly count: number - [k: string]: unknown - } - readonly long_task?: { - readonly count: number - [k: string]: unknown - } - readonly frozen_frame?: { - readonly count: number - [k: string]: unknown - } - readonly slow_frames?: { - readonly start: number - readonly duration: number - [k: string]: unknown - }[] - readonly resource: { - readonly count: number - [k: string]: unknown - } - readonly frustration?: { - readonly count: number - [k: string]: unknown - } - readonly in_foreground_periods?: { - readonly start: number - readonly duration: number - [k: string]: unknown - }[] - readonly memory_average?: number - readonly memory_max?: number - readonly cpu_ticks_count?: number - readonly cpu_ticks_per_second?: number - readonly refresh_rate_average?: number - readonly refresh_rate_min?: number - readonly slow_frames_rate?: number - readonly freeze_rate?: number - flutter_build_time?: RumPerfMetric - flutter_raster_time?: RumPerfMetric - js_refresh_rate?: RumPerfMetric - performance?: ViewPerformanceData - [k: string]: unknown - } - readonly session?: { - readonly is_active?: boolean - readonly sampled_for_replay?: boolean - [k: string]: unknown - } - readonly feature_flags?: { - [k: string]: unknown - } - readonly privacy?: { - readonly replay_level: 'allow' | 'mask' | 'mask-user-input' - [k: string]: unknown - } - readonly _dd: { - readonly document_version: number - readonly page_states?: { - readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated' - readonly start: number - [k: string]: unknown - }[] - replay_stats?: { - records_count?: number - segments_count?: number - segments_total_raw_size?: number - [k: string]: unknown - } - readonly cls?: { - readonly device_pixel_ratio?: number - [k: string]: unknown - } - readonly configuration?: { - readonly start_session_replay_recording_manually?: boolean - [k: string]: unknown - } - [k: string]: unknown - } - readonly display?: { - readonly scroll?: { - readonly max_depth: number - readonly max_depth_scroll_top: number - readonly max_scroll_height: number - readonly max_scroll_height_time: number - [k: string]: unknown - } - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumViewEvent + +## RumViewEvent type + +Schema of all properties of a View event + +**Signature:** + +```typescript +export type RumViewEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'view'; + readonly view: { + readonly loading_time?: number; + readonly network_settled_time?: number; + readonly interaction_to_next_view_time?: number; + readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; + readonly time_spent: number; + readonly first_contentful_paint?: number; + readonly largest_contentful_paint?: number; + readonly largest_contentful_paint_target_selector?: string; + readonly first_input_delay?: number; + readonly first_input_time?: number; + readonly first_input_target_selector?: string; + readonly interaction_to_next_paint?: number; + readonly interaction_to_next_paint_time?: number; + readonly interaction_to_next_paint_target_selector?: string; + readonly cumulative_layout_shift?: number; + readonly cumulative_layout_shift_time?: number; + readonly cumulative_layout_shift_target_selector?: string; + readonly dom_complete?: number; + readonly dom_content_loaded?: number; + readonly dom_interactive?: number; + readonly load_event?: number; + readonly first_byte?: number; + readonly custom_timings?: { + [k: string]: number; + }; + readonly is_active?: boolean; + readonly is_slow_rendered?: boolean; + readonly action: { + readonly count: number; + [k: string]: unknown; + }; + readonly error: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly frozen_frame?: { + readonly count: number; + [k: string]: unknown; + }; + readonly slow_frames?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly resource: { + readonly count: number; + [k: string]: unknown; + }; + readonly frustration?: { + readonly count: number; + [k: string]: unknown; + }; + readonly in_foreground_periods?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly memory_average?: number; + readonly memory_max?: number; + readonly cpu_ticks_count?: number; + readonly cpu_ticks_per_second?: number; + readonly refresh_rate_average?: number; + readonly refresh_rate_min?: number; + readonly slow_frames_rate?: number; + readonly freeze_rate?: number; + flutter_build_time?: RumPerfMetric; + flutter_raster_time?: RumPerfMetric; + js_refresh_rate?: RumPerfMetric; + performance?: ViewPerformanceData; + [k: string]: unknown; + }; + readonly session?: { + readonly is_active?: boolean; + readonly sampled_for_replay?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + readonly privacy?: { + readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; + [k: string]: unknown; + }; + readonly _dd: { + readonly document_version: number; + readonly page_states?: { + readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; + readonly start: number; + [k: string]: unknown; + }[]; + replay_stats?: { + records_count?: number; + segments_count?: number; + segments_total_raw_size?: number; + [k: string]: unknown; + }; + readonly cls?: { + readonly device_pixel_ratio?: number; + [k: string]: unknown; + }; + readonly configuration?: { + readonly start_session_replay_recording_manually?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly display?: { + readonly scroll?: { + readonly max_depth: number; + readonly max_depth_scroll_top: number; + readonly max_scroll_height: number; + readonly max_scroll_height_time: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 661aeef2a7..9d9de5fb06 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext > location - -## RumViewEventDomainContext.location property - -**Signature:** - -```typescript -location: Readonly -``` + + +Home > @datadog/browser-rum > RumViewEventDomainContext > location + +## RumViewEventDomainContext.location property + +**Signature:** + +```typescript +location: Readonly; +``` diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index f7264adf5f..a1e9e078e4 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,41 +1,53 @@ - - -[Home](index.html) > @datadog/browser-rum > RumViewEventDomainContext - -## RumViewEventDomainContext interface - -**Signature:** - -```typescript -export interface RumViewEventDomainContext -``` - -## Properties - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
location - - - -Readonly<Location> - - - -
+ + +Home > @datadog/browser-rum > RumViewEventDomainContext + +## RumViewEventDomainContext interface + +**Signature:** + +```typescript +export interface RumViewEventDomainContext +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +location + + + + + + + +Readonly<Location> + + + + + +
diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index d8b0ded056..d4a1ff2009 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,37 +1,36 @@ - - -[Home](index.html) > @datadog/browser-rum > RumVitalEvent - -## RumVitalEvent type - -Schema of all properties of a Vital event - -**Signature:** - -```typescript -export type RumVitalEvent = CommonProperties & - ViewContainerSchema & { - readonly type: 'vital' - readonly vital: { - readonly type: 'duration' - readonly id: string - readonly name?: string - readonly description?: string - readonly duration?: number - readonly custom?: { - [k: string]: number - } - [k: string]: unknown - } - readonly _dd?: { - readonly vital?: { - readonly computed_value?: boolean - [k: string]: unknown - } - [k: string]: unknown - } - [k: string]: unknown - } -``` - -**References:** [CommonProperties](./browser-rum.commonproperties.md) + + +Home > @datadog/browser-rum > RumVitalEvent + +## RumVitalEvent type + +Schema of all properties of a Vital event + +**Signature:** + +```typescript +export type RumVitalEvent = CommonProperties & ViewContainerSchema & { + readonly type: 'vital'; + readonly vital: { + readonly type: 'duration'; + readonly id: string; + readonly name?: string; + readonly description?: string; + readonly duration?: number; + readonly custom?: { + [k: string]: number; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly vital?: { + readonly computed_value?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; +}; +``` +**References:** CommonProperties + diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 691593bbf8..70318d0eba 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack - -## RumXhrResourceEventDomainContext.handlingStack property - -**Signature:** - -```typescript -handlingStack?: string; -``` + + +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack + +## RumXhrResourceEventDomainContext.handlingStack property + +**Signature:** + +```typescript +handlingStack?: string; +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 28fc7c27f7..9b36439211 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted - -## RumXhrResourceEventDomainContext.isAborted property - -**Signature:** - -```typescript -isAborted: boolean -``` + + +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted + +## RumXhrResourceEventDomainContext.isAborted property + +**Signature:** + +```typescript +isAborted: boolean; +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 0242997241..7f17b83b05 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,72 +1,108 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext - -## RumXhrResourceEventDomainContext interface - -**Signature:** - -```typescript -export interface RumXhrResourceEventDomainContext -``` - -## Properties - - - - - - -
- -Property - - - -Modifiers - - - -Type - - - -Description - -
handlingStack? - - - -string - - - -_(Optional)_ - -
isAborted - - - -boolean - - - -
performanceEntry? - - - -PerformanceEntry - - - -_(Optional)_ - -
xhr - - - -XMLHttpRequest - - - -
+ + +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext + +## RumXhrResourceEventDomainContext interface + +**Signature:** + +```typescript +export interface RumXhrResourceEventDomainContext +``` + +## Properties + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +handlingStack? + + + + + + + +string + + + + +_(Optional)_ + + +
+ +isAborted + + + + + + + +boolean + + + + + +
+ +performanceEntry? + + + + + + + +PerformanceEntry + + + + +_(Optional)_ + + +
+ +xhr + + + + + + + +XMLHttpRequest + + + + + +
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 44258dd111..5386c6364a 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry - -## RumXhrResourceEventDomainContext.performanceEntry property - -**Signature:** - -```typescript -performanceEntry?: PerformanceEntry; -``` + + +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry + +## RumXhrResourceEventDomainContext.performanceEntry property + +**Signature:** + +```typescript +performanceEntry?: PerformanceEntry; +``` diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index adaa4ba492..f5dceaf156 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,11 +1,11 @@ - - -[Home](index.html) > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr - -## RumXhrResourceEventDomainContext.xhr property - -**Signature:** - -```typescript -xhr: XMLHttpRequest -``` + + +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr + +## RumXhrResourceEventDomainContext.xhr property + +**Signature:** + +```typescript +xhr: XMLHttpRequest; +``` diff --git a/docs/index.md b/docs/index.md index b2603ded60..e25398a604 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,30 +1,56 @@ - - -[Home](index.html) - -## API Reference - -## Packages - - - - - - -
- -Package - - - -Description - -
@datadog/browser-logs - -
@datadog/browser-rum - -
@datadog/browser-rum-react - -
@datadog/browser-rum-slim - -
+ + +Home + +## API Reference + +## Packages + + + + + + +
+ +Package + + + + +Description + + +
+ +@datadog/browser-logs + + + + + +
+ +@datadog/browser-rum + + + + + +
+ +@datadog/browser-rum-react + + + + + +
+ +@datadog/browser-rum-slim + + + + + +
diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json index ff1321a4d4..d7dec6a2d3 100644 --- a/etc/browser-logs.api.json +++ b/etc/browser-logs.api.json @@ -1,3521 +1,3521 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-logs!", - "docComment": "", - "name": "@datadog/browser-logs", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-logs!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!datadogLogs:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogLogs: " - }, - { - "kind": "Reference", - "text": "LogsPublicApi", - "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface" - } - ], - "fileUrlPath": "packages/logs/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogLogs", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!HandlerType:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type HandlerType = " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:var" - }, - { - "kind": "Content", - "text": ")[keyof typeof " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:var" - }, - { - "kind": "Content", - "text": "]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "HandlerType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!HandlerType:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "HandlerType: " - }, - { - "kind": "Content", - "text": "{\n readonly console: \"console\";\n readonly http: \"http\";\n readonly silent: \"silent\";\n}" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "HandlerType", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "@datadog/browser-logs!Logger:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Logger " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "Logger", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@datadog/browser-logs!Logger:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Logger` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(handleLogStrategy: " - }, - { - "kind": "Content", - "text": "(logsMessage: " - }, - { - "kind": "Reference", - "text": "LogsMessage", - "canonicalReference": "@datadog/browser-logs!LogsMessage:interface" - }, - { - "kind": "Content", - "text": ", logger: " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ", handlingStack?: string) => void" - }, - { - "kind": "Content", - "text": ", name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", handlerType?: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ", level?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", loggerContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handleLogStrategy", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "handlerType", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "isOptional": true - }, - { - "parameterName": "level", - "parameterTypeTokenRange": { - "startIndex": 14, - "endIndex": 15 - }, - "isOptional": true - }, - { - "parameterName": "loggerContext", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ] - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#clearContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearContext(): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "clearContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getContext(): " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getHandler:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getHandler(): " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getHandler" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#getLevel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLevel(): " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "getLevel" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#log:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "log(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", status?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "status", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "log" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#logImplementation:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "logImplementation(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", status?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "status", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "handlingStack", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "logImplementation" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#removeContextProperty:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeContextProperty(key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "removeContextProperty" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setContext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setContext(context: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setContext" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setContextProperty:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setContextProperty(key: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", value: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "key", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "value", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setContextProperty" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setHandler:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setHandler(handler: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "handler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setHandler" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-logs!Logger#setLevel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setLevel(level: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "level", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "setLevel" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!Logger:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Logger " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "Logger", - "preserveMemberOrder": false, - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "alert(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "alert" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "critical(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "critical" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "debug(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "debug" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "emerg(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "emerg" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "error" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "info(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "info" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "notice(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "notice" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ok(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "ok" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "warn(message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", messageContext?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ", error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "messageContext", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - }, - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "name": "warn" - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LoggerConfiguration " - } - ], - "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", - "releaseTag": "Public", - "name": "LoggerConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Content", - "text": "object" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#handler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handler?: " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "HandlerType", - "canonicalReference": "@datadog/browser-logs!HandlerType:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#level:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "level?: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "level", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsEvent " - } - ], - "fileUrlPath": "packages/logs/esm/logsEvent.types.d.ts", - "releaseTag": "Public", - "name": "LogsEvent", - "preserveMemberOrder": false, - "members": [ - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#application_id:member", - "docComment": "/**\n * UUID of the application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "application_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "application_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#date:member", - "docComment": "/**\n * Start of the log in ms from epoch\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "date: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#error:member", - "docComment": "/**\n * Error properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "error?: " - }, - { - "kind": "Content", - "text": "{\n kind?: string;\n stack?: string;\n fingerprint?: string;\n message?: string;\n causes?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<{\n message: string;\n source: string;\n type?: string;\n stack?: string;\n }>;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#http:member", - "docComment": "/**\n * Resource properties of the error\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "http?: " - }, - { - "kind": "Content", - "text": "{\n method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH';\n status_code: number;\n url: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "http", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#logger:member", - "docComment": "/**\n * Logger properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "logger?: " - }, - { - "kind": "Content", - "text": "{\n name: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "logger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#message:member", - "docComment": "/**\n * The log message\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#origin:member", - "docComment": "/**\n * Origin of the log\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "origin: " - }, - { - "kind": "Content", - "text": "'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "origin", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#service:member", - "docComment": "/**\n * The service name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#session_id:member", - "docComment": "/**\n * UUID of the session (deprecated in favor of session.id)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "session_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "session_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#session:member", - "docComment": "/**\n * Session properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "session?: " - }, - { - "kind": "Content", - "text": "{\n id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "session", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#status:member", - "docComment": "/**\n * The log status\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "status: " - }, - { - "kind": "Content", - "text": "'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "status", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsEvent#view:member", - "docComment": "/**\n * View properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "view: " - }, - { - "kind": "Content", - "text": "{\n referrer?: string;\n url: string;\n id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type LogsEventDomainContext = " - }, - { - "kind": "Content", - "text": "T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.NETWORK", - "canonicalReference": "@datadog/browser-core!__type#NETWORK:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "NetworkLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~NetworkLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.CONSOLE", - "canonicalReference": "@datadog/browser-core!__type#CONSOLE:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "ConsoleLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~ConsoleLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : T extends typeof " - }, - { - "kind": "Reference", - "text": "ErrorSource.LOGGER", - "canonicalReference": "@datadog/browser-core!__type#LOGGER:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "LoggerLogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!~LoggerLogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": " : never" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "LogsEventDomainContext", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 18 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsPublicApi extends " - }, - { - "kind": "Reference", - "text": "PublicApi", - "canonicalReference": "@datadog/browser-core!PublicApi:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", - "releaseTag": "Public", - "name": "LogsGlobal", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearAccount:member", - "docComment": "/**\n * Clear all account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearAccount: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearGlobalContext:member", - "docComment": "/**\n * Clear the global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearGlobalContext: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearUser:member", - "docComment": "/**\n * Clear all user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearUser: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#createLogger:member", - "docComment": "/**\n * The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones.\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "createLogger: " - }, - { - "kind": "Content", - "text": "(name: string, conf?: " - }, - { - "kind": "Reference", - "text": "LoggerConfiguration", - "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "createLogger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getAccount:member", - "docComment": "/**\n * Get account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAccount: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getGlobalContext:member", - "docComment": "/**\n * Get the global Context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getGlobalContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInitConfiguration:member", - "docComment": "/**\n * Get the init configuration\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInitConfiguration: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "LogsInitConfiguration", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInitConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInternalContext:member", - "docComment": "/**\n * [Internal API] Get the internal SDK context\n *\n * See [Access internal context](https://docs.datadoghq.com/logs/log_collection/javascript/#access-internal-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Content", - "text": "(startTime?: number) => " - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-logs!~InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getLogger:member", - "docComment": "/**\n * Get a logger\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLogger: " - }, - { - "kind": "Content", - "text": "(name: string) => " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getLogger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#getUser:member", - "docComment": "/**\n * Get user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getUser: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#init:member", - "docComment": "/**\n * Init the Logs browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [Browser Log Collection](https://docs.datadoghq.com/logs/log_collection/javascript) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "LogsInitConfiguration", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#logger:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "logger: " - }, - { - "kind": "Reference", - "text": "Logger", - "canonicalReference": "@datadog/browser-logs!Logger:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "logger", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeAccountProperty:member", - "docComment": "/**\n * Remove an account property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeGlobalContextProperty:member", - "docComment": "/**\n * Remove a global context property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeUserProperty:member", - "docComment": "/**\n * Remove a user property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccount:member", - "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccount: " - }, - { - "kind": "Content", - "text": "(newAccount: " - }, - { - "kind": "Reference", - "text": "Account", - "canonicalReference": "@datadog/browser-core!Account:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccountProperty:member", - "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContext:member", - "docComment": "/**\n * Set the global context information to all logs, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContext: " - }, - { - "kind": "Content", - "text": "(context: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContextProperty:member", - "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setTrackingConsent:member", - "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Logs will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTrackingConsent: " - }, - { - "kind": "Content", - "text": "(trackingConsent: " - }, - { - "kind": "Reference", - "text": "TrackingConsent", - "canonicalReference": "@datadog/browser-core!TrackingConsent:type" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setTrackingConsent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(1)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": " & {\n id: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(2)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specified a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUserProperty:member", - "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsInitConfiguration extends " - }, - { - "kind": "Reference", - "text": "InitConfiguration", - "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/logs/esm/domain/configuration.d.ts", - "releaseTag": "Public", - "name": "LogsInitConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#beforeSend:member", - "docComment": "/**\n * Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "beforeSend?: " - }, - { - "kind": "Content", - "text": "((event: " - }, - { - "kind": "Reference", - "text": "LogsEvent", - "canonicalReference": "@datadog/browser-logs!LogsEvent:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "LogsEventDomainContext", - "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type" - }, - { - "kind": "Content", - "text": ") => boolean) | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "beforeSend", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardConsoleLogs:member", - "docComment": "/**\n * Forward logs from console.* to Datadog. Use \"all\" to forward everything or an array of console API names to forward only a subset.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardConsoleLogs?: " - }, - { - "kind": "Reference", - "text": "ConsoleApiName", - "canonicalReference": "@datadog/browser-core!ConsoleApiName:type" - }, - { - "kind": "Content", - "text": "[] | 'all' | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardConsoleLogs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardErrorsToLogs:member", - "docComment": "/**\n * Forward console.error logs, uncaught exceptions and network errors to Datadog. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardErrorsToLogs?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardErrorsToLogs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardReports:member", - "docComment": "/**\n * Forward reports from the [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) to Datadog. Use \"all\" to forward everything or an array of report types to forward only a subset.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "forwardReports?: " - }, - { - "kind": "Reference", - "text": "RawReportType", - "canonicalReference": "@datadog/browser-core!RawReportType:type" - }, - { - "kind": "Content", - "text": "[] | 'all' | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "forwardReports", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#usePciIntake:member", - "docComment": "/**\n * Use PCI-compliant intake. See [PCI DSS Compliance](https://docs.datadoghq.com/data_security/pci_compliance/?tab=logmanagement) for further information. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "usePciIntake?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "usePciIntake", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface LogsMessage " - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", - "releaseTag": "Public", - "name": "LogsMessage", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "status: " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "status", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-logs!StatusType:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type StatusType = " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:var" - }, - { - "kind": "Content", - "text": ")[keyof typeof " - }, - { - "kind": "Reference", - "text": "StatusType", - "canonicalReference": "@datadog/browser-logs!StatusType:var" - }, - { - "kind": "Content", - "text": "]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", - "releaseTag": "Public", - "name": "StatusType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-logs!StatusType:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "StatusType: " - }, - { - "kind": "Content", - "text": "{\n readonly ok: \"ok\";\n readonly debug: \"debug\";\n readonly info: \"info\";\n readonly notice: \"notice\";\n readonly warn: \"warn\";\n readonly error: \"error\";\n readonly critical: \"critical\";\n readonly alert: \"alert\";\n readonly emerg: \"emerg\";\n}" - } - ], - "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "StatusType", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-logs!", + "docComment": "", + "name": "@datadog/browser-logs", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-logs!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!datadogLogs:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogLogs: " + }, + { + "kind": "Reference", + "text": "LogsPublicApi", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface" + } + ], + "fileUrlPath": "packages/logs/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogLogs", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!HandlerType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type HandlerType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "HandlerType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!HandlerType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "HandlerType: " + }, + { + "kind": "Content", + "text": "{\n readonly console: \"console\";\n readonly http: \"http\";\n readonly silent: \"silent\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "HandlerType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-logs!Logger:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-logs!Logger:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Logger` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(handleLogStrategy: " + }, + { + "kind": "Content", + "text": "(logsMessage: " + }, + { + "kind": "Reference", + "text": "LogsMessage", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface" + }, + { + "kind": "Content", + "text": ", logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ", handlingStack?: string) => void" + }, + { + "kind": "Content", + "text": ", name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", handlerType?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ", level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", loggerContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handleLogStrategy", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlerType", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "isOptional": true + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 14, + "endIndex": 15 + }, + "isOptional": true + }, + { + "parameterName": "loggerContext", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#clearContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearContext(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "clearContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContext(): " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHandler(): " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#getLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLevel(): " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "getLevel" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#log:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "log(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "log" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#logImplementation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logImplementation(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", status?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "status", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "handlingStack", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "logImplementation" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#removeContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "removeContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContext(context: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContext" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setContextProperty:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setContextProperty(key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", value: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setContextProperty" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setHandler:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setHandler(handler: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setHandler" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-logs!Logger#setLevel:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setLevel(level: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "setLevel" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!Logger:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Logger " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "Logger", + "preserveMemberOrder": false, + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "alert(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "alert" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "critical(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "critical" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "debug(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "debug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "emerg(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "emerg" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "error" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "info(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "info" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "notice(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "notice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ok(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "ok" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "warn(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", messageContext?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ", error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "messageContext", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "name": "warn" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LoggerConfiguration " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LoggerConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#handler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handler?: " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "HandlerType", + "canonicalReference": "@datadog/browser-logs!HandlerType:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration#level:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "level?: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsEvent " + } + ], + "fileUrlPath": "packages/logs/esm/logsEvent.types.d.ts", + "releaseTag": "Public", + "name": "LogsEvent", + "preserveMemberOrder": false, + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#application_id:member", + "docComment": "/**\n * UUID of the application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "application_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "application_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#date:member", + "docComment": "/**\n * Start of the log in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#error:member", + "docComment": "/**\n * Error properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Content", + "text": "{\n kind?: string;\n stack?: string;\n fingerprint?: string;\n message?: string;\n causes?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<{\n message: string;\n source: string;\n type?: string;\n stack?: string;\n }>;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#http:member", + "docComment": "/**\n * Resource properties of the error\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "http?: " + }, + { + "kind": "Content", + "text": "{\n method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH';\n status_code: number;\n url: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "http", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#logger:member", + "docComment": "/**\n * Logger properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger?: " + }, + { + "kind": "Content", + "text": "{\n name: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#message:member", + "docComment": "/**\n * The log message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#origin:member", + "docComment": "/**\n * Origin of the log\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "origin: " + }, + { + "kind": "Content", + "text": "'network' | 'source' | 'console' | 'logger' | 'agent' | 'report'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "origin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#service:member", + "docComment": "/**\n * The service name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session_id:member", + "docComment": "/**\n * UUID of the session (deprecated in favor of session.id)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "session?: " + }, + { + "kind": "Content", + "text": "{\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#status:member", + "docComment": "/**\n * The log status\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Content", + "text": "'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsEvent#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "view: " + }, + { + "kind": "Content", + "text": "{\n referrer?: string;\n url: string;\n id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type LogsEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.NETWORK", + "canonicalReference": "@datadog/browser-core!__type#NETWORK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "NetworkLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~NetworkLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.CONSOLE", + "canonicalReference": "@datadog/browser-core!__type#CONSOLE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "ConsoleLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~ConsoleLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : T extends typeof " + }, + { + "kind": "Reference", + "text": "ErrorSource.LOGGER", + "canonicalReference": "@datadog/browser-core!__type#LOGGER:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "LoggerLogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!~LoggerLogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "LogsEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 18 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/boot/logsPublicApi.d.ts", + "releaseTag": "Public", + "name": "LogsGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#createLogger:member", + "docComment": "/**\n * The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones.\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createLogger: " + }, + { + "kind": "Content", + "text": "(name: string, conf?: " + }, + { + "kind": "Reference", + "text": "LoggerConfiguration", + "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "createLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n *\n * See [Access internal context](https://docs.datadoghq.com/logs/log_collection/javascript/#access-internal-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-logs!~InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getLogger:member", + "docComment": "/**\n * Get a logger\n *\n * See [Define multiple loggers](https://docs.datadoghq.com/logs/log_collection/javascript/#define-multiple-loggers) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLogger: " + }, + { + "kind": "Content", + "text": "(name: string) => " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getLogger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#init:member", + "docComment": "/**\n * Init the Logs browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [Browser Log Collection](https://docs.datadoghq.com/logs/log_collection/javascript) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "LogsInitConfiguration", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#logger:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "logger: " + }, + { + "kind": "Reference", + "text": "Logger", + "canonicalReference": "@datadog/browser-logs!Logger:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "logger", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all logs, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Overwrite context](https://docs.datadoghq.com/logs/log_collection/javascript/#overwrite-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Logs will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specified a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User context](https://docs.datadoghq.com/logs/log_collection/javascript/#user-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/logs/esm/domain/configuration.d.ts", + "releaseTag": "Public", + "name": "LogsInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "LogsEvent", + "canonicalReference": "@datadog/browser-logs!LogsEvent:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "LogsEventDomainContext", + "canonicalReference": "@datadog/browser-logs!LogsEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardConsoleLogs:member", + "docComment": "/**\n * Forward logs from console.* to Datadog. Use \"all\" to forward everything or an array of console API names to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardConsoleLogs?: " + }, + { + "kind": "Reference", + "text": "ConsoleApiName", + "canonicalReference": "@datadog/browser-core!ConsoleApiName:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardConsoleLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardErrorsToLogs:member", + "docComment": "/**\n * Forward console.error logs, uncaught exceptions and network errors to Datadog. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardErrorsToLogs?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardErrorsToLogs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#forwardReports:member", + "docComment": "/**\n * Forward reports from the [Reporting API](https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API) to Datadog. Use \"all\" to forward everything or an array of report types to forward only a subset.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "forwardReports?: " + }, + { + "kind": "Reference", + "text": "RawReportType", + "canonicalReference": "@datadog/browser-core!RawReportType:type" + }, + { + "kind": "Content", + "text": "[] | 'all' | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "forwardReports", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration#usePciIntake:member", + "docComment": "/**\n * Use PCI-compliant intake. See [PCI DSS Compliance](https://docs.datadoghq.com/data_security/pci_compliance/?tab=logmanagement) for further information. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "usePciIntake?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "usePciIntake", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface LogsMessage " + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger.d.ts", + "releaseTag": "Public", + "name": "LogsMessage", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "status: " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-logs!StatusType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type StatusType = " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": ")[keyof typeof " + }, + { + "kind": "Reference", + "text": "StatusType", + "canonicalReference": "@datadog/browser-logs!StatusType:var" + }, + { + "kind": "Content", + "text": "]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "releaseTag": "Public", + "name": "StatusType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-logs!StatusType:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "StatusType: " + }, + { + "kind": "Content", + "text": "{\n readonly ok: \"ok\";\n readonly debug: \"debug\";\n readonly info: \"info\";\n readonly notice: \"notice\";\n readonly warn: \"warn\";\n readonly error: \"error\";\n readonly critical: \"critical\";\n readonly alert: \"alert\";\n readonly emerg: \"emerg\";\n}" + } + ], + "fileUrlPath": "packages/logs/esm/domain/logger/isAuthorized.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "StatusType", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json index b7e3f0d317..4a4c131f61 100644 --- a/etc/browser-rum-react.api.json +++ b/etc/browser-rum-react.api.json @@ -1,625 +1,625 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum-react!", - "docComment": "", - "name": "@datadog/browser-rum-react", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum-react!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function addReactError(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", info: " - }, - { - "kind": "Reference", - "text": "ErrorInfo", - "canonicalReference": "@types/react!React.ErrorInfo:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/error/addReactError.d.ts", - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "info", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "name": "addReactError" - }, - { - "kind": "Class", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class ErrorBoundary extends " - }, - { - "kind": "Reference", - "text": "React.Component", - "canonicalReference": "@types/react!React.Component:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Props", - "canonicalReference": "@datadog/browser-rum-react!~Props:interface" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@datadog/browser-rum-react!~State:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/error/errorBoundary.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "ErrorBoundary", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `ErrorBoundary` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(props: " - }, - { - "kind": "Reference", - "text": "Props", - "canonicalReference": "@datadog/browser-rum-react!~Props:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "props", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#componentDidCatch:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "componentDidCatch(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ", errorInfo: " - }, - { - "kind": "Reference", - "text": "ErrorInfo", - "canonicalReference": "@types/react!React.ErrorInfo:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "errorInfo", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "componentDidCatch" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary.getDerivedStateFromError:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "static getDerivedStateFromError(error: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@datadog/browser-rum-react!~State:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": true, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "error", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "getDerivedStateFromError" - }, - { - "kind": "Method", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#render:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "render(): " - }, - { - "kind": "Reference", - "text": "React.ReactNode", - "canonicalReference": "@types/react!React.ReactNode:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "render" - }, - { - "kind": "Property", - "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#resetError:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "resetError: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "resetError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 7 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function reactPlugin(configuration?: " - }, - { - "kind": "Reference", - "text": "ReactPluginConfiguration", - "canonicalReference": "@datadog/browser-rum-react!~ReactPluginConfiguration:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "{\n name: string;\n onInit({ publicApi, initConfiguration }: {\n initConfiguration: import(\"@datadog/browser-rum-core\")." - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ";\n publicApi: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - }, - { - "kind": "Content", - "text": ";\n }): void;\n onRumStart({ strategy }: {\n strategy: " - }, - { - "kind": "Reference", - "text": "Strategy", - "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" - }, - { - "kind": "Content", - "text": ";\n }): void;\n getConfigurationTelemetry(): {\n router: boolean;\n };\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/reactPlugin.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "configuration", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": true - } - ], - "name": "reactPlugin" - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UNSTABLE_ReactComponentTracker: " - }, - { - "kind": "Content", - "text": "({ " - }, - { - "kind": "Reference", - "text": "name", - "canonicalReference": "@datadog/browser-rum-react!~__type#name" - }, - { - "kind": "Content", - "text": ": componentName, children, }: {\n name: string;\n children?: " - }, - { - "kind": "Reference", - "text": "React.ReactNode", - "canonicalReference": "@types/react!React.ReactNode:type" - }, - { - "kind": "Content", - "text": ";\n}) => " - }, - { - "kind": "Reference", - "text": "React.JSX.Element", - "canonicalReference": "@types/react!React.JSX.Element:interface" - } - ], - "fileUrlPath": "packages/rum-react/esm/domain/performance/reactComponentTracker.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "UNSTABLE_ReactComponentTracker", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-react!", + "docComment": "", + "name": "@datadog/browser-rum-react", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-react!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function addReactError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", info: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/addReactError.d.ts", + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "info", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "name": "addReactError" + }, + { + "kind": "Class", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class ErrorBoundary extends " + }, + { + "kind": "Reference", + "text": "React.Component", + "canonicalReference": "@types/react!React.Component:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/error/errorBoundary.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "ErrorBoundary", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `ErrorBoundary` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(props: " + }, + { + "kind": "Reference", + "text": "Props", + "canonicalReference": "@datadog/browser-rum-react!~Props:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "props", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#componentDidCatch:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "componentDidCatch(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", errorInfo: " + }, + { + "kind": "Reference", + "text": "ErrorInfo", + "canonicalReference": "@types/react!React.ErrorInfo:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "errorInfo", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "componentDidCatch" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary.getDerivedStateFromError:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "static getDerivedStateFromError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@datadog/browser-rum-react!~State:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "getDerivedStateFromError" + }, + { + "kind": "Method", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#render:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "render(): " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [], + "isOptional": false, + "isAbstract": false, + "name": "render" + }, + { + "kind": "Property", + "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary#resetError:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "resetError: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "resetError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 7 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare function reactPlugin(configuration?: " + }, + { + "kind": "Reference", + "text": "ReactPluginConfiguration", + "canonicalReference": "@datadog/browser-rum-react!~ReactPluginConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "{\n name: string;\n onInit({ publicApi, initConfiguration }: {\n initConfiguration: import(\"@datadog/browser-rum-core\")." + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum-core!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ";\n publicApi: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n onRumStart({ strategy }: {\n strategy: " + }, + { + "kind": "Reference", + "text": "Strategy", + "canonicalReference": "@datadog/browser-rum-core!Strategy:interface" + }, + { + "kind": "Content", + "text": ";\n }): void;\n getConfigurationTelemetry(): {\n router: boolean;\n };\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/reactPlugin.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": true + } + ], + "name": "reactPlugin" + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UNSTABLE_ReactComponentTracker: " + }, + { + "kind": "Content", + "text": "({ " + }, + { + "kind": "Reference", + "text": "name", + "canonicalReference": "@datadog/browser-rum-react!~__type#name" + }, + { + "kind": "Content", + "text": ": componentName, children, }: {\n name: string;\n children?: " + }, + { + "kind": "Reference", + "text": "React.ReactNode", + "canonicalReference": "@types/react!React.ReactNode:type" + }, + { + "kind": "Content", + "text": ";\n}) => " + }, + { + "kind": "Reference", + "text": "React.JSX.Element", + "canonicalReference": "@types/react!React.JSX.Element:interface" + } + ], + "fileUrlPath": "packages/rum-react/esm/domain/performance/reactComponentTracker.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "UNSTABLE_ReactComponentTracker", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + } + ] + } + ] +} diff --git a/etc/browser-rum-slim.api.json b/etc/browser-rum-slim.api.json index 4de64a9086..0789ce2570 100644 --- a/etc/browser-rum-slim.api.json +++ b/etc/browser-rum-slim.api.json @@ -1,202 +1,202 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum-slim!", - "docComment": "", - "name": "@datadog/browser-rum-slim", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum-slim!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogRum: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" - } - ], - "fileUrlPath": "packages/rum-slim/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogRum", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum-slim!", + "docComment": "", + "name": "@datadog/browser-rum-slim", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum-slim!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum-core!RumPublicApi:interface" + } + ], + "fileUrlPath": "packages/rum-slim/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index 7ed5ae614f..4933b269fd 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -1,3872 +1,3845 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.38.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@datadog/browser-rum!", - "docComment": "", - "name": "@datadog/browser-rum", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@datadog/browser-rum!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface", - "docComment": "/**\n * Schema of common properties of RUM events\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface CommonProperties " - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "CommonProperties", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#_dd:member", - "docComment": "/**\n * Internal properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly _dd: " - }, - { - "kind": "Content", - "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "_dd", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "IndexSignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties:index(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "[k: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "]: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "k", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#account:member", - "docComment": "/**\n * Account properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly account?: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "account", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#application:member", - "docComment": "/**\n * Application properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly application: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "application", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#build_id:member", - "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#build_version:member", - "docComment": "/**\n * The build version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly build_version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "build_version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#ci_test:member", - "docComment": "/**\n * CI Visibility properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly ci_test?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "ci_test", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#connectivity:member", - "docComment": "/**\n * Device connectivity properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "connectivity?: " - }, - { - "kind": "Content", - "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "connectivity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#context:member", - "docComment": "/**\n * User provided context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "context?: " - }, - { - "kind": "Content", - "text": "{\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#date:member", - "docComment": "/**\n * Start of the event in ms from epoch\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly date: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "date", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#device:member", - "docComment": "/**\n * Device properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "device?: " - }, - { - "kind": "Content", - "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "device", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#display:member", - "docComment": "/**\n * Display properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "display?: " - }, - { - "kind": "Content", - "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "display", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#os:member", - "docComment": "/**\n * Operating system properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "os?: " - }, - { - "kind": "Content", - "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "os", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#service:member", - "docComment": "/**\n * The service name for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "service?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "service", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#session:member", - "docComment": "/**\n * Session properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly session: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "session", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#source:member", - "docComment": "/**\n * The source of this event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly source?: " - }, - { - "kind": "Content", - "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "source", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#synthetics:member", - "docComment": "/**\n * Synthetics properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly synthetics?: " - }, - { - "kind": "Content", - "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "synthetics", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#usr:member", - "docComment": "/**\n * User properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly usr?: " - }, - { - "kind": "Content", - "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": true, - "releaseTag": "Public", - "name": "usr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#version:member", - "docComment": "/**\n * The version for this application\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "version?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!CommonProperties#view:member", - "docComment": "/**\n * View properties\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly view: " - }, - { - "kind": "Content", - "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "view", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "@datadog/browser-rum!datadogRum:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "datadogRum: " - }, - { - "kind": "Reference", - "text": "RumPublicApi", - "canonicalReference": "@datadog/browser-rum!RumGlobal:interface" - } - ], - "fileUrlPath": "packages/rum/esm/entries/main.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "datadogRum", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumActionEvent:type", - "docComment": "/**\n * Schema of all properties of an Action event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumActionEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumActionEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumActionEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "events?: " - }, - { - "kind": "Reference", - "text": "Event", - "canonicalReference": "!Event:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "events", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type", - "docComment": "/**\n * Schema of all properties of an Error event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumErrorEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumErrorEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumErrorEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error: " - }, - { - "kind": "Content", - "text": "unknown" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumEvent:type", - "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEvent = " - }, - { - "kind": "Reference", - "text": "RumActionEvent", - "canonicalReference": "@datadog/browser-rum!RumActionEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumErrorEvent", - "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumLongTaskEvent", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumResourceEvent", - "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumViewEvent", - "canonicalReference": "@datadog/browser-rum!RumViewEvent:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumVitalEvent", - "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 12 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumEventDomainContext = " - }, - { - "kind": "Content", - "text": "T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VIEW", - "canonicalReference": "@datadog/browser-rum!RumEventType.VIEW:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumViewEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ACTION", - "canonicalReference": "@datadog/browser-rum!RumEventType.ACTION:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumActionEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.RESOURCE", - "canonicalReference": "@datadog/browser-rum!RumEventType.RESOURCE:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumFetchResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumXhrResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RumOtherResourceEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.ERROR", - "canonicalReference": "@datadog/browser-rum!RumEventType.ERROR:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumErrorEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.LONG_TASK", - "canonicalReference": "@datadog/browser-rum!RumEventType.LONG_TASK:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumLongTaskEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : T extends " - }, - { - "kind": "Reference", - "text": "RumEventType.VITAL", - "canonicalReference": "@datadog/browser-rum!RumEventType.VITAL:member" - }, - { - "kind": "Content", - "text": " ? " - }, - { - "kind": "Reference", - "text": "RumVitalEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" - }, - { - "kind": "Content", - "text": " : never" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumEventDomainContext", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 34 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumFetchResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumFetchResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "error?: " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "error", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInit?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "requestInit", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "requestInput: " - }, - { - "kind": "Reference", - "text": "RequestInfo", - "canonicalReference": "!RequestInfo:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "requestInput", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "response?: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "!Response:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "response", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumPublicApi extends " - }, - { - "kind": "Reference", - "text": "PublicApi", - "canonicalReference": "@datadog/browser-core!PublicApi:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", - "releaseTag": "Public", - "name": "RumGlobal", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addAction:member", - "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addAction: " - }, - { - "kind": "Content", - "text": "(name: string, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addAction", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addDurationVital:member", - "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addError:member", - "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addError: " - }, - { - "kind": "Content", - "text": "(error: unknown, context?: object) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addError", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addFeatureFlagEvaluation:member", - "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addFeatureFlagEvaluation: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addFeatureFlagEvaluation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#addTiming:member", - "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "addTiming: " - }, - { - "kind": "Content", - "text": "(name: string, time?: number) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "addTiming", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearAccount:member", - "docComment": "/**\n * Clear all account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearAccount: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearGlobalContext:member", - "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearGlobalContext: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#clearUser:member", - "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "clearUser: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "clearUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getAccount:member", - "docComment": "/**\n * Get account information\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getAccount: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getGlobalContext:member", - "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getGlobalContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getInitConfiguration:member", - "docComment": "/**\n * Get the init configuration\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInitConfiguration: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInitConfiguration", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getInternalContext:member", - "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getInternalContext: " - }, - { - "kind": "Content", - "text": "(startTime?: number) => " - }, - { - "kind": "Reference", - "text": "InternalContext", - "canonicalReference": "@datadog/browser-rum!InternalContext:interface" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getInternalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getSessionReplayLink:member", - "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getSessionReplayLink: " - }, - { - "kind": "Content", - "text": "() => string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getSessionReplayLink", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getUser:member", - "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getUser: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getUser", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#getViewContext:member", - "docComment": "/**\n * Get View Context.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getViewContext: " - }, - { - "kind": "Content", - "text": "() => " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "getViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#init:member", - "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "init: " - }, - { - "kind": "Content", - "text": "(initConfiguration: " - }, - { - "kind": "Reference", - "text": "RumInitConfiguration", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "init", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeAccountProperty:member", - "docComment": "/**\n * Remove an account property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeGlobalContextProperty:member", - "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#removeUserProperty:member", - "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "removeUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccount:member", - "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccount: " - }, - { - "kind": "Content", - "text": "(newAccount: " - }, - { - "kind": "Reference", - "text": "Account", - "canonicalReference": "@datadog/browser-core!Account:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccountProperty:member", - "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setAccountProperty: " - }, - { - "kind": "Content", - "text": "(key: string, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setAccountProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContext:member", - "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContext: " - }, - { - "kind": "Content", - "text": "(context: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContextProperty:member", - "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setGlobalContextProperty: " - }, - { - "kind": "Content", - "text": "(key: any, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setGlobalContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setTrackingConsent:member", - "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setTrackingConsent: " - }, - { - "kind": "Content", - "text": "(trackingConsent: " - }, - { - "kind": "Reference", - "text": "TrackingConsent", - "canonicalReference": "@datadog/browser-core!TrackingConsent:type" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setTrackingConsent", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(1)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": " & {\n id: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "MethodSignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(2)", - "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUser(newUser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@datadog/browser-core!User:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isOptional": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "newUser", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "setUser" - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setUserProperty:member", - "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setUserProperty: " - }, - { - "kind": "Content", - "text": "(key: any, property: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setUserProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContext:member", - "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContext: " - }, - { - "kind": "Content", - "text": "(context: " - }, - { - "kind": "Reference", - "text": "Context", - "canonicalReference": "@datadog/browser-core!Context:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContextProperty:member", - "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewContextProperty: " - }, - { - "kind": "Content", - "text": "(key: string, value: any) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewContextProperty", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewName:member", - "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "setViewName: " - }, - { - "kind": "Content", - "text": "(name: string) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "setViewName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startDurationVital:member", - "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startDurationVital: " - }, - { - "kind": "Content", - "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startSessionReplayRecording:member", - "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "(options?: " - }, - { - "kind": "Reference", - "text": "StartRecordingOptions", - "canonicalReference": "@datadog/browser-rum!StartRecordingOptions:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", - "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startView: " - }, - { - "kind": "Content", - "text": "{\n (name?: string): void;\n (options: " - }, - { - "kind": "Reference", - "text": "ViewOptions", - "canonicalReference": "@datadog/browser-rum!ViewOptions:interface" - }, - { - "kind": "Content", - "text": "): void;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "startView", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopDurationVital:member", - "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopDurationVital: " - }, - { - "kind": "Content", - "text": "(nameOrRef: string | " - }, - { - "kind": "Reference", - "text": "DurationVitalReference", - "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" - }, - { - "kind": "Content", - "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopDurationVital", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSession:member", - "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSession: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSession", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSessionReplayRecording:member", - "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "stopSessionReplayRecording: " - }, - { - "kind": "Content", - "text": "() => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stopSessionReplayRecording", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumInitConfiguration extends " - }, - { - "kind": "Reference", - "text": "InitConfiguration", - "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", - "releaseTag": "Public", - "name": "RumInitConfiguration", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#actionNameAttribute:member", - "docComment": "/**\n * Specify your own attribute to use to name actions. See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "actionNameAttribute?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "actionNameAttribute", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#allowedTracingUrls:member", - "docComment": "/**\n * A list of request URLs used to inject tracing headers. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "allowedTracingUrls?: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "TracingOption", - "canonicalReference": "@datadog/browser-rum!TracingOption:type" - }, - { - "kind": "Content", - "text": "> | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "allowedTracingUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#applicationId:member", - "docComment": "/**\n * The RUM application ID.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "applicationId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "applicationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#beforeSend:member", - "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "beforeSend?: " - }, - { - "kind": "Content", - "text": "((event: " - }, - { - "kind": "Reference", - "text": "RumEvent", - "canonicalReference": "@datadog/browser-rum!RumEvent:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "RumEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type" - }, - { - "kind": "Content", - "text": ") => boolean) | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "beforeSend", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#compressIntakeRequests:member", - "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "compressIntakeRequests?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "compressIntakeRequests", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#defaultPrivacyLevel:member", - "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "defaultPrivacyLevel?: " - }, - { - "kind": "Reference", - "text": "DefaultPrivacyLevel", - "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "defaultPrivacyLevel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#enablePrivacyForActionName:member", - "docComment": "/**\n * Enables privacy control for action names.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "enablePrivacyForActionName?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "enablePrivacyForActionName", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#excludedActivityUrls:member", - "docComment": "/**\n * A list of request origins ignored when computing the page activity. See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "excludedActivityUrls?: " - }, - { - "kind": "Reference", - "text": "MatchOption", - "canonicalReference": "@datadog/browser-core!MatchOption:type" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "excludedActivityUrls", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#plugins:member", - "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "plugins?: " - }, - { - "kind": "Reference", - "text": "RumPlugin", - "canonicalReference": "@datadog/browser-rum!RumPlugin:interface" - }, - { - "kind": "Content", - "text": "[] | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "plugins", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#profilingSampleRate:member", - "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "profilingSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "profilingSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#propagateTraceBaggage:member", - "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "propagateTraceBaggage?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "propagateTraceBaggage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#remoteConfigurationId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "remoteConfigurationId?: " - }, - { - "kind": "Content", - "text": "string | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "remoteConfigurationId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#sessionReplaySampleRate:member", - "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "sessionReplaySampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "sessionReplaySampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#startSessionReplayRecordingManually:member", - "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "startSessionReplayRecordingManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "startSessionReplayRecordingManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#subdomain:member", - "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "subdomain?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "subdomain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceContextInjection:member", - "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceContextInjection?: " - }, - { - "kind": "Reference", - "text": "TraceContextInjection", - "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceContextInjection", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceSampleRate:member", - "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "traceSampleRate?: " - }, - { - "kind": "Content", - "text": "number | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "traceSampleRate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackBfcacheViews:member", - "docComment": "/**\n * Enable the creation of dedicated views for pages restored from the Back-Forward cache. @default false\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackBfcacheViews?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackBfcacheViews", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackFeatureFlagsForEvents:member", - "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackFeatureFlagsForEvents?: " - }, - { - "kind": "Reference", - "text": "FeatureFlagsForEvents", - "canonicalReference": "@datadog/browser-rum!FeatureFlagsForEvents:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackFeatureFlagsForEvents", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackLongTasks:member", - "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackLongTasks?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackLongTasks", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackResources:member", - "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackResources?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackResources", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackUserInteractions:member", - "docComment": "/**\n * Enables automatic collection of users actions. See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. @default true\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackUserInteractions?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackUserInteractions", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackViewsManually:member", - "docComment": "/**\n * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "trackViewsManually?: " - }, - { - "kind": "Content", - "text": "boolean | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "trackViewsManually", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#workerUrl:member", - "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "workerUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "workerUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type", - "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumLongTaskEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumLongTaskEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumLongTaskEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumOtherResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumOtherResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type", - "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumResourceEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ActionChildProperties", - "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumResourceEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumViewEvent:type", - "docComment": "/**\n * Schema of all properties of a View event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumViewEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n flutter_raster_time?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n js_refresh_rate?: " - }, - { - "kind": "Reference", - "text": "RumPerfMetric", - "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" - }, - { - "kind": "Content", - "text": ";\n performance?: " - }, - { - "kind": "Reference", - "text": "ViewPerformanceData", - "canonicalReference": "@datadog/browser-rum!ViewPerformanceData:interface" - }, - { - "kind": "Content", - "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 13 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumViewEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumViewEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "location: " - }, - { - "kind": "Reference", - "text": "Readonly", - "canonicalReference": "!Readonly:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Location", - "canonicalReference": "!Location:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "location", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type", - "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export type RumVitalEvent = " - }, - { - "kind": "Reference", - "text": "CommonProperties", - "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "ViewContainerSchema", - "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" - }, - { - "kind": "Content", - "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", - "releaseTag": "Public", - "name": "RumVitalEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface RumXhrResourceEventDomainContext " - } - ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", - "releaseTag": "Public", - "name": "RumXhrResourceEventDomainContext", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handlingStack?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "handlingStack", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isAborted: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "isAborted", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "performanceEntry?: " - }, - { - "kind": "Reference", - "text": "PerformanceEntry", - "canonicalReference": "!PerformanceEntry:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "performanceEntry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "xhr: " - }, - { - "kind": "Reference", - "text": "XMLHttpRequest", - "canonicalReference": "!XMLHttpRequest:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "xhr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.38.0", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@datadog/browser-rum!", + "docComment": "", + "name": "@datadog/browser-rum", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@datadog/browser-rum!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface", + "docComment": "/**\n * Schema of common properties of RUM events\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface CommonProperties " + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "CommonProperties", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#_dd:member", + "docComment": "/**\n * Internal properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly _dd: " + }, + { + "kind": "Content", + "text": "{\n readonly format_version: 2;\n session?: {\n plan?: 1 | 2;\n readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop';\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly session_sample_rate: number;\n readonly session_replay_sample_rate?: number;\n [k: string]: unknown;\n };\n readonly browser_sdk_version?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "_dd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "IndexSignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[k: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "k", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#account:member", + "docComment": "/**\n * Account properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly account?: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "account", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#application:member", + "docComment": "/**\n * Application properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly application: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_id:member", + "docComment": "/**\n * Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#build_version:member", + "docComment": "/**\n * The build version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly build_version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "build_version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#ci_test:member", + "docComment": "/**\n * CI Visibility properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly ci_test?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_execution_id: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "ci_test", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#connectivity:member", + "docComment": "/**\n * Device connectivity properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "connectivity?: " + }, + { + "kind": "Content", + "text": "{\n readonly status: 'connected' | 'not_connected' | 'maybe';\n readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[];\n readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g';\n readonly cellular?: {\n readonly technology?: string;\n readonly carrier_name?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "connectivity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#context:member", + "docComment": "/**\n * User provided context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "context?: " + }, + { + "kind": "Content", + "text": "{\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#date:member", + "docComment": "/**\n * Start of the event in ms from epoch\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly date: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "date", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#device:member", + "docComment": "/**\n * Device properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "device?: " + }, + { + "kind": "Content", + "text": "{\n readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other';\n readonly name?: string;\n readonly model?: string;\n readonly brand?: string;\n readonly architecture?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "device", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#display:member", + "docComment": "/**\n * Display properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "display?: " + }, + { + "kind": "Content", + "text": "{\n readonly viewport?: {\n readonly width: number;\n readonly height: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "display", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#os:member", + "docComment": "/**\n * Operating system properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "os?: " + }, + { + "kind": "Content", + "text": "{\n readonly name: string;\n readonly version: string;\n readonly build?: string;\n readonly version_major: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "os", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#service:member", + "docComment": "/**\n * The service name for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "service?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "service", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#session:member", + "docComment": "/**\n * Session properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly session: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n readonly type: 'user' | 'synthetics' | 'ci_test';\n readonly has_replay?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "session", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#source:member", + "docComment": "/**\n * The source of this event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly source?: " + }, + { + "kind": "Content", + "text": "'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "source", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#synthetics:member", + "docComment": "/**\n * Synthetics properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly synthetics?: " + }, + { + "kind": "Content", + "text": "{\n readonly test_id: string;\n readonly result_id: string;\n readonly injected?: boolean;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "synthetics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#usr:member", + "docComment": "/**\n * User properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly usr?: " + }, + { + "kind": "Content", + "text": "{\n readonly id?: string;\n readonly name?: string;\n readonly email?: string;\n readonly anonymous_id?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": true, + "releaseTag": "Public", + "name": "usr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#version:member", + "docComment": "/**\n * The version for this application\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!CommonProperties#view:member", + "docComment": "/**\n * View properties\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly view: " + }, + { + "kind": "Content", + "text": "{\n readonly id: string;\n referrer?: string;\n url: string;\n name?: string;\n [k: string]: unknown;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "view", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@datadog/browser-rum!datadogRum:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "datadogRum: " + }, + { + "kind": "Reference", + "text": "RumPublicApi", + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface" + } + ], + "fileUrlPath": "packages/rum/esm/entries/main.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "datadogRum", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type", + "docComment": "/**\n * Schema of all properties of an Action event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumActionEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'action';\n readonly action: {\n readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';\n readonly id?: string;\n readonly loading_time?: number;\n readonly target?: {\n name: string;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];\n [k: string]: unknown;\n };\n readonly error?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly resource?: {\n readonly count: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n _dd?: {\n readonly action?: {\n readonly position?: {\n readonly x: number;\n readonly y: number;\n [k: string]: unknown;\n };\n target?: {\n readonly selector?: string;\n readonly width?: number;\n readonly height?: number;\n [k: string]: unknown;\n };\n name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumActionEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumActionEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "events?: " + }, + { + "kind": "Reference", + "text": "Event", + "canonicalReference": "!Event:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "events", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type", + "docComment": "/**\n * Schema of all properties of an Error event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumErrorEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'error';\n readonly error: {\n readonly id?: string;\n message: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n stack?: string;\n causes?: {\n message: string;\n readonly type?: string;\n stack?: string;\n readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';\n [k: string]: unknown;\n }[];\n readonly is_crash?: boolean;\n fingerprint?: string;\n readonly type?: string;\n readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning';\n readonly handling?: 'handled' | 'unhandled';\n readonly handling_stack?: string;\n readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp';\n readonly resource?: {\n readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n readonly status_code: number;\n url: string;\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n threads?: {\n readonly name: string;\n readonly crashed: boolean;\n readonly stack: string;\n readonly state?: string;\n [k: string]: unknown;\n }[];\n readonly binary_images?: {\n readonly uuid: string;\n readonly name: string;\n readonly is_system: boolean;\n readonly load_address?: string;\n readonly max_address?: string;\n readonly arch?: string;\n [k: string]: unknown;\n }[];\n readonly was_truncated?: boolean;\n readonly meta?: {\n readonly code_type?: string;\n readonly parent_process?: string;\n readonly incident_identifier?: string;\n readonly process?: string;\n readonly exception_type?: string;\n readonly exception_codes?: string;\n readonly path?: string;\n [k: string]: unknown;\n };\n readonly csp?: {\n readonly disposition?: 'enforce' | 'report';\n [k: string]: unknown;\n };\n readonly time_since_app_start?: number;\n [k: string]: unknown;\n };\n readonly freeze?: {\n readonly duration: number;\n [k: string]: unknown;\n };\n readonly view?: {\n readonly in_foreground?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumErrorEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumErrorEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error: " + }, + { + "kind": "Content", + "text": "unknown" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEvent:type", + "docComment": "/**\n * Schema of all properties of a RUM event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEvent = " + }, + { + "kind": "Reference", + "text": "RumActionEvent", + "canonicalReference": "@datadog/browser-rum!RumActionEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumErrorEvent", + "canonicalReference": "@datadog/browser-rum!RumErrorEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumLongTaskEvent", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumResourceEvent", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumViewEvent", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumVitalEvent", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumEventDomainContext = " + }, + { + "kind": "Content", + "text": "T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VIEW", + "canonicalReference": "@datadog/browser-rum!RumEventType.VIEW:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumViewEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ACTION", + "canonicalReference": "@datadog/browser-rum!RumEventType.ACTION:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumActionEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.RESOURCE", + "canonicalReference": "@datadog/browser-rum!RumEventType.RESOURCE:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumFetchResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumXhrResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RumOtherResourceEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.ERROR", + "canonicalReference": "@datadog/browser-rum!RumEventType.ERROR:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumErrorEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.LONG_TASK", + "canonicalReference": "@datadog/browser-rum!RumEventType.LONG_TASK:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumLongTaskEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : T extends " + }, + { + "kind": "Reference", + "text": "RumEventType.VITAL", + "canonicalReference": "@datadog/browser-rum!RumEventType.VITAL:member" + }, + { + "kind": "Content", + "text": " ? " + }, + { + "kind": "Reference", + "text": "RumVitalEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" + }, + { + "kind": "Content", + "text": " : never" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumEventDomainContext", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 34 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumFetchResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumFetchResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "error?: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "error", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInit?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "requestInit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "requestInput: " + }, + { + "kind": "Reference", + "text": "RequestInfo", + "canonicalReference": "!RequestInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "requestInput", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "response?: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "response", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumPublicApi extends " + }, + { + "kind": "Reference", + "text": "PublicApi", + "canonicalReference": "@datadog/browser-core!PublicApi:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", + "releaseTag": "Public", + "name": "RumGlobal", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addAction:member", + "docComment": "/**\n * Add a custom action, stored in `@action`\n *\n * @param name - Name of the action\n *\n * @param context - Context of the action\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addAction: " + }, + { + "kind": "Content", + "text": "(name: string, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addDurationVital:member", + "docComment": "/**\n * Add a custom duration vital\n *\n * @param name - name of the custom vital\n *\n * @param - options.startTime epoch timestamp of the start of the custom vital\n *\n * @param - options.duration duration of the custom vital in millisecond\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options: {\n startTime: number;\n duration: number;\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addError:member", + "docComment": "/**\n * Add a custom error, stored in `@error`.\n *\n * @param error - Error. Favor sending a [Javascript Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) to have a stack trace attached to the error event.\n *\n * @param context - Context of the error\n *\n * See [Send RUM Custom Actions](https://docs.datadoghq.com/real_user_monitoring/guide/send-rum-custom-actions) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addError: " + }, + { + "kind": "Content", + "text": "(error: unknown, context?: object) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addError", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addFeatureFlagEvaluation:member", + "docComment": "/**\n * Add a feature flag evaluation, stored in `@feature_flags.`\n *\n * @param key - The key of the feature flag.\n *\n * @param value - The value of the feature flag.\n *\n * We recommend enabling the intake request compression when using feature flags `compressIntakeRequests: true`.\n *\n * See [Feature Flag Tracking](https://docs.datadoghq.com/real_user_monitoring/feature_flag_tracking/) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addFeatureFlagEvaluation: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addFeatureFlagEvaluation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#addTiming:member", + "docComment": "/**\n * Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.`\n *\n * @param name - Name of the custom timing\n *\n * @param time - Epoch timestamp of the custom timing (if not set, will use current time)\n *\n * Note: passing a relative time is discouraged since it is actually used as-is but displayed relative to the view start. We currently don't provide a way to retrieve the view start time, so it can be challenging to provide a timing relative to the view start. see https://github.com/DataDog/browser-sdk/issues/2552\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "addTiming: " + }, + { + "kind": "Content", + "text": "(name: string, time?: number) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "addTiming", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearAccount:member", + "docComment": "/**\n * Clear all account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAccount: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearGlobalContext:member", + "docComment": "/**\n * Clear the global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearGlobalContext: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#clearUser:member", + "docComment": "/**\n * Clear all user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearUser: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "clearUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getAccount:member", + "docComment": "/**\n * Get account information\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAccount: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getGlobalContext:member", + "docComment": "/**\n * Get the global Context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGlobalContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInitConfiguration:member", + "docComment": "/**\n * Get the init configuration\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInitConfiguration: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInitConfiguration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getInternalContext:member", + "docComment": "/**\n * [Internal API] Get the internal SDK context\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInternalContext: " + }, + { + "kind": "Content", + "text": "(startTime?: number) => " + }, + { + "kind": "Reference", + "text": "InternalContext", + "canonicalReference": "@datadog/browser-rum!InternalContext:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getInternalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getSessionReplayLink:member", + "docComment": "/**\n * Get the Session Replay Link.\n *\n * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSessionReplayLink: " + }, + { + "kind": "Content", + "text": "() => string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getSessionReplayLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getUser:member", + "docComment": "/**\n * Get user information\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUser: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#getViewContext:member", + "docComment": "/**\n * Get View Context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getViewContext: " + }, + { + "kind": "Content", + "text": "() => " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "getViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#init:member", + "docComment": "/**\n * Init the RUM browser SDK.\n *\n * @param initConfiguration - Configuration options of the SDK\n *\n * See [RUM Browser Monitoring Setup](https://docs.datadoghq.com/real_user_monitoring/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "init: " + }, + { + "kind": "Content", + "text": "(initConfiguration: " + }, + { + "kind": "Reference", + "text": "RumInitConfiguration", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "init", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeAccountProperty:member", + "docComment": "/**\n * Remove an account property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeGlobalContextProperty:member", + "docComment": "/**\n * Remove a global context property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#removeUserProperty:member", + "docComment": "/**\n * Remove a user property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "removeUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "removeUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccount:member", + "docComment": "/**\n * Set account information to all events, stored in `@account`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccount: " + }, + { + "kind": "Content", + "text": "(newAccount: " + }, + { + "kind": "Reference", + "text": "Account", + "canonicalReference": "@datadog/browser-core!Account:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setAccountProperty:member", + "docComment": "/**\n * Set or update the account property, stored in `@account.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAccountProperty: " + }, + { + "kind": "Content", + "text": "(key: string, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setAccountProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContext:member", + "docComment": "/**\n * Set the global context information to all events, stored in `@context`\n *\n * @param context - Global context\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContext: " + }, + { + "kind": "Content", + "text": "(context: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setGlobalContextProperty:member", + "docComment": "/**\n * Set or update a global context property, stored in `@context.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [Global context](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#global-context) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setGlobalContextProperty: " + }, + { + "kind": "Content", + "text": "(key: any, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setGlobalContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setTrackingConsent:member", + "docComment": "/**\n * Set the tracking consent of the current user.\n *\n * @param trackingConsent - The user tracking consent\n *\n * Data will be sent only if it is set to \"granted\". This value won't be stored by the library across page loads: you will need to call this method or set the appropriate `trackingConsent` field in the init() method at each page load.\n *\n * If this method is called before the init() method, the provided value will take precedence over the one provided as initialization parameter.\n *\n * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-tracking-consent) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTrackingConsent: " + }, + { + "kind": "Content", + "text": "(trackingConsent: " + }, + { + "kind": "Reference", + "text": "TrackingConsent", + "canonicalReference": "@datadog/browser-core!TrackingConsent:type" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setTrackingConsent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(1)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": " & {\n id: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUser:member(2)", + "docComment": "/**\n * Set user information to all events, stored in `@usr`\n *\n * @deprecated\n *\n * You must specify a user id\n *\n * @see\n *\n * {@link setUser}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUser(newUser: " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@datadog/browser-core!User:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "newUser", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "setUser" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setUserProperty:member", + "docComment": "/**\n * Set or update the user property, stored in `@usr.`\n *\n * @param key - Key of the property\n *\n * @param property - Value of the property\n *\n * See [User session](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#user-session) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setUserProperty: " + }, + { + "kind": "Content", + "text": "(key: any, property: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setUserProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContext:member", + "docComment": "/**\n * Set View Context.\n *\n * Enable to manually set the context of the current view.\n *\n * @param context - context of the view\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContext: " + }, + { + "kind": "Content", + "text": "(context: " + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@datadog/browser-core!Context:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewContextProperty:member", + "docComment": "/**\n * Set View Context Property.\n *\n * Enable to manually set a property of the context of the current view.\n *\n * @param key - key of the property\n *\n * @param value - value of the property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewContextProperty: " + }, + { + "kind": "Content", + "text": "(key: string, value: any) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewContextProperty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#setViewName:member", + "docComment": "/**\n * Set View Name.\n *\n * Enable to manually change the name of the current view.\n *\n * @param name - name of the view See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setViewName: " + }, + { + "kind": "Content", + "text": "(name: string) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "setViewName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startDurationVital:member", + "docComment": "/**\n * Start a custom duration vital.\n *\n * If you plan to have multiple durations for the same vital, you should use the reference returned by this method.\n *\n * @param name - name of the custom vital\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n *\n * @returns reference to the custom vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startDurationVital: " + }, + { + "kind": "Content", + "text": "(name: string, options?: {\n context?: object;\n description?: string;\n }) => " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startSessionReplayRecording:member", + "docComment": "/**\n * Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()`\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "(options?: " + }, + { + "kind": "Reference", + "text": "StartRecordingOptions", + "canonicalReference": "@datadog/browser-rum!StartRecordingOptions:interface" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", + "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startView: " + }, + { + "kind": "Content", + "text": "{\n (name?: string): void;\n (options: " + }, + { + "kind": "Reference", + "text": "ViewOptions", + "canonicalReference": "@datadog/browser-rum!ViewOptions:interface" + }, + { + "kind": "Content", + "text": "): void;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "startView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopDurationVital:member", + "docComment": "/**\n * Stop a custom duration vital\n *\n * @param nameOrRef - name of the custom vital or the reference to it\n *\n * @param - options.context custom context attached to the vital\n *\n * @param - options.description Description of the vital\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopDurationVital: " + }, + { + "kind": "Content", + "text": "(nameOrRef: string | " + }, + { + "kind": "Reference", + "text": "DurationVitalReference", + "canonicalReference": "@datadog/browser-rum!DurationVitalReference:interface" + }, + { + "kind": "Content", + "text": ", options?: {\n context?: object;\n description?: string;\n }) => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopDurationVital", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSession:member", + "docComment": "/**\n * Stop the session. A new session will start at the next user interaction with the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSession: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSession", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumGlobal#stopSessionReplayRecording:member", + "docComment": "/**\n * Stop Session Replay recording.\n *\n * See [Browser Session Replay](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser) for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopSessionReplayRecording: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "stopSessionReplayRecording", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumInitConfiguration extends " + }, + { + "kind": "Reference", + "text": "InitConfiguration", + "canonicalReference": "@datadog/browser-core!InitConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", + "releaseTag": "Public", + "name": "RumInitConfiguration", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#actionNameAttribute:member", + "docComment": "/**\n * Specify your own attribute to use to name actions. See {@link https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions | Declare a name for click actions} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionNameAttribute?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "actionNameAttribute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#allowedTracingUrls:member", + "docComment": "/**\n * A list of request URLs used to inject tracing headers. See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "allowedTracingUrls?: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "TracingOption", + "canonicalReference": "@datadog/browser-rum!TracingOption:type" + }, + { + "kind": "Content", + "text": "> | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "allowedTracingUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#applicationId:member", + "docComment": "/**\n * The RUM application ID.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applicationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#beforeSend:member", + "docComment": "/**\n * Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events\n *\n * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data | Enrich And Control Browser RUM Data With beforeSend} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "beforeSend?: " + }, + { + "kind": "Content", + "text": "((event: " + }, + { + "kind": "Reference", + "text": "RumEvent", + "canonicalReference": "@datadog/browser-rum!RumEvent:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "RumEventDomainContext", + "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type" + }, + { + "kind": "Content", + "text": ") => boolean) | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "beforeSend", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#compressIntakeRequests:member", + "docComment": "/**\n * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See {@link https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay | Content Security Policy guidelines} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "compressIntakeRequests?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "compressIntakeRequests", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#defaultPrivacyLevel:member", + "docComment": "/**\n * Allow to protect end user privacy and prevent sensitive organizational information from being collected. @default mask See {@link https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options | Replay Privacy Options} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultPrivacyLevel?: " + }, + { + "kind": "Reference", + "text": "DefaultPrivacyLevel", + "canonicalReference": "@datadog/browser-core!DefaultPrivacyLevel:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "defaultPrivacyLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#enablePrivacyForActionName:member", + "docComment": "/**\n * Enables privacy control for action names.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enablePrivacyForActionName?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "enablePrivacyForActionName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#excludedActivityUrls:member", + "docComment": "/**\n * A list of request origins ignored when computing the page activity. See {@link https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated | How page activity is calculated} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "excludedActivityUrls?: " + }, + { + "kind": "Reference", + "text": "MatchOption", + "canonicalReference": "@datadog/browser-core!MatchOption:type" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "excludedActivityUrls", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#plugins:member", + "docComment": "/**\n * List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "plugins?: " + }, + { + "kind": "Reference", + "text": "RumPlugin", + "canonicalReference": "@datadog/browser-rum!RumPlugin:interface" + }, + { + "kind": "Content", + "text": "[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "plugins", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#profilingSampleRate:member", + "docComment": "/**\n * Not ready for production. The percentage of users profiled. A value between 0 and 100. @default 0\n *\n * @experimental\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "profilingSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "profilingSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#propagateTraceBaggage:member", + "docComment": "/**\n * Whether to propagate user and account IDs in the baggage header of trace requests. @default false\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "propagateTraceBaggage?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "propagateTraceBaggage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#remoteConfigurationId:member", + "docComment": "/**\n * Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "remoteConfigurationId?: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "remoteConfigurationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#sessionReplaySampleRate:member", + "docComment": "/**\n * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. See {@link https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans | Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sessionReplaySampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "sessionReplaySampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#startSessionReplayRecordingManually:member", + "docComment": "/**\n * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See {@link https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage | Session Replay Usage} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startSessionReplayRecordingManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "startSessionReplayRecordingManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#subdomain:member", + "docComment": "/**\n * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See {@link https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools | Connect Session Replay To Your Third-Party Tools} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subdomain?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "subdomain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceContextInjection:member", + "docComment": "/**\n * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. @default sampled See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceContextInjection?: " + }, + { + "kind": "Reference", + "text": "TraceContextInjection", + "canonicalReference": "@datadog/browser-core!TraceContextInjection:type" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceContextInjection", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#traceSampleRate:member", + "docComment": "/**\n * The percentage of requests to trace: 100 for all, 0 for none. See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "traceSampleRate?: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "traceSampleRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackFeatureFlagsForEvents:member", + "docComment": "/**\n * Enables collection of features flags in chosen events.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackFeatureFlagsForEvents?: " + }, + { + "kind": "Reference", + "text": "FeatureFlagsForEvents", + "canonicalReference": "@datadog/browser-rum!FeatureFlagsForEvents:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackFeatureFlagsForEvents", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackLongTasks:member", + "docComment": "/**\n * Enables collection of long task events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackLongTasks?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackLongTasks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackResources:member", + "docComment": "/**\n * Enables collection of resource events. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackResources?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackResources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackUserInteractions:member", + "docComment": "/**\n * Enables automatic collection of users actions. See {@link https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions | Tracking User Actions} for further information. @default true\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackUserInteractions?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackUserInteractions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#trackViewsManually:member", + "docComment": "/**\n * Allows you to control RUM views creation. See {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names | Override default RUM view names} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "trackViewsManually?: " + }, + { + "kind": "Content", + "text": "boolean | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "trackViewsManually", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumInitConfiguration#workerUrl:member", + "docComment": "/**\n * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See {@link https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay | Content Security Policy guidelines} for further information.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workerUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "workerUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEvent:type", + "docComment": "/**\n * Schema of all properties of a Long Task event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumLongTaskEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'long_task';\n readonly long_task: {\n readonly id?: string;\n readonly start_time?: number;\n readonly entry_type?: 'long-task' | 'long-animation-frame';\n readonly duration: number;\n readonly blocking_duration?: number;\n readonly render_start?: number;\n readonly style_and_layout_start?: number;\n readonly first_ui_event_timestamp?: number;\n readonly is_frozen_frame?: boolean;\n readonly scripts?: {\n readonly duration?: number;\n readonly pause_duration?: number;\n readonly forced_style_and_layout_duration?: number;\n readonly start_time?: number;\n readonly execution_start?: number;\n source_url?: string;\n readonly source_function_name?: string;\n readonly source_char_position?: number;\n invoker?: string;\n readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';\n readonly window_attribution?: string;\n [k: string]: unknown;\n }[];\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumLongTaskEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumLongTaskEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumOtherResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumOtherResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumResourceEvent:type", + "docComment": "/**\n * Schema of all properties of a Resource event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumResourceEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ActionChildProperties", + "canonicalReference": "@datadog/browser-rum!ActionChildProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'resource';\n readonly resource: {\n readonly id?: string;\n readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';\n readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';\n url: string;\n readonly status_code?: number;\n readonly duration?: number;\n readonly size?: number;\n readonly encoded_body_size?: number;\n readonly decoded_body_size?: number;\n readonly transfer_size?: number;\n readonly render_blocking_status?: 'blocking' | 'non-blocking';\n readonly worker?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly redirect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly dns?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly connect?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly ssl?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly first_byte?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly download?: {\n readonly duration: number;\n readonly start: number;\n [k: string]: unknown;\n };\n readonly protocol?: string;\n readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';\n readonly provider?: {\n readonly domain?: string;\n readonly name?: string;\n readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';\n [k: string]: unknown;\n };\n readonly graphql?: {\n readonly operationType: 'query' | 'mutation' | 'subscription';\n readonly operationName?: string;\n payload?: string;\n variables?: string;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly span_id?: string;\n readonly trace_id?: string;\n readonly rule_psr?: number;\n readonly discarded?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumResourceEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumViewEvent:type", + "docComment": "/**\n * Schema of all properties of a View event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumViewEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'view';\n readonly view: {\n readonly loading_time?: number;\n readonly network_settled_time?: number;\n readonly interaction_to_next_view_time?: number;\n readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay';\n readonly time_spent: number;\n readonly first_contentful_paint?: number;\n readonly largest_contentful_paint?: number;\n readonly largest_contentful_paint_target_selector?: string;\n readonly first_input_delay?: number;\n readonly first_input_time?: number;\n readonly first_input_target_selector?: string;\n readonly interaction_to_next_paint?: number;\n readonly interaction_to_next_paint_time?: number;\n readonly interaction_to_next_paint_target_selector?: string;\n readonly cumulative_layout_shift?: number;\n readonly cumulative_layout_shift_time?: number;\n readonly cumulative_layout_shift_target_selector?: string;\n readonly dom_complete?: number;\n readonly dom_content_loaded?: number;\n readonly dom_interactive?: number;\n readonly load_event?: number;\n readonly first_byte?: number;\n readonly custom_timings?: {\n [k: string]: number;\n };\n readonly is_active?: boolean;\n readonly is_slow_rendered?: boolean;\n readonly action: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly error: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly crash?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly long_task?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frozen_frame?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly slow_frames?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly resource: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly frustration?: {\n readonly count: number;\n [k: string]: unknown;\n };\n readonly in_foreground_periods?: {\n readonly start: number;\n readonly duration: number;\n [k: string]: unknown;\n }[];\n readonly memory_average?: number;\n readonly memory_max?: number;\n readonly cpu_ticks_count?: number;\n readonly cpu_ticks_per_second?: number;\n readonly refresh_rate_average?: number;\n readonly refresh_rate_min?: number;\n readonly slow_frames_rate?: number;\n readonly freeze_rate?: number;\n flutter_build_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n flutter_raster_time?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n js_refresh_rate?: " + }, + { + "kind": "Reference", + "text": "RumPerfMetric", + "canonicalReference": "@datadog/browser-rum!RumPerfMetric:interface" + }, + { + "kind": "Content", + "text": ";\n performance?: " + }, + { + "kind": "Reference", + "text": "ViewPerformanceData", + "canonicalReference": "@datadog/browser-rum!ViewPerformanceData:interface" + }, + { + "kind": "Content", + "text": ";\n [k: string]: unknown;\n };\n readonly session?: {\n readonly is_active?: boolean;\n readonly sampled_for_replay?: boolean;\n [k: string]: unknown;\n };\n readonly feature_flags?: {\n [k: string]: unknown;\n };\n readonly privacy?: {\n readonly replay_level: 'allow' | 'mask' | 'mask-user-input';\n [k: string]: unknown;\n };\n readonly _dd: {\n readonly document_version: number;\n readonly page_states?: {\n readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated';\n readonly start: number;\n [k: string]: unknown;\n }[];\n replay_stats?: {\n records_count?: number;\n segments_count?: number;\n segments_total_raw_size?: number;\n [k: string]: unknown;\n };\n readonly cls?: {\n readonly device_pixel_ratio?: number;\n [k: string]: unknown;\n };\n readonly configuration?: {\n readonly start_session_replay_recording_manually?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n readonly display?: {\n readonly scroll?: {\n readonly max_depth: number;\n readonly max_depth_scroll_top: number;\n readonly max_scroll_height: number;\n readonly max_scroll_height_time: number;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 13 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumViewEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumViewEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Location", + "canonicalReference": "!Location:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@datadog/browser-rum!RumVitalEvent:type", + "docComment": "/**\n * Schema of all properties of a Vital event\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export type RumVitalEvent = " + }, + { + "kind": "Reference", + "text": "CommonProperties", + "canonicalReference": "@datadog/browser-rum!CommonProperties:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "ViewContainerSchema", + "canonicalReference": "@datadog/browser-rum!ViewContainerSchema:interface" + }, + { + "kind": "Content", + "text": " & {\n readonly type: 'vital';\n readonly vital: {\n readonly type: 'duration';\n readonly id: string;\n readonly name?: string;\n readonly description?: string;\n readonly duration?: number;\n readonly custom?: {\n [k: string]: number;\n };\n [k: string]: unknown;\n };\n readonly _dd?: {\n readonly vital?: {\n readonly computed_value?: boolean;\n [k: string]: unknown;\n };\n [k: string]: unknown;\n };\n [k: string]: unknown;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "releaseTag": "Public", + "name": "RumVitalEvent", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface RumXhrResourceEventDomainContext " + } + ], + "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "releaseTag": "Public", + "name": "RumXhrResourceEventDomainContext", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handlingStack?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "handlingStack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isAborted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "isAborted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "performanceEntry?: " + }, + { + "kind": "Reference", + "text": "PerformanceEntry", + "canonicalReference": "!PerformanceEntry:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "performanceEntry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "xhr: " + }, + { + "kind": "Reference", + "text": "XMLHttpRequest", + "canonicalReference": "!XMLHttpRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "xhr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/package.json b/package.json index 837dc5a460..9c94f1c27f 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "size": "node scripts/show-bundle-size.js", "woke": "scripts/cli woke", "build:types": "lerna run build:esm --stream", - "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs/api-reference/rum" + "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs && node scripts/fix-doc-links.js" }, "devDependencies": { "@eslint/js": "9.26.0", diff --git a/packages/core/src/domain/configuration/configuration.ts b/packages/core/src/domain/configuration/configuration.ts index 493ec134f4..8ec74e0352 100644 --- a/packages/core/src/domain/configuration/configuration.ts +++ b/packages/core/src/domain/configuration/configuration.ts @@ -65,7 +65,7 @@ export interface InitConfiguration { * Allows the use of localStorage when cookies cannot be set. This enables the RUM Browser SDK to run in environments that do not provide cookie support. * * Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values - * See [Monitor Electron Applications Using the Browser SDK](https://docs.datadoghq.com/real_user_monitoring/guide/monitor-electron-applications-using-browser-sdk) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/monitor-electron-applications-using-browser-sdk | Monitor Electron Applications Using the Browser SDK} for further information. * @deprecated use `sessionPersistence: local-storage` where you want to use localStorage instead */ allowFallbackToLocalStorage?: boolean | undefined @@ -77,13 +77,13 @@ export interface InitConfiguration { allowUntrustedEvents?: boolean | undefined /** * Store global context and user context in localStorage to preserve them along the user navigation. - * See [Contexts life cycle](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#contexts-life-cycle) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#contexts-life-cycle | Contexts life cycle} for further information. * @default false */ storeContextsAcrossPages?: boolean | undefined /** * Set the initial user tracking consent state. - * See [User tracking consent](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#user-tracking-consent) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#user-tracking-consent | User tracking consent} for further information. * @default granted */ trackingConsent?: TrackingConsent | undefined @@ -91,7 +91,7 @@ export interface InitConfiguration { // transport options /** * Optional proxy URL, for example: https://www.proxy.com/path. - * See [Proxy Your Browser RUM Data](https://docs.datadoghq.com/real_user_monitoring/guide/proxy-rum-data) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/proxy-rum-data | Proxy Your Browser RUM Data} for further information. */ proxy?: string | ProxyFn | undefined /** @@ -106,11 +106,11 @@ export interface InitConfiguration { */ service?: string | undefined | null /** - * The application’s environment, for example: prod, pre-prod, and staging. Follows the [tag syntax requirements](https://docs.datadoghq.com/getting_started/tagging/#define-tags). + * The application's environment, for example: prod, pre-prod, and staging. Follows the [tag syntax requirements](https://docs.datadoghq.com/getting_started/tagging/#define-tags). */ env?: string | undefined | null /** - * The application’s version, for example: 1.2.3, 6c44da20, and 2020.02.13. Follows the [tag syntax requirements](https://docs.datadoghq.com/getting_started/tagging/#define-tags). + * The application's version, for example: 1.2.3, 6c44da20, and 2020.02.13. Follows the [tag syntax requirements](https://docs.datadoghq.com/getting_started/tagging/#define-tags). */ version?: string | undefined | null diff --git a/packages/rum-core/src/domain/configuration/configuration.ts b/packages/rum-core/src/domain/configuration/configuration.ts index 36061961e9..ecd3ad3d00 100644 --- a/packages/rum-core/src/domain/configuration/configuration.ts +++ b/packages/rum-core/src/domain/configuration/configuration.ts @@ -39,42 +39,47 @@ export interface RumInitConfiguration extends InitConfiguration { * - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) * - Discard selected RUM events * - * See [Enrich And Control Browser RUM Data With beforeSend](https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/enrich-and-control-rum-data | Enrich And Control Browser RUM Data With beforeSend} for further information. */ beforeSend?: ((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined /** * A list of request origins ignored when computing the page activity. - * See [How page activity is calculated](https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/browser/monitoring_page_performance/#how-page-activity-is-calculated | How page activity is calculated} for further information. */ excludedActivityUrls?: MatchOption[] | undefined /** * URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. - * See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information. + * See {@link https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay | Content Security Policy guidelines} for further information. */ workerUrl?: string /** * Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. - * See [Content Security Policy guidelines](https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay) for further information. + * See {@link https://docs.datadoghq.com/integrations/content_security_policy_logs/?tab=firefox#use-csp-with-real-user-monitoring-and-session-replay | Content Security Policy guidelines} for further information. */ compressIntakeRequests?: boolean | undefined + /** + * Identifier of the remote configuration to fetch dynamic settings for your application at runtime. + * Unless you have been instructed by Datadog support to use this feature, you should leave this + * parameter undefined. + */ remoteConfigurationId?: string | undefined // tracing options /** * A list of request URLs used to inject tracing headers. - * See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information. */ allowedTracingUrls?: Array | undefined /** * The percentage of requests to trace: 100 for all, 0 for none. - * See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information. */ traceSampleRate?: number | undefined /** * If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. * @default sampled - * See [Connect RUM and Traces](https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum | Connect RUM and Traces} for further information. */ traceContextInjection?: TraceContextInjection | undefined @@ -82,22 +87,22 @@ export interface RumInitConfiguration extends InitConfiguration { /** * Allow to protect end user privacy and prevent sensitive organizational information from being collected. * @default mask - * See [Replay Privacy Options](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/privacy_options | Replay Privacy Options} for further information. */ defaultPrivacyLevel?: DefaultPrivacyLevel | undefined /** * If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . - * See [Connect Session Replay To Your Third-Party Tools](https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/connect-session-replay-to-your-third-party-tools | Connect Session Replay To Your Third-Party Tools} for further information. */ subdomain?: string /** * The percentage of tracked sessions with [Browser RUM & Session Replay pricing](https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay) features: 100 for all, 0 for none. - * See [Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling](https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/guide/sampling-browser-plans | Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling} for further information. */ sessionReplaySampleRate?: number | undefined /** * If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. - * See [Session Replay Usage](https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/session_replay/browser/#usage | Session Replay Usage} for further information. */ startSessionReplayRecordingManually?: boolean | undefined @@ -107,19 +112,19 @@ export interface RumInitConfiguration extends InitConfiguration { enablePrivacyForActionName?: boolean | undefined // TODO next major: remove this option and make privacy for action name the default behavior /** * Enables automatic collection of users actions. - * See [Tracking User Actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions | Tracking User Actions} for further information. * @default true */ trackUserInteractions?: boolean | undefined /** * Specify your own attribute to use to name actions. - * See [Declare a name for click actions](https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions) for further information. + * See {@link https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions/#declare-a-name-for-click-actions | Declare a name for click actions} for further information. */ actionNameAttribute?: string | undefined // view options /** - * Allows you to control RUM views creation. See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names) for further information. + * Allows you to control RUM views creation. See {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/?tab=npm#override-default-rum-view-names | Override default RUM view names} for further information. */ trackViewsManually?: boolean | undefined /** diff --git a/packages/rum-core/src/domainContext.types.ts b/packages/rum-core/src/domainContext.types.ts index 478e639154..656656fade 100644 --- a/packages/rum-core/src/domainContext.types.ts +++ b/packages/rum-core/src/domainContext.types.ts @@ -18,15 +18,24 @@ export type RumEventDomainContext = T extends RumE ? RumVitalEventDomainContext : never +/** + * Additional information available when the SDK dispatches a RUM **View** event. + */ export interface RumViewEventDomainContext { location: Readonly } +/** + * Additional information available when the SDK dispatches a RUM **Action** event. + */ export interface RumActionEventDomainContext { events?: Event[] handlingStack?: string } +/** + * Additional information available when the SDK dispatches a **Fetch** resource event. + */ export interface RumFetchResourceEventDomainContext { requestInit?: RequestInit requestInput: RequestInfo @@ -37,6 +46,9 @@ export interface RumFetchResourceEventDomainContext { handlingStack?: string } +/** + * Additional information available when the SDK dispatches an **XHR** resource event. + */ export interface RumXhrResourceEventDomainContext { xhr: XMLHttpRequest performanceEntry?: PerformanceEntry @@ -44,18 +56,29 @@ export interface RumXhrResourceEventDomainContext { handlingStack?: string } +/** + * Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR. + */ export interface RumOtherResourceEventDomainContext { performanceEntry: PerformanceEntry } +/** + * Additional information available when the SDK dispatches an **Error** event. + */ export interface RumErrorEventDomainContext { error: unknown handlingStack?: string } +/** + * Additional information available when the SDK dispatches a **Long Task** event. + */ export interface RumLongTaskEventDomainContext { performanceEntry: PerformanceEntry } -// eslint-disable-next-line @typescript-eslint/no-empty-object-type -export interface RumVitalEventDomainContext {} +/** + * Additional information available when the SDK dispatches a **Vital** event. + */ +export type RumVitalEventDomainContext = Record diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js new file mode 100644 index 0000000000..6f2eba43a1 --- /dev/null +++ b/scripts/fix-doc-links.js @@ -0,0 +1,25 @@ +const fs = require('fs') +const path = require('path') +const { globSync } = require('glob') + +// Replace markdown links [text](url) with HTML text +function convertLinks(markdown) { + return markdown.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => `${text}`) +} + +function runMain() { + const docsDir = path.join(__dirname, '..', 'docs') + const files = globSync(`${docsDir}/**/*.md`, { nodir: true }) + files.forEach((file) => { + const content = fs.readFileSync(file, 'utf8') + const transformed = convertLinks(content) + if (content !== transformed) { + fs.writeFileSync(file, transformed, 'utf8') + } + }) + console.log(`Processed ${files.length} markdown files, converted markdown links to HTML tags.`) +} + +if (require.main === module) { + runMain() +} From 8322ae019f85109807002be8cfaa0ad26ade37d1 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 14:14:19 +0200 Subject: [PATCH 11/21] Fix links in datadogLogs documentation to use .html extensions --- docs/browser-logs.datadoglogs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index 73c75109d4..e1de97c824 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > datadogLogs +Home > @datadog/browser-logs > datadogLogs ## datadogLogs variable From f0a7dbe6a46d2cef03b51fc7dee8d99abe4f87d3 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 14:14:23 +0200 Subject: [PATCH 12/21] chagne --- docs/browser-logs.handlertype.md | 2 +- docs/browser-logs.logger._constructor_.md | 8 +- docs/browser-logs.logger.alert.md | 2 +- docs/browser-logs.logger.clearcontext.md | 2 +- docs/browser-logs.logger.critical.md | 2 +- docs/browser-logs.logger.debug.md | 2 +- docs/browser-logs.logger.emerg.md | 2 +- docs/browser-logs.logger.error.md | 2 +- docs/browser-logs.logger.getcontext.md | 2 +- docs/browser-logs.logger.gethandler.md | 4 +- docs/browser-logs.logger.getlevel.md | 4 +- docs/browser-logs.logger.info.md | 2 +- docs/browser-logs.logger.log.md | 4 +- docs/browser-logs.logger.logimplementation.md | 4 +- docs/browser-logs.logger.md | 20 ++--- docs/browser-logs.logger.notice.md | 2 +- docs/browser-logs.logger.ok.md | 2 +- ...owser-logs.logger.removecontextproperty.md | 2 +- docs/browser-logs.logger.setcontext.md | 2 +- .../browser-logs.logger.setcontextproperty.md | 2 +- docs/browser-logs.logger.sethandler.md | 4 +- docs/browser-logs.logger.setlevel.md | 4 +- docs/browser-logs.logger.warn.md | 2 +- ...rowser-logs.loggerconfiguration.context.md | 2 +- ...rowser-logs.loggerconfiguration.handler.md | 2 +- .../browser-logs.loggerconfiguration.level.md | 2 +- docs/browser-logs.loggerconfiguration.md | 12 +-- docs/browser-logs.logsevent.application_id.md | 2 +- docs/browser-logs.logsevent.date.md | 2 +- docs/browser-logs.logsevent.error.md | 2 +- docs/browser-logs.logsevent.http.md | 2 +- docs/browser-logs.logsevent.logger.md | 2 +- docs/browser-logs.logsevent.md | 26 +++---- docs/browser-logs.logsevent.message.md | 2 +- docs/browser-logs.logsevent.origin.md | 2 +- docs/browser-logs.logsevent.service.md | 2 +- docs/browser-logs.logsevent.session.md | 2 +- docs/browser-logs.logsevent.session_id.md | 2 +- docs/browser-logs.logsevent.status.md | 2 +- docs/browser-logs.logsevent.view.md | 2 +- docs/browser-logs.logseventdomaincontext.md | 2 +- docs/browser-logs.logsglobal.clearaccount.md | 2 +- ...wser-logs.logsglobal.clearglobalcontext.md | 2 +- docs/browser-logs.logsglobal.clearuser.md | 2 +- docs/browser-logs.logsglobal.createlogger.md | 2 +- docs/browser-logs.logsglobal.getaccount.md | 2 +- ...rowser-logs.logsglobal.getglobalcontext.md | 2 +- ...er-logs.logsglobal.getinitconfiguration.md | 2 +- ...wser-logs.logsglobal.getinternalcontext.md | 2 +- docs/browser-logs.logsglobal.getlogger.md | 2 +- docs/browser-logs.logsglobal.getuser.md | 2 +- docs/browser-logs.logsglobal.init.md | 2 +- docs/browser-logs.logsglobal.logger.md | 2 +- docs/browser-logs.logsglobal.md | 58 +++++++------- ...r-logs.logsglobal.removeaccountproperty.md | 2 +- ....logsglobal.removeglobalcontextproperty.md | 2 +- ...wser-logs.logsglobal.removeuserproperty.md | 2 +- docs/browser-logs.logsglobal.setaccount.md | 2 +- ...wser-logs.logsglobal.setaccountproperty.md | 2 +- ...rowser-logs.logsglobal.setglobalcontext.md | 2 +- ...ogs.logsglobal.setglobalcontextproperty.md | 2 +- ...wser-logs.logsglobal.settrackingconsent.md | 2 +- docs/browser-logs.logsglobal.setuser.md | 2 +- docs/browser-logs.logsglobal.setuser_1.md | 2 +- ...browser-logs.logsglobal.setuserproperty.md | 2 +- ...r-logs.logsinitconfiguration.beforesend.md | 2 +- ...ogsinitconfiguration.forwardconsolelogs.md | 2 +- ...gsinitconfiguration.forwarderrorstologs.md | 2 +- ...gs.logsinitconfiguration.forwardreports.md | 2 +- docs/browser-logs.logsinitconfiguration.md | 14 ++-- ...logs.logsinitconfiguration.usepciintake.md | 2 +- docs/browser-logs.logsmessage.context.md | 2 +- docs/browser-logs.logsmessage.md | 10 +-- docs/browser-logs.logsmessage.message.md | 2 +- docs/browser-logs.logsmessage.status.md | 2 +- docs/browser-logs.md | 28 +++---- docs/browser-logs.statustype.md | 2 +- docs/browser-rum-react.addreacterror.md | 2 +- ...r-rum-react.errorboundary._constructor_.md | 2 +- ...m-react.errorboundary.componentdidcatch.md | 2 +- ....errorboundary.getderivedstatefromerror.md | 2 +- docs/browser-rum-react.errorboundary.md | 12 +-- .../browser-rum-react.errorboundary.render.md | 2 +- ...wser-rum-react.errorboundary.reseterror.md | 2 +- docs/browser-rum-react.md | 10 +-- docs/browser-rum-react.reactplugin.md | 2 +- ...um-react.unstable_reactcomponenttracker.md | 2 +- docs/browser-rum-slim.datadogrum.md | 2 +- docs/browser-rum-slim.md | 4 +- docs/browser-rum.commonproperties._dd.md | 2 +- docs/browser-rum.commonproperties.account.md | 2 +- ...rowser-rum.commonproperties.application.md | 2 +- docs/browser-rum.commonproperties.build_id.md | 2 +- ...wser-rum.commonproperties.build_version.md | 2 +- docs/browser-rum.commonproperties.ci_test.md | 2 +- ...owser-rum.commonproperties.connectivity.md | 2 +- docs/browser-rum.commonproperties.context.md | 2 +- docs/browser-rum.commonproperties.date.md | 2 +- docs/browser-rum.commonproperties.device.md | 2 +- docs/browser-rum.commonproperties.display.md | 2 +- docs/browser-rum.commonproperties.md | 40 +++++----- docs/browser-rum.commonproperties.os.md | 2 +- docs/browser-rum.commonproperties.service.md | 2 +- docs/browser-rum.commonproperties.session.md | 2 +- docs/browser-rum.commonproperties.source.md | 2 +- ...browser-rum.commonproperties.synthetics.md | 2 +- docs/browser-rum.commonproperties.usr.md | 2 +- docs/browser-rum.commonproperties.version.md | 2 +- docs/browser-rum.commonproperties.view.md | 2 +- docs/browser-rum.datadogrum.md | 2 +- docs/browser-rum.md | 40 +++++----- docs/browser-rum.rumactionevent.md | 4 +- ...-rum.rumactioneventdomaincontext.events.md | 2 +- ...mactioneventdomaincontext.handlingstack.md | 2 +- ...browser-rum.rumactioneventdomaincontext.md | 6 +- docs/browser-rum.rumerrorevent.md | 4 +- ...er-rum.rumerroreventdomaincontext.error.md | 2 +- ...umerroreventdomaincontext.handlingstack.md | 2 +- .../browser-rum.rumerroreventdomaincontext.md | 6 +- docs/browser-rum.rumevent.md | 4 +- docs/browser-rum.rumeventdomaincontext.md | 4 +- ...umfetchresourceeventdomaincontext.error.md | 2 +- ...esourceeventdomaincontext.handlingstack.md | 2 +- ...tchresourceeventdomaincontext.isaborted.md | 2 +- ...-rum.rumfetchresourceeventdomaincontext.md | 16 ++-- ...urceeventdomaincontext.performanceentry.md | 2 +- ...hresourceeventdomaincontext.requestinit.md | 2 +- ...resourceeventdomaincontext.requestinput.md | 2 +- ...etchresourceeventdomaincontext.response.md | 2 +- docs/browser-rum.rumglobal.addaction.md | 2 +- .../browser-rum.rumglobal.adddurationvital.md | 2 +- docs/browser-rum.rumglobal.adderror.md | 2 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 2 +- docs/browser-rum.rumglobal.addtiming.md | 2 +- docs/browser-rum.rumglobal.clearaccount.md | 2 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 2 +- docs/browser-rum.rumglobal.clearuser.md | 2 +- docs/browser-rum.rumglobal.getaccount.md | 2 +- .../browser-rum.rumglobal.getglobalcontext.md | 2 +- ...wser-rum.rumglobal.getinitconfiguration.md | 2 +- ...rowser-rum.rumglobal.getinternalcontext.md | 2 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 2 +- docs/browser-rum.rumglobal.getuser.md | 2 +- docs/browser-rum.rumglobal.getviewcontext.md | 2 +- docs/browser-rum.rumglobal.init.md | 2 +- docs/browser-rum.rumglobal.md | 78 +++++++++---------- ...ser-rum.rumglobal.removeaccountproperty.md | 2 +- ...m.rumglobal.removeglobalcontextproperty.md | 2 +- ...rowser-rum.rumglobal.removeuserproperty.md | 2 +- docs/browser-rum.rumglobal.setaccount.md | 2 +- ...rowser-rum.rumglobal.setaccountproperty.md | 2 +- .../browser-rum.rumglobal.setglobalcontext.md | 2 +- ...-rum.rumglobal.setglobalcontextproperty.md | 2 +- ...rowser-rum.rumglobal.settrackingconsent.md | 2 +- docs/browser-rum.rumglobal.setuser.md | 2 +- docs/browser-rum.rumglobal.setuser_1.md | 2 +- docs/browser-rum.rumglobal.setuserproperty.md | 2 +- docs/browser-rum.rumglobal.setviewcontext.md | 2 +- ...er-rum.rumglobal.setviewcontextproperty.md | 2 +- docs/browser-rum.rumglobal.setviewname.md | 2 +- ...rowser-rum.rumglobal.startdurationvital.md | 2 +- ...m.rumglobal.startsessionreplayrecording.md | 2 +- docs/browser-rum.rumglobal.startview.md | 2 +- ...browser-rum.rumglobal.stopdurationvital.md | 2 +- docs/browser-rum.rumglobal.stopsession.md | 2 +- ...um.rumglobal.stopsessionreplayrecording.md | 2 +- ...uminitconfiguration.actionnameattribute.md | 2 +- ...ruminitconfiguration.allowedtracingurls.md | 2 +- ...-rum.ruminitconfiguration.applicationid.md | 2 +- ...ser-rum.ruminitconfiguration.beforesend.md | 2 +- ...nitconfiguration.compressintakerequests.md | 2 +- ...uminitconfiguration.defaultprivacylevel.md | 2 +- ...onfiguration.enableprivacyforactionname.md | 2 +- ...minitconfiguration.excludedactivityurls.md | 2 +- docs/browser-rum.ruminitconfiguration.md | 50 ++++++------ ...rowser-rum.ruminitconfiguration.plugins.md | 2 +- ...uminitconfiguration.profilingsamplerate.md | 2 +- ...initconfiguration.propagatetracebaggage.md | 2 +- ...initconfiguration.remoteconfigurationid.md | 2 +- ...itconfiguration.sessionreplaysamplerate.md | 2 +- ...ion.startsessionreplayrecordingmanually.md | 2 +- ...wser-rum.ruminitconfiguration.subdomain.md | 2 +- ...initconfiguration.tracecontextinjection.md | 2 +- ...um.ruminitconfiguration.tracesamplerate.md | 2 +- ...onfiguration.trackfeatureflagsforevents.md | 2 +- ...rum.ruminitconfiguration.tracklongtasks.md | 2 +- ...rum.ruminitconfiguration.trackresources.md | 2 +- ...initconfiguration.trackuserinteractions.md | 2 +- ...ruminitconfiguration.trackviewsmanually.md | 2 +- ...wser-rum.ruminitconfiguration.workerurl.md | 2 +- docs/browser-rum.rumlongtaskevent.md | 4 +- ...owser-rum.rumlongtaskeventdomaincontext.md | 4 +- ...taskeventdomaincontext.performanceentry.md | 2 +- ...-rum.rumotherresourceeventdomaincontext.md | 4 +- ...urceeventdomaincontext.performanceentry.md | 2 +- docs/browser-rum.rumresourceevent.md | 4 +- docs/browser-rum.rumviewevent.md | 4 +- ...-rum.rumvieweventdomaincontext.location.md | 2 +- docs/browser-rum.rumvieweventdomaincontext.md | 4 +- docs/browser-rum.rumvitalevent.md | 4 +- ...esourceeventdomaincontext.handlingstack.md | 2 +- ...xhrresourceeventdomaincontext.isaborted.md | 2 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 10 +-- ...urceeventdomaincontext.performanceentry.md | 2 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 2 +- docs/index.md | 10 +-- scripts/fix-doc-links.js | 8 +- 207 files changed, 439 insertions(+), 433 deletions(-) diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index e785bbea81..4c647614b6 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > HandlerType +Home > @datadog/browser-logs > HandlerType ## HandlerType variable diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 879799d217..4d753913fd 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > (constructor) +Home > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -37,7 +37,7 @@ handleLogStrategy -(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void @@ -67,7 +67,7 @@ handlerType -HandlerType \| HandlerType\[\] +HandlerType \| HandlerType\[\] @@ -83,7 +83,7 @@ level -StatusType +StatusType diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 211e88b279..da6be8dc7f 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > alert +Home > @datadog/browser-logs > Logger > alert ## Logger.alert() method diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index fa4b060fcc..a61699e2ae 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > clearContext +Home > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 380d6a52dd..c65eb52577 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > critical +Home > @datadog/browser-logs > Logger > critical ## Logger.critical() method diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 66ff6c796d..0637d64c4b 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > debug +Home > @datadog/browser-logs > Logger > debug ## Logger.debug() method diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index 04baaee635..e38e134eea 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > emerg +Home > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index e646c8b82e..d9ca07eaf1 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > error +Home > @datadog/browser-logs > Logger > error ## Logger.error() method diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index f5f833e913..847897dc6a 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getContext +Home > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 4d27f246ae..7e09bd4314 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getHandler +Home > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method @@ -11,5 +11,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType \| HandlerType\[\] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 7257c909a3..116d582953 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getLevel +Home > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method @@ -11,5 +11,5 @@ getLevel(): StatusType; ``` **Returns:** -StatusType +StatusType diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index b21b99594a..bc6b2e786e 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > info +Home > @datadog/browser-logs > Logger > info ## Logger.info() method diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 2de8b52878..e15300d61d 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > log +Home > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -65,7 +65,7 @@ status -StatusType +StatusType diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 5f4cf2d3e2..be8db36b10 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > logImplementation +Home > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -65,7 +65,7 @@ status -StatusType +StatusType diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 779fa20d50..537cfee72a 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger +Home > @datadog/browser-logs > Logger ## Logger interface @@ -25,7 +25,7 @@ Description -alert(message, messageContext, error) +alert(message, messageContext, error) @@ -34,7 +34,7 @@ Description -critical(message, messageContext, error) +critical(message, messageContext, error) @@ -43,7 +43,7 @@ Description -debug(message, messageContext, error) +debug(message, messageContext, error) @@ -52,7 +52,7 @@ Description -emerg(message, messageContext, error) +emerg(message, messageContext, error) @@ -61,7 +61,7 @@ Description -error(message, messageContext, error) +error(message, messageContext, error) @@ -70,7 +70,7 @@ Description -info(message, messageContext, error) +info(message, messageContext, error) @@ -79,7 +79,7 @@ Description -notice(message, messageContext, error) +notice(message, messageContext, error) @@ -88,7 +88,7 @@ Description -ok(message, messageContext, error) +ok(message, messageContext, error) @@ -97,7 +97,7 @@ Description -warn(message, messageContext, error) +warn(message, messageContext, error) diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index ceabd316ce..28a336c401 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > notice +Home > @datadog/browser-logs > Logger > notice ## Logger.notice() method diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index d5fd44e57a..cc72bc3780 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > ok +Home > @datadog/browser-logs > Logger > ok ## Logger.ok() method diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index d682bc1ba4..a1e0ebd782 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > removeContextProperty +Home > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 858068eea3..10c3e47398 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setContext +Home > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 91cd7ed56c..37ce71e0b9 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setContextProperty +Home > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index e77ea9fe81..a92a47f79c 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setHandler +Home > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -35,7 +35,7 @@ handler -HandlerType \| HandlerType\[\] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index d8ba2d6c80..0367f97bf3 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setLevel +Home > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -35,7 +35,7 @@ level -StatusType +StatusType diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index a825c2b0d0..fa597b79e3 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > warn +Home > @datadog/browser-logs > Logger > warn ## Logger.warn() method diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index 95fd9ca076..da351e1643 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > context +Home > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index c1a95e9d9a..906fea4454 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > handler +Home > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 6f09cfebf3..0f64773a54 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > level +Home > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 006800365f..dfef190550 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration +Home > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface @@ -35,7 +35,7 @@ Description -context? +context? @@ -54,7 +54,7 @@ _(Optional)_ -handler? +handler? @@ -62,7 +62,7 @@ _(Optional)_ -HandlerType \| HandlerType\[\] +HandlerType \| HandlerType\[\] @@ -73,7 +73,7 @@ _(Optional)_ -level? +level? @@ -81,7 +81,7 @@ _(Optional)_ -StatusType +StatusType diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 9261e9daad..55763153a4 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > application\_id +Home > @datadog/browser-logs > LogsEvent > application\_id ## LogsEvent.application\_id property diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index 3d8471ead7..ec9e4e24fb 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > date +Home > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index c06c412cf0..462b2e1f6c 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > error +Home > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 0c797a0d8b..3206ecd365 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > http +Home > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 56883d5c09..87d2079448 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > logger +Home > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 579f1b0f69..e1dcc48b9b 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent +Home > @datadog/browser-logs > LogsEvent ## LogsEvent interface @@ -35,7 +35,7 @@ Description -application\_id? +application\_id? @@ -54,7 +54,7 @@ _(Optional)_ UUID of the application -date +date @@ -73,7 +73,7 @@ Start of the log in ms from epoch -error? +error? @@ -92,7 +92,7 @@ _(Optional)_ Error properties -http? +http? @@ -111,7 +111,7 @@ _(Optional)_ Resource properties of the error -logger? +logger? @@ -130,7 +130,7 @@ _(Optional)_ Logger properties -message +message @@ -149,7 +149,7 @@ The log message -origin +origin @@ -168,7 +168,7 @@ Origin of the log -service? +service? @@ -187,7 +187,7 @@ _(Optional)_ The service name -session\_id? +session\_id? @@ -206,7 +206,7 @@ _(Optional)_ UUID of the session (deprecated in favor of session.id) -session? +session? @@ -225,7 +225,7 @@ _(Optional)_ Session properties -status +status @@ -244,7 +244,7 @@ The log status -view +view diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index bb21c2541e..0e688c568e 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > message +Home > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index b540f3d07b..1b4dbf42f8 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > origin +Home > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index b916022ddc..251a28d0bd 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > service +Home > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 72ff086047..179cbc5713 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > session +Home > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 0c6edd6078..76891367dc 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > session\_id +Home > @datadog/browser-logs > LogsEvent > session\_id ## LogsEvent.session\_id property diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 14e90a397e..898f1fe479 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > status +Home > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index bf758a7694..3ac0abb479 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > view +Home > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 3ee14e37a8..867014bb3b 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEventDomainContext +Home > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index d73c20c261..9df5f06c88 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > clearAccount +Home > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index f9cd6cfc9b..5c5e536b07 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext +Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 27f4dcc96f..8adcc276b4 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > clearUser +Home > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 886a7149f9..2503071fe4 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > createLogger +Home > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index fe5af94145..43d16fefcf 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getAccount +Home > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index a0c80f58dc..d10bbe30d9 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getGlobalContext +Home > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index 16c0a8f987..a1a53cc138 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration +Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index c11193b734..c22bd2af3e 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getInternalContext +Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 1ec13e743e..1cb3fb0ae6 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getLogger +Home > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index ef646069e3..0cb46a9696 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getUser +Home > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 21fadf7a49..65bcd0c20f 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > init +Home > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index 58b9668092..c5a9be9bfe 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > logger +Home > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index f76d7a73fe..082fc0b13a 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal +Home > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface @@ -36,7 +36,7 @@ Description -clearAccount +clearAccount @@ -55,7 +55,7 @@ Clear all account information -clearGlobalContext +clearGlobalContext @@ -76,7 +76,7 @@ See \clearUser +clearUser @@ -97,7 +97,7 @@ See \createLogger +createLogger @@ -105,7 +105,7 @@ See \LoggerConfiguration) => Logger +(name: string, conf?: LoggerConfiguration) => Logger @@ -118,7 +118,7 @@ See \getAccount +getAccount @@ -137,7 +137,7 @@ Get account information -getGlobalContext +getGlobalContext @@ -158,7 +158,7 @@ See \getInitConfiguration +getInitConfiguration @@ -166,7 +166,7 @@ See \LogsInitConfiguration \| undefined +() => LogsInitConfiguration \| undefined @@ -177,7 +177,7 @@ Get the init configuration -getInternalContext +getInternalContext @@ -198,7 +198,7 @@ See \getLogger +getLogger @@ -206,7 +206,7 @@ See \Logger \| undefined +(name: string) => Logger \| undefined @@ -219,7 +219,7 @@ See \getUser +getUser @@ -240,7 +240,7 @@ See \init +init @@ -248,7 +248,7 @@ See \LogsInitConfiguration) => void +(initConfiguration: LogsInitConfiguration) => void @@ -259,7 +259,7 @@ Init the Logs browser SDK. -logger +logger @@ -267,7 +267,7 @@ Init the Logs browser SDK. -Logger +Logger @@ -276,7 +276,7 @@ Init the Logs browser SDK. -removeAccountProperty +removeAccountProperty @@ -295,7 +295,7 @@ Remove an account property -removeGlobalContextProperty +removeGlobalContextProperty @@ -316,7 +316,7 @@ See \removeUserProperty +removeUserProperty @@ -337,7 +337,7 @@ See \setAccount +setAccount @@ -356,7 +356,7 @@ Set account information to all events, stored in `@account` -setAccountProperty +setAccountProperty @@ -375,7 +375,7 @@ Set or update the account property, stored in `@account.` -setGlobalContext +setGlobalContext @@ -394,7 +394,7 @@ Set the global context information to all logs, stored in `@context` -setGlobalContextProperty +setGlobalContextProperty @@ -413,7 +413,7 @@ Set or update a global context property, stored in `@context.` -setTrackingConsent +setTrackingConsent @@ -432,7 +432,7 @@ Set the tracking consent of the current user. -setUserProperty +setUserProperty @@ -466,7 +466,7 @@ Description -setUser(newUser) +setUser(newUser) @@ -479,7 +479,7 @@ See \setUser(newUser) +setUser(newUser) diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 1706fe791e..2321d5b50e 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty +Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index 7670a8c693..d64200108f 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 6e3c9bb5fd..47942669d5 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > removeUserProperty +Home > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index 1a5232dbea..d4273bc766 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setAccount +Home > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index e658f2ce11..0ff6da5fd5 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setAccountProperty +Home > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index aee7cd9b75..f07063e025 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setGlobalContext +Home > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 46c9281012..9e475d236d 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 9958bed2e3..b59ca39ee6 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent +Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 5a6beb0b32..76ad33f57a 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 1c87632aed..9570bc14e2 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 1e10329f16..1aa3195263 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setUserProperty +Home > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index 6e523e11c1..d0b1eb8d6b 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend +Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index 01eedfe33d..cdd472a5e8 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index e4cafecbe8..f1920aa7f3 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index c33f30b5f5..fd149e19fb 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports +Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 23b0b6623c..0235572040 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration +Home > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface @@ -36,7 +36,7 @@ Description -beforeSend? +beforeSend? @@ -44,7 +44,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined @@ -55,7 +55,7 @@ _(Optional)_ Access to every logs collected by the Logs SDK before they are sent -forwardConsoleLogs? +forwardConsoleLogs? @@ -74,7 +74,7 @@ _(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward every -forwardErrorsToLogs? +forwardErrorsToLogs? @@ -93,7 +93,7 @@ _(Optional)_ Forward console.error logs, uncaught exceptions and network errors -forwardReports? +forwardReports? @@ -112,7 +112,7 @@ _(Optional)_ Forward reports from the \usePciIntake? +usePciIntake? diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index bd78ec2da1..24859ac38e 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake +Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 15adad9cb6..537ccc7a78 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > context +Home > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 254f159c1f..ac21c2fb88 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage +Home > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -35,7 +35,7 @@ Description -context? +context? @@ -54,7 +54,7 @@ _(Optional)_ -message +message @@ -71,7 +71,7 @@ string -status +status @@ -79,7 +79,7 @@ string -StatusType +StatusType diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index b94a52709a..ba97f70fb7 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > message +Home > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 78ea723cdc..3217ac3816 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > status +Home > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 472d8ec0bd..3b3995db3c 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs +Home > @datadog/browser-logs ## browser-logs package @@ -19,7 +19,7 @@ Description -Logger +Logger @@ -43,7 +43,7 @@ Description -Logger +Logger @@ -52,7 +52,7 @@ Description -LoggerConfiguration +LoggerConfiguration @@ -61,7 +61,7 @@ Description -LogsEvent +LogsEvent @@ -70,7 +70,7 @@ Description -LogsGlobal +LogsGlobal @@ -79,7 +79,7 @@ Description -LogsInitConfiguration +LogsInitConfiguration @@ -88,7 +88,7 @@ Description -LogsMessage +LogsMessage @@ -112,7 +112,7 @@ Description -datadogLogs +datadogLogs @@ -121,7 +121,7 @@ Description -HandlerType +HandlerType @@ -130,7 +130,7 @@ Description -StatusType +StatusType @@ -154,7 +154,7 @@ Description -HandlerType +HandlerType @@ -163,7 +163,7 @@ Description -LogsEventDomainContext +LogsEventDomainContext @@ -172,7 +172,7 @@ Description -StatusType +StatusType diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 7698dc1187..4d9dade523 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > StatusType +Home > @datadog/browser-logs > StatusType ## StatusType variable diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 2ae450fab9..e00eafc47e 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > addReactError +Home > @datadog/browser-rum-react > addReactError ## addReactError() function diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 89fff592a8..8ccd318cde 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) +Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 5ae66f905d..b14b0fb664 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch +Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 28210d9f52..5b987d5bdc 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError +Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 98c80e9daf..0a6b26b377 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary +Home > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class @@ -31,7 +31,7 @@ Description -(constructor)(props) +(constructor)(props) @@ -70,7 +70,7 @@ Description -resetError +resetError @@ -107,7 +107,7 @@ Description -componentDidCatch(error, errorInfo) +componentDidCatch(error, errorInfo) @@ -119,7 +119,7 @@ Description -getDerivedStateFromError(error) +getDerivedStateFromError(error) @@ -133,7 +133,7 @@ Description -render() +render() diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 8e2c22cda1..7c6ac00636 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > render +Home > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index c363ca6988..48532c6c9f 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > resetError +Home > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index e15d537b12..1f32229925 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react +Home > @datadog/browser-rum-react ## browser-rum-react package @@ -19,7 +19,7 @@ Description -ErrorBoundary +ErrorBoundary @@ -43,7 +43,7 @@ Description -addReactError(error, info) +addReactError(error, info) @@ -52,7 +52,7 @@ Description -reactPlugin(configuration) +reactPlugin(configuration) @@ -76,7 +76,7 @@ Description -UNSTABLE\_ReactComponentTracker +UNSTABLE\_ReactComponentTracker diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index effb9fb661..b94ea89d59 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > reactPlugin +Home > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 05909fb074..595b895ff8 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker +Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker ## UNSTABLE\_ReactComponentTracker variable diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index b8b3762af6..7738d68086 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-slim > datadogRum +Home > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index d699654061..d0a015e332 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-slim +Home > @datadog/browser-rum-slim ## browser-rum-slim package @@ -19,7 +19,7 @@ Description -datadogRum +datadogRum diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 88e2b89143..ad1cb08af6 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > \_dd +Home > @datadog/browser-rum > CommonProperties > \_dd ## CommonProperties.\_dd property diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 057fb13130..45368c8e6e 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > account +Home > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index 14c3639fd1..cd13d05e30 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > application +Home > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 6b682f2f66..b86a419740 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > build\_id +Home > @datadog/browser-rum > CommonProperties > build\_id ## CommonProperties.build\_id property diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 61f5babab6..9633cbb6ea 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > build\_version +Home > @datadog/browser-rum > CommonProperties > build\_version ## CommonProperties.build\_version property diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index c7d86de9b8..49573e6d83 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > ci\_test +Home > @datadog/browser-rum > CommonProperties > ci\_test ## CommonProperties.ci\_test property diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index cb99da984b..487f61ebe0 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > connectivity +Home > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index 84eea16bce..e565438b7b 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > context +Home > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index f65cd36b28..bdb152047d 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > date +Home > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index 8e401ea8a1..c1a3c6a1e0 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > device +Home > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 9464a61e65..861e290d0e 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > display +Home > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 15b05fa9f5..0ef1f58576 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties +Home > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -37,7 +37,7 @@ Description -\_dd +\_dd @@ -58,7 +58,7 @@ Internal properties -account? +account? @@ -79,7 +79,7 @@ _(Optional)_ Account properties -application +application @@ -100,7 +100,7 @@ Application properties -build\_id? +build\_id? @@ -121,7 +121,7 @@ _(Optional)_ Generated unique ID of the application build. Unlike version or bui -build\_version? +build\_version? @@ -142,7 +142,7 @@ _(Optional)_ The build version for this application -ci\_test? +ci\_test? @@ -163,7 +163,7 @@ _(Optional)_ CI Visibility properties -connectivity? +connectivity? @@ -182,7 +182,7 @@ _(Optional)_ Device connectivity properties -context? +context? @@ -201,7 +201,7 @@ _(Optional)_ User provided context -date +date @@ -222,7 +222,7 @@ Start of the event in ms from epoch -device? +device? @@ -241,7 +241,7 @@ _(Optional)_ Device properties -display? +display? @@ -260,7 +260,7 @@ _(Optional)_ Display properties -os? +os? @@ -279,7 +279,7 @@ _(Optional)_ Operating system properties -service? +service? @@ -298,7 +298,7 @@ _(Optional)_ The service name for this application -session +session @@ -319,7 +319,7 @@ Session properties -source? +source? @@ -340,7 +340,7 @@ _(Optional)_ The source of this event -synthetics? +synthetics? @@ -361,7 +361,7 @@ _(Optional)_ Synthetics properties -usr? +usr? @@ -382,7 +382,7 @@ _(Optional)_ User properties -version? +version? @@ -401,7 +401,7 @@ _(Optional)_ The version for this application -view +view diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 00294236b5..536aa92efd 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > os +Home > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index ef0953d474..75bd81afa2 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > service +Home > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index d045a95840..d546e76ce3 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > session +Home > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index 508696b233..c3de043c5d 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > source +Home > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index b137541474..2fafb2b1a1 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > synthetics +Home > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 0ae00dd0d2..7b6b5f4cd4 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > usr +Home > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index ca62a92935..9854d3ef1c 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > version +Home > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index 7318e0b8a4..b2a07261e5 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > view +Home > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 4565292752..580402557e 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > datadogRum +Home > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 0b939b77ef..3d77b40af1 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum +Home > @datadog/browser-rum ## browser-rum package @@ -19,7 +19,7 @@ Description -CommonProperties +CommonProperties @@ -30,7 +30,7 @@ Schema of common properties of RUM events -RumActionEventDomainContext +RumActionEventDomainContext @@ -39,7 +39,7 @@ Schema of common properties of RUM events -RumErrorEventDomainContext +RumErrorEventDomainContext @@ -48,7 +48,7 @@ Schema of common properties of RUM events -RumFetchResourceEventDomainContext +RumFetchResourceEventDomainContext @@ -57,7 +57,7 @@ Schema of common properties of RUM events -RumGlobal +RumGlobal @@ -66,7 +66,7 @@ Schema of common properties of RUM events -RumInitConfiguration +RumInitConfiguration @@ -75,7 +75,7 @@ Schema of common properties of RUM events -RumLongTaskEventDomainContext +RumLongTaskEventDomainContext @@ -84,7 +84,7 @@ Schema of common properties of RUM events -RumOtherResourceEventDomainContext +RumOtherResourceEventDomainContext @@ -93,7 +93,7 @@ Schema of common properties of RUM events -RumViewEventDomainContext +RumViewEventDomainContext @@ -102,7 +102,7 @@ Schema of common properties of RUM events -RumXhrResourceEventDomainContext +RumXhrResourceEventDomainContext @@ -126,7 +126,7 @@ Description -datadogRum +datadogRum @@ -150,7 +150,7 @@ Description -RumActionEvent +RumActionEvent @@ -161,7 +161,7 @@ Schema of all properties of an Action event -RumErrorEvent +RumErrorEvent @@ -172,7 +172,7 @@ Schema of all properties of an Error event -RumEvent +RumEvent @@ -183,7 +183,7 @@ Schema of all properties of a RUM event -RumEventDomainContext +RumEventDomainContext @@ -192,7 +192,7 @@ Schema of all properties of a RUM event -RumLongTaskEvent +RumLongTaskEvent @@ -203,7 +203,7 @@ Schema of all properties of a Long Task event -RumResourceEvent +RumResourceEvent @@ -214,7 +214,7 @@ Schema of all properties of a Resource event -RumViewEvent +RumViewEvent @@ -225,7 +225,7 @@ Schema of all properties of a View event -RumVitalEvent +RumVitalEvent diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 414ce6a0be..5df82dc308 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumActionEvent +Home > @datadog/browser-rum > RumActionEvent ## RumActionEvent type @@ -66,5 +66,5 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 5c6be32141..6698f63bae 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext > events +Home > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 6ed3f79069..3a381da3c1 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index f197257642..306664a8cb 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext +Home > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface @@ -35,7 +35,7 @@ Description -events? +events? @@ -54,7 +54,7 @@ _(Optional)_ -handlingStack? +handlingStack? diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index 67ca589e50..d539728f58 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumErrorEvent +Home > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type @@ -90,5 +90,5 @@ export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewConta [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 22dc44c516..833d7b2a30 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext > error +Home > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 122191ec1c..fe21529635 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 9ea16a5d9a..ee9dd9db1b 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext +Home > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface @@ -35,7 +35,7 @@ Description -error +error @@ -52,7 +52,7 @@ unknown -handlingStack? +handlingStack? diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 5acfcc0430..2e3d079ae0 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumEvent +Home > @datadog/browser-rum > RumEvent ## RumEvent type @@ -11,5 +11,5 @@ Schema of all properties of a RUM event ```typescript export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; ``` -**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent +**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index d8bce59c10..7e9b0b07ea 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumEventDomainContext +Home > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type @@ -9,5 +9,5 @@ ```typescript export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; ``` -**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext +**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index dd1a274562..384bf37e94 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index 1e76d40f19..e8c761d8d7 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index cb92722d47..1245b6a516 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index cb3c5f44d9..64e1812b55 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -error? +error? @@ -54,7 +54,7 @@ _(Optional)_ -handlingStack? +handlingStack? @@ -73,7 +73,7 @@ _(Optional)_ -isAborted +isAborted @@ -90,7 +90,7 @@ boolean -performanceEntry? +performanceEntry? @@ -109,7 +109,7 @@ _(Optional)_ -requestInit? +requestInit? @@ -128,7 +128,7 @@ _(Optional)_ -requestInput +requestInput @@ -145,7 +145,7 @@ RequestInfo -response? +response? diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 076459b7e5..dd65de0e81 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 74da7d248a..49ccfc94fe 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 83a2842053..66999ec3d0 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 22c0702218..50db70b5a5 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 19f1d379a5..1d2b039ff5 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addAction +Home > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index e0a85965c6..fc23fa7b0f 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addDurationVital +Home > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index 146b024d05..d560b0591b 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addError +Home > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 3899838032..706ce9c41f 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation +Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 5dde6180d9..3fcd32fd26 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addTiming +Home > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 42e191063d..07b37b26d5 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > clearAccount +Home > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index 2069f0ce16..c4c687ba47 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > clearGlobalContext +Home > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 130b111172..7e42ce3c9a 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > clearUser +Home > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index efce77d3e2..dba65370b3 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getAccount +Home > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index b267db79c9..6ca297788e 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getGlobalContext +Home > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index c9c0e442c1..207a9ba9b4 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getInitConfiguration +Home > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 90a2c53730..9377e29955 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getInternalContext +Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 97a36f4437..523e21415a 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink +Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index c49e15cecf..f443dcd8d0 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getUser +Home > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 00c5ab8661..7fc407f915 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getViewContext +Home > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index e03d8e6a9d..1142877612 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > init +Home > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index 7fd303ed7a..a9c624b401 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal +Home > @datadog/browser-rum > RumGlobal ## RumGlobal interface @@ -36,7 +36,7 @@ Description -addAction +addAction @@ -55,7 +55,7 @@ Add a custom action, stored in `@action` -addDurationVital +addDurationVital @@ -74,7 +74,7 @@ Add a custom duration vital -addError +addError @@ -93,7 +93,7 @@ Add a custom error, stored in `@error`. -addFeatureFlagEvaluation +addFeatureFlagEvaluation @@ -112,7 +112,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` -addTiming +addTiming @@ -131,7 +131,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. -clearAccount +clearAccount @@ -150,7 +150,7 @@ Clear all account information -clearGlobalContext +clearGlobalContext @@ -171,7 +171,7 @@ See \clearUser +clearUser @@ -192,7 +192,7 @@ See \getAccount +getAccount @@ -211,7 +211,7 @@ Get account information -getGlobalContext +getGlobalContext @@ -232,7 +232,7 @@ See \getInitConfiguration +getInitConfiguration @@ -240,7 +240,7 @@ See \RumInitConfiguration \| undefined +() => RumInitConfiguration \| undefined @@ -251,7 +251,7 @@ Get the init configuration -getInternalContext +getInternalContext @@ -270,7 +270,7 @@ Get the init configuration -getSessionReplayLink +getSessionReplayLink @@ -291,7 +291,7 @@ See \getUser +getUser @@ -312,7 +312,7 @@ See \getViewContext +getViewContext @@ -331,7 +331,7 @@ Get View Context. -init +init @@ -339,7 +339,7 @@ Get View Context. -(initConfiguration: RumInitConfiguration) => void +(initConfiguration: RumInitConfiguration) => void @@ -350,7 +350,7 @@ Init the RUM browser SDK. -removeAccountProperty +removeAccountProperty @@ -369,7 +369,7 @@ Remove an account property -removeGlobalContextProperty +removeGlobalContextProperty @@ -390,7 +390,7 @@ See \removeUserProperty +removeUserProperty @@ -411,7 +411,7 @@ See \setAccount +setAccount @@ -430,7 +430,7 @@ Set account information to all events, stored in `@account` -setAccountProperty +setAccountProperty @@ -449,7 +449,7 @@ Set or update the account property, stored in `@account.` -setGlobalContext +setGlobalContext @@ -468,7 +468,7 @@ Set the global context information to all events, stored in `@context` -setGlobalContextProperty +setGlobalContextProperty @@ -487,7 +487,7 @@ Set or update a global context property, stored in `@context.` -setTrackingConsent +setTrackingConsent @@ -506,7 +506,7 @@ Set the tracking consent of the current user. -setUserProperty +setUserProperty @@ -525,7 +525,7 @@ Set or update the user property, stored in `@usr.` -setViewContext +setViewContext @@ -546,7 +546,7 @@ Enable to manually set the context of the current view. -setViewContextProperty +setViewContextProperty @@ -567,7 +567,7 @@ Enable to manually set a property of the context of the current view. -setViewName +setViewName @@ -588,7 +588,7 @@ Enable to manually change the name of the current view. -startDurationVital +startDurationVital @@ -609,7 +609,7 @@ If you plan to have multiple durations for the same vital, you should use the re -startSessionReplayRecording +startSessionReplayRecording @@ -630,7 +630,7 @@ See \startView +startView @@ -649,7 +649,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -stopDurationVital +stopDurationVital @@ -668,7 +668,7 @@ Stop a custom duration vital -stopSession +stopSession @@ -687,7 +687,7 @@ Stop the session. A new session will start at the next user interaction with the -stopSessionReplayRecording +stopSessionReplayRecording @@ -723,7 +723,7 @@ Description -setUser(newUser) +setUser(newUser) @@ -736,7 +736,7 @@ See \setUser(newUser) +setUser(newUser) diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index f9629df37d..e8f1c73c0b 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > removeAccountProperty +Home > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index 0f8fcc3b7c..b57a72c511 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index aaecbf8e8a..190cc5cf6d 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > removeUserProperty +Home > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 19a18f65cd..a559156d79 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setAccount +Home > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index c9abc2cb8b..6d41e04cb2 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setAccountProperty +Home > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 65590e98ed..08d98484b9 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setGlobalContext +Home > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 8b9735e6b1..542c3c639b 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 2add318c5f..41efadfec9 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setTrackingConsent +Home > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index 416df3338c..a086a3e0f5 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 71ff2fcf74..972a0ae9f2 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index f7a7ed64a9..1165900244 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setUserProperty +Home > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 8855976153..95f2670ab2 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewContext +Home > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index ba1ad45fd6..19adf5c441 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewContextProperty +Home > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 4ce1212f54..5077efb0d9 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewName +Home > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index a8f43e0f11..58a2ff805c 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > startDurationVital +Home > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index fcf7f54282..8cb1159886 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index 8c4287b8d7..efddb37e3a 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > startView +Home > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 2fdc0e4de1..40272a366e 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > stopDurationVital +Home > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 7a86d94490..776655c5cf 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > stopSession +Home > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index b521cbae63..fac27e9aa0 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 9b4d01891e..1e48a2c7ef 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute +Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index feb9bdbaac..7804d4d183 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls +Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index d7c5a6276f..b93cb36c87 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > applicationId +Home > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index bd7bb2d753..40e6814128 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > beforeSend +Home > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 4059840a44..3413d6cb14 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests +Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index fe01ef6825..d82ab6acac 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel +Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 6d303fda27..71a0cbe060 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName +Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index e9318de8ff..af9c9bf573 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls +Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 5f7e218e6e..49d2ca5f57 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration +Home > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface @@ -36,7 +36,7 @@ Description -actionNameAttribute? +actionNameAttribute? @@ -55,7 +55,7 @@ _(Optional)_ Specify your own attribute to use to name actions. See allowedTracingUrls? +allowedTracingUrls? @@ -74,7 +74,7 @@ _(Optional)_ A list of request URLs used to inject tracing headers. See -applicationId +applicationId @@ -93,7 +93,7 @@ The RUM application ID. -beforeSend? +beforeSend? @@ -101,7 +101,7 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined @@ -114,7 +114,7 @@ See compressIntakeRequests? +compressIntakeRequests? @@ -133,7 +133,7 @@ _(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth us -defaultPrivacyLevel? +defaultPrivacyLevel? @@ -152,7 +152,7 @@ _(Optional)_ Allow to protect end user privacy and prevent sensitive organizatio -enablePrivacyForActionName? +enablePrivacyForActionName? @@ -171,7 +171,7 @@ _(Optional)_ Enables privacy control for action names. -excludedActivityUrls? +excludedActivityUrls? @@ -190,7 +190,7 @@ _(Optional)_ A list of request origins ignored when computing the page activity. -plugins? +plugins? @@ -209,7 +209,7 @@ _(Optional)_ List of plugins to enable. The plugins API is unstable and experime -profilingSampleRate? +profilingSampleRate? @@ -228,7 +228,7 @@ _(Optional)_ Not ready for production. The percentage of users profiled. A value -propagateTraceBaggage? +propagateTraceBaggage? @@ -247,7 +247,7 @@ _(Optional)_ Whether to propagate user and account IDs in the baggage header of -remoteConfigurationId? +remoteConfigurationId? @@ -266,7 +266,7 @@ _(Optional)_ Identifier of the remote configuration to fetch dynamic settings fo -sessionReplaySampleRate? +sessionReplaySampleRate? @@ -285,7 +285,7 @@ _(Optional)_ The percentage of tracked sessions with \startSessionReplayRecordingManually? +startSessionReplayRecordingManually? @@ -304,7 +304,7 @@ _(Optional)_ If the session is sampled for Session Replay, only start the record -subdomain? +subdomain? @@ -323,7 +323,7 @@ _(Optional)_ If you are accessing Datadog through a custom subdomain, you can se -traceContextInjection? +traceContextInjection? @@ -342,7 +342,7 @@ _(Optional)_ If you set a `traceSampleRate`, to ensure backend services' -traceSampleRate? +traceSampleRate? @@ -361,7 +361,7 @@ _(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See < -trackFeatureFlagsForEvents? +trackFeatureFlagsForEvents? @@ -380,7 +380,7 @@ _(Optional)_ Enables collection of features flags in chosen events. -trackLongTasks? +trackLongTasks? @@ -399,7 +399,7 @@ _(Optional)_ Enables collection of long task events. true -trackResources? +trackResources? @@ -418,7 +418,7 @@ _(Optional)_ Enables collection of resource events. true -trackUserInteractions? +trackUserInteractions? @@ -437,7 +437,7 @@ _(Optional)_ Enables automatic collection of users actions. See trackViewsManually? +trackViewsManually? @@ -456,7 +456,7 @@ _(Optional)_ Allows you to control RUM views creation. See workerUrl? +workerUrl? diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 138900b64d..1e521d1a29 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > plugins +Home > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index f2301fc6df..c08a3537d5 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index f4798936b9..42f57c809a 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage +Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 3ebce68042..925f00267a 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId +Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index c40815e40f..0057df27ea 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate +Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index a0a05d3842..427130229c 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually +Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 9725b457e5..ed3d388410 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > subdomain +Home > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 37b0067289..b5593bdb99 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection +Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index 6cab0af3d9..f509245641 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 2218e7c683..11f8345f45 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents +Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 53abd056be..8b2b7a0f5f 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks +Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 0b664eeccc..9c05a1120b 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackResources +Home > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index caa0fa1228..198c9f2565 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions +Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index 034b05d192..d028a6d8ac 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually +Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index cb9058951e..fdb93f3581 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > workerUrl +Home > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 087df04cb1..4bec40e6c7 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumLongTaskEvent +Home > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type @@ -44,5 +44,5 @@ export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewCo [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 5cbedaa0de..47e7b1500f 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumLongTaskEventDomainContext +Home > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface @@ -35,7 +35,7 @@ Description -performanceEntry +performanceEntry diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index b021dcdd15..71f23621a5 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 9a9f01ed4f..316fd6bedf 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -performanceEntry +performanceEntry diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 34f298af97..6bc0840e08 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 95c4221084..20eb3f5607 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumResourceEvent +Home > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type @@ -85,5 +85,5 @@ export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewCo [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index ed9e9f1f36..14076df1df 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumViewEvent +Home > @datadog/browser-rum > RumViewEvent ## RumViewEvent type @@ -139,5 +139,5 @@ export type RumViewEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 9d9de5fb06..084978dfb8 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumViewEventDomainContext > location +Home > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index a1e9e078e4..f2d51a2686 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumViewEventDomainContext +Home > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface @@ -35,7 +35,7 @@ Description -location +location diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index d4a1ff2009..95c1c41d20 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumVitalEvent +Home > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type @@ -32,5 +32,5 @@ export type RumVitalEvent = CommonProperties & ViewContainerSchema & { [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 70318d0eba..c3c3e7c215 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 9b36439211..1da2a404dc 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 7f17b83b05..a34174d6c8 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface @@ -35,7 +35,7 @@ Description -handlingStack? +handlingStack? @@ -54,7 +54,7 @@ _(Optional)_ -isAborted +isAborted @@ -71,7 +71,7 @@ boolean -performanceEntry? +performanceEntry? @@ -90,7 +90,7 @@ _(Optional)_ -xhr +xhr diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 5386c6364a..23288a5767 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index f5dceaf156..7a02ed5a6c 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property diff --git a/docs/index.md b/docs/index.md index e25398a604..e906fb41a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -Home +Home ## API Reference @@ -19,7 +19,7 @@ Description -@datadog/browser-logs +@datadog/browser-logs @@ -28,7 +28,7 @@ Description -@datadog/browser-rum +@datadog/browser-rum @@ -37,7 +37,7 @@ Description -@datadog/browser-rum-react +@datadog/browser-rum-react @@ -46,7 +46,7 @@ Description -@datadog/browser-rum-slim +@datadog/browser-rum-slim diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js index 6f2eba43a1..1922232ae6 100644 --- a/scripts/fix-doc-links.js +++ b/scripts/fix-doc-links.js @@ -4,7 +4,13 @@ const { globSync } = require('glob') // Replace markdown links [text](url) with HTML text function convertLinks(markdown) { - return markdown.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => `${text}`) + return markdown.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => { + let newUrl = url + if (url.endsWith('.md')) { + newUrl = url.replace(/\.md$/, '.html') + } + return `${text}` + }) } function runMain() { From 4311a37b8e2d9792835cb5ec25830d1faac31d2a Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 14:29:57 +0200 Subject: [PATCH 13/21] change --- docs/browser-logs.datadoglogs.md | 2 + docs/browser-logs.logger._constructor_.md | 8 +-- docs/browser-logs.logger.alert.md | 4 +- docs/browser-logs.logger.critical.md | 4 +- docs/browser-logs.logger.debug.md | 4 +- docs/browser-logs.logger.emerg.md | 4 +- docs/browser-logs.logger.error.md | 4 +- docs/browser-logs.logger.info.md | 4 +- docs/browser-logs.logger.log.md | 6 +- docs/browser-logs.logger.logimplementation.md | 8 +-- docs/browser-logs.logger.notice.md | 4 +- docs/browser-logs.logger.ok.md | 4 +- docs/browser-logs.logger.warn.md | 4 +- docs/browser-logs.loggerconfiguration.md | 6 +- docs/browser-logs.logsevent.md | 14 ++--- docs/browser-logs.logsinitconfiguration.md | 10 ++-- docs/browser-logs.logsmessage.md | 2 +- docs/browser-logs.md | 4 ++ docs/browser-rum-react.md | 2 + docs/browser-rum-react.reactplugin.md | 2 +- docs/browser-rum-slim.datadogrum.md | 2 + docs/browser-rum-slim.md | 4 ++ docs/browser-rum.commonproperties.md | 28 ++++----- docs/browser-rum.datadogrum.md | 2 + docs/browser-rum.md | 4 ++ ...browser-rum.rumactioneventdomaincontext.md | 4 +- .../browser-rum.rumerroreventdomaincontext.md | 2 +- ...-rum.rumfetchresourceeventdomaincontext.md | 10 ++-- docs/browser-rum.ruminitconfiguration.md | 44 +++++++------- ...er-rum.rumxhrresourceeventdomaincontext.md | 4 +- docs/index.md | 8 +++ etc/browser-logs.api.json | 4 +- etc/browser-rum-react.api.json | 2 +- etc/browser-rum-slim.api.json | 4 +- etc/browser-rum.api.json | 4 +- packages/logs/src/entries/main.ts | 12 ++++ packages/rum-core/src/boot/rumPublicApi.ts | 6 +- .../src/domain/configuration/configuration.ts | 3 + packages/rum-core/src/domainContext.types.ts | 57 +++++++++++++++++++ packages/rum-react/src/entries/main.ts | 8 +++ packages/rum-slim/src/entries/main.ts | 13 ++++- packages/rum/src/entries/main.ts | 12 ++++ scripts/fix-doc-links.js | 9 ++- 43 files changed, 244 insertions(+), 102 deletions(-) diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index e1de97c824..e8080c46a6 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -4,6 +4,8 @@ ## datadogLogs variable +The global Logs instance. Use this to call Logs methods. + **Signature:** ```typescript diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 4d753913fd..e3619d1fab 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -56,7 +56,7 @@ string -_(Optional)_ +(Optional) @@ -72,7 +72,7 @@ handlerType -_(Optional)_ +(Optional) @@ -88,7 +88,7 @@ level -_(Optional)_ +(Optional) @@ -104,7 +104,7 @@ object -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index da6be8dc7f..48011cc323 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index c65eb52577..0b16b394ca 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 0637d64c4b..52ef50524e 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index e38e134eea..ee6a6c3abe 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index d9ca07eaf1..b16b6e1f49 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index bc6b2e786e..c68fc09ce5 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index e15300d61d..9534e2dbaa 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ status -_(Optional)_ +(Optional) @@ -86,7 +86,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index be8db36b10..d4d15f44f7 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ status -_(Optional)_ +(Optional) @@ -86,7 +86,7 @@ Error -_(Optional)_ +(Optional) @@ -102,7 +102,7 @@ string -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index 28a336c401..f9836a7c30 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index cc72bc3780..eb4ab969a7 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index fa597b79e3..2dd15971ba 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -54,7 +54,7 @@ object -_(Optional)_ +(Optional) @@ -70,7 +70,7 @@ Error -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index dfef190550..e2b8267b7e 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -48,7 +48,7 @@ object -_(Optional)_ +(Optional) @@ -67,7 +67,7 @@ _(Optional)_ -_(Optional)_ +(Optional) @@ -86,7 +86,7 @@ _(Optional)_ -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index e1dcc48b9b..dff3e73297 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -48,7 +48,7 @@ string -_(Optional)_ UUID of the application +(Optional) UUID of the application @@ -86,7 +86,7 @@ Start of the log in ms from epoch -_(Optional)_ Error properties +(Optional) Error properties @@ -105,7 +105,7 @@ _(Optional)_ Error properties -_(Optional)_ Resource properties of the error +(Optional) Resource properties of the error @@ -124,7 +124,7 @@ _(Optional)_ Resource properties of the error -_(Optional)_ Logger properties +(Optional) Logger properties @@ -181,7 +181,7 @@ string -_(Optional)_ The service name +(Optional) The service name @@ -200,7 +200,7 @@ string -_(Optional)_ UUID of the session (deprecated in favor of session.id) +(Optional) UUID of the session (deprecated in favor of session.id) @@ -219,7 +219,7 @@ _(Optional)_ UUID of the session (deprecated in favor of session.id) -_(Optional)_ Session properties +(Optional) Session properties diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 0235572040..a241bdb8bf 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -49,7 +49,7 @@ Description -_(Optional)_ Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs +(Optional) Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs @@ -68,7 +68,7 @@ ConsoleApiName\[\] \| 'all' \| undefined -_(Optional)_ Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. +(Optional) Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. @@ -87,7 +87,7 @@ boolean \| undefined -_(Optional)_ Forward console.error logs, uncaught exceptions and network errors to Datadog. true +(Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true @@ -106,7 +106,7 @@ RawReportType\[\] \| 'all' \| undefined -_(Optional)_ Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +(Optional) Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. @@ -125,7 +125,7 @@ boolean -_(Optional)_ Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false +(Optional) Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index ac21c2fb88..107876469a 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -48,7 +48,7 @@ Context -_(Optional)_ +(Optional) diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 3b3995db3c..cbafd19deb 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -4,6 +4,8 @@ ## browser-logs package +Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Provides comprehensive logging capabilities with automatic error tracking and custom log collection. + ## Classes @@ -115,7 +115,7 @@ string @@ -136,7 +136,7 @@ string @@ -157,7 +157,7 @@ _(Optional)_ The build version for this application @@ -176,7 +176,7 @@ _(Optional)_ CI Visibility properties @@ -195,7 +195,7 @@ _(Optional)_ Device connectivity properties @@ -235,7 +235,7 @@ Start of the event in ms from epoch @@ -254,7 +254,7 @@ _(Optional)_ Device properties @@ -273,7 +273,7 @@ _(Optional)_ Display properties @@ -292,7 +292,7 @@ string @@ -334,7 +334,7 @@ Session properties @@ -355,7 +355,7 @@ _(Optional)_ The source of this event @@ -376,7 +376,7 @@ _(Optional)_ Synthetics properties @@ -395,7 +395,7 @@ string diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 580402557e..2b39faf4bc 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -4,6 +4,8 @@ ## datadogRum variable +The global RUM instance. Use this to call RUM methods. + **Signature:** ```typescript diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 3d77b40af1..743101b513 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -4,6 +4,8 @@ ## browser-rum package +Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience. + ## Interfaces
@@ -117,6 +119,8 @@ Description +The global Logs instance. Use this to call Logs methods. +
diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 1f32229925..8228bf87f4 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -4,6 +4,8 @@ ## browser-rum-react package +Datadog Browser RUM React Integration - Additional components and hooks for React applications. Provides React-specific features like Error Boundaries and component performance tracking. + ## Classes diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 7738d68086..917da31e02 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -4,6 +4,8 @@ ## datadogRum variable +The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods. + **Signature:** ```typescript diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index d0a015e332..ca909b306e 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -4,6 +4,8 @@ ## browser-rum-slim package +Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. Lightweight alternative for basic RUM monitoring with reduced bundle size. + ## Variables
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index b94ea89d59..94c4d7e535 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -52,7 +52,7 @@ ReactPluginConfiguration -_(Optional)_ +(Optional)
@@ -24,6 +26,8 @@ Description +The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods. +
diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 0ef1f58576..2cfeef35c1 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -73,7 +73,7 @@ Internal properties 		-_(Optional)_ Account properties +(Optional) Account properties
-_(Optional)_ Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. +(Optional) Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build.
-_(Optional)_ The build version for this application +(Optional) The build version for this application
-_(Optional)_ CI Visibility properties +(Optional) CI Visibility properties
-_(Optional)_ Device connectivity properties +(Optional) Device connectivity properties
-_(Optional)_ User provided context +(Optional) User provided context
-_(Optional)_ Device properties +(Optional) Device properties
-_(Optional)_ Display properties +(Optional) Display properties
-_(Optional)_ Operating system properties +(Optional) Operating system properties
-_(Optional)_ The service name for this application +(Optional) The service name for this application
-_(Optional)_ The source of this event +(Optional) The source of this event
-_(Optional)_ Synthetics properties +(Optional) Synthetics properties
-_(Optional)_ User properties +(Optional) User properties
-_(Optional)_ The version for this application +(Optional) The version for this application
@@ -131,6 +133,8 @@ Description +The global RUM instance. Use this to call RUM methods. +
diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 306664a8cb..91937c5cdf 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -48,7 +48,7 @@ Event\[\] -_(Optional)_ +(Optional) @@ -67,7 +67,7 @@ string -_(Optional)_ +(Optional) diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index ee9dd9db1b..aa70a3ef61 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -65,7 +65,7 @@ string -_(Optional)_ +(Optional) diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 64e1812b55..c93b2f9144 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -48,7 +48,7 @@ Error -_(Optional)_ +(Optional) @@ -67,7 +67,7 @@ string -_(Optional)_ +(Optional) @@ -103,7 +103,7 @@ PerformanceEntry -_(Optional)_ +(Optional) @@ -122,7 +122,7 @@ RequestInit -_(Optional)_ +(Optional) @@ -158,7 +158,7 @@ Response -_(Optional)_ +(Optional) diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 49d2ca5f57..f4ec74019b 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -49,7 +49,7 @@ string \| undefined -_(Optional)_ Specify your own attribute to use to name actions. See Declare a name for click actions for further information. +(Optional) Specify your own attribute to use to name actions. See Declare a name for click actions for further information. @@ -68,7 +68,7 @@ Array<MatchOption \| TracingOption> \| undefined -_(Optional)_ A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. +(Optional) A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. @@ -106,7 +106,7 @@ The RUM application ID. -_(Optional)_ Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events +(Optional) Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events See Enrich And Control Browser RUM Data With beforeSend for further information. @@ -127,7 +127,7 @@ boolean \| undefined -_(Optional)_ Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. +(Optional) Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. @@ -146,7 +146,7 @@ DefaultPrivacyLevel \| undefined -_(Optional)_ Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +(Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. @@ -165,7 +165,7 @@ boolean \| undefined -_(Optional)_ Enables privacy control for action names. +(Optional) Enables privacy control for action names. @@ -184,7 +184,7 @@ MatchOption\[\] \| undefined -_(Optional)_ A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. +(Optional) A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. @@ -203,7 +203,7 @@ RumPlugin\[\] \| undefined -_(Optional)_ List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. +(Optional) List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. @@ -222,7 +222,7 @@ number \| undefined -_(Optional)_ Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +(Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 @@ -241,7 +241,7 @@ boolean \| undefined -_(Optional)_ Whether to propagate user and account IDs in the baggage header of trace requests. false +(Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false @@ -260,7 +260,7 @@ string \| undefined -_(Optional)_ Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. +(Optional) Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. @@ -279,7 +279,7 @@ number \| undefined -_(Optional)_ The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +(Optional) The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. @@ -298,7 +298,7 @@ boolean \| undefined -_(Optional)_ If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. +(Optional) If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. @@ -317,7 +317,7 @@ string -_(Optional)_ If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. +(Optional) If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. @@ -336,7 +336,7 @@ TraceContextInjection \| undefined -_(Optional)_ If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +(Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. @@ -355,7 +355,7 @@ number \| undefined -_(Optional)_ The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. +(Optional) The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. @@ -374,7 +374,7 @@ FeatureFlagsForEvents\[\] -_(Optional)_ Enables collection of features flags in chosen events. +(Optional) Enables collection of features flags in chosen events. @@ -393,7 +393,7 @@ boolean \| undefined -_(Optional)_ Enables collection of long task events. true +(Optional) Enables collection of long task events. true @@ -412,7 +412,7 @@ boolean \| undefined -_(Optional)_ Enables collection of resource events. true +(Optional) Enables collection of resource events. true @@ -431,7 +431,7 @@ boolean \| undefined -_(Optional)_ Enables automatic collection of users actions. See Tracking User Actions for further information. true +(Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true @@ -450,7 +450,7 @@ boolean \| undefined -_(Optional)_ Allows you to control RUM views creation. See Override default RUM view names for further information. +(Optional) Allows you to control RUM views creation. See Override default RUM view names for further information. @@ -469,7 +469,7 @@ string -_(Optional)_ URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. +(Optional) URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index a34174d6c8..23ec8cab4f 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -48,7 +48,7 @@ string -_(Optional)_ +(Optional) @@ -84,7 +84,7 @@ PerformanceEntry -_(Optional)_ +(Optional) diff --git a/docs/index.md b/docs/index.md index e906fb41a3..752a2b7655 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,6 +24,8 @@ Description +Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Provides comprehensive logging capabilities with automatic error tracking and custom log collection. + @@ -33,6 +35,8 @@ Description +Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience. + @@ -42,6 +46,8 @@ Description +Datadog Browser RUM React Integration - Additional components and hooks for React applications. Provides React-specific features like Error Boundaries and component performance tracking. + @@ -51,6 +57,8 @@ Description +Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. Lightweight alternative for basic RUM monitoring with reduced bundle size. + diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json index d7dec6a2d3..845b586288 100644 --- a/etc/browser-logs.api.json +++ b/etc/browser-logs.api.json @@ -162,7 +162,7 @@ }, "kind": "Package", "canonicalReference": "@datadog/browser-logs!", - "docComment": "", + "docComment": "/**\n * Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Provides comprehensive logging capabilities with automatic error tracking and custom log collection.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/logs/log_collection/javascript/ | Browser Log Collection}\n *\n * @packageDocumentation\n */\n", "name": "@datadog/browser-logs", "preserveMemberOrder": false, "members": [ @@ -175,7 +175,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-logs!datadogLogs:var", - "docComment": "", + "docComment": "/**\n * The global Logs instance. Use this to call Logs methods.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/logs/log_collection/javascript/ | Browser Log Collection}\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json index 4a4c131f61..b5dcc2ad6f 100644 --- a/etc/browser-rum-react.api.json +++ b/etc/browser-rum-react.api.json @@ -162,7 +162,7 @@ }, "kind": "Package", "canonicalReference": "@datadog/browser-rum-react!", - "docComment": "", + "docComment": "/**\n * Datadog Browser RUM React Integration - Additional components and hooks for React applications. Provides React-specific features like Error Boundaries and component performance tracking.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#react | RUM React Integration}\n *\n * @packageDocumentation\n */\n", "name": "@datadog/browser-rum-react", "preserveMemberOrder": false, "members": [ diff --git a/etc/browser-rum-slim.api.json b/etc/browser-rum-slim.api.json index 0789ce2570..e4653fc1f1 100644 --- a/etc/browser-rum-slim.api.json +++ b/etc/browser-rum-slim.api.json @@ -162,7 +162,7 @@ }, "kind": "Package", "canonicalReference": "@datadog/browser-rum-slim!", - "docComment": "", + "docComment": "/**\n * Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. Lightweight alternative for basic RUM monitoring with reduced bundle size.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup}\n *\n * @packageDocumentation\n */\n", "name": "@datadog/browser-rum-slim", "preserveMemberOrder": false, "members": [ @@ -175,7 +175,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-rum-slim!datadogRum:var", - "docComment": "", + "docComment": "/**\n * The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup}\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index 4933b269fd..0d46c4179e 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -162,7 +162,7 @@ }, "kind": "Package", "canonicalReference": "@datadog/browser-rum!", - "docComment": "", + "docComment": "/**\n * Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup}\n *\n * @packageDocumentation\n */\n", "name": "@datadog/browser-rum", "preserveMemberOrder": false, "members": [ @@ -750,7 +750,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-rum!datadogRum:var", - "docComment": "", + "docComment": "/**\n * The global RUM instance. Use this to call RUM methods.\n *\n * @see\n *\n * {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup}\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/packages/logs/src/entries/main.ts b/packages/logs/src/entries/main.ts index 253cd489cc..2314d4c14c 100644 --- a/packages/logs/src/entries/main.ts +++ b/packages/logs/src/entries/main.ts @@ -1,3 +1,11 @@ +/** + * @packageDocumentation + * Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. + * Provides comprehensive logging capabilities with automatic error tracking and custom log collection. + * + * @see {@link https://docs.datadoghq.com/logs/log_collection/javascript/ | Browser Log Collection} + */ + import { defineGlobal, getGlobalObject } from '@datadog/browser-core' import type { LogsPublicApi } from '../boot/logsPublicApi' import { makeLogsPublicApi } from '../boot/logsPublicApi' @@ -11,6 +19,10 @@ export type { LogsInitConfiguration } from '../domain/configuration' export type { LogsEvent } from '../logsEvent.types' export type { LogsEventDomainContext } from '../domainContext.types' +/** + * The global Logs instance. Use this to call Logs methods. + * @see {@link https://docs.datadoghq.com/logs/log_collection/javascript/ | Browser Log Collection} + */ export const datadogLogs = makeLogsPublicApi(startLogs) interface BrowserWindow extends Window { diff --git a/packages/rum-core/src/boot/rumPublicApi.ts b/packages/rum-core/src/boot/rumPublicApi.ts index cb6f47e643..e2d45d63bb 100644 --- a/packages/rum-core/src/boot/rumPublicApi.ts +++ b/packages/rum-core/src/boot/rumPublicApi.ts @@ -48,6 +48,10 @@ import type { StartRum, StartRumResult } from './startRum' export interface StartRecordingOptions { force: boolean } + +/** + * The RUM Browser SDK global object that provides all the public methods. + */ export interface RumPublicApi extends PublicApi { /** * Init the RUM browser SDK. @@ -259,7 +263,7 @@ export interface RumPublicApi extends PublicApi { /** * Start a view manually. - * Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. + * Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you've defined them in your SPA application routing. * * @param options.name name of the view * @param options.service service of the view diff --git a/packages/rum-core/src/domain/configuration/configuration.ts b/packages/rum-core/src/domain/configuration/configuration.ts index ecd3ad3d00..17fcf5d9e3 100644 --- a/packages/rum-core/src/domain/configuration/configuration.ts +++ b/packages/rum-core/src/domain/configuration/configuration.ts @@ -21,6 +21,9 @@ import type { PropagatorType, TracingOption } from '../tracing/tracer.types' export const DEFAULT_PROPAGATOR_TYPES: PropagatorType[] = ['tracecontext', 'datadog'] +/** + * Configuration options to pass to the `init()` method when initializing the RUM SDK. + */ export interface RumInitConfiguration extends InitConfiguration { // global options /** diff --git a/packages/rum-core/src/domainContext.types.ts b/packages/rum-core/src/domainContext.types.ts index 656656fade..12213570b8 100644 --- a/packages/rum-core/src/domainContext.types.ts +++ b/packages/rum-core/src/domainContext.types.ts @@ -4,6 +4,9 @@ import type { RumEventType } from './rawRumEvent.types' +/** + * Additional context data that varies based on the type of RUM event being dispatched. + */ export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION @@ -22,6 +25,9 @@ export type RumEventDomainContext = T extends RumE * Additional information available when the SDK dispatches a RUM **View** event. */ export interface RumViewEventDomainContext { + /** + * The browser location object at the time the view was created. + */ location: Readonly } @@ -29,7 +35,13 @@ export interface RumViewEventDomainContext { * Additional information available when the SDK dispatches a RUM **Action** event. */ export interface RumActionEventDomainContext { + /** + * DOM events that triggered this action. + */ events?: Event[] + /** + * Stack trace of where the action was handled by the SDK. + */ handlingStack?: string } @@ -37,12 +49,33 @@ export interface RumActionEventDomainContext { * Additional information available when the SDK dispatches a **Fetch** resource event. */ export interface RumFetchResourceEventDomainContext { + /** + * Init object passed to the fetch call. + */ requestInit?: RequestInit + /** + * Input parameter passed to the fetch call. + */ requestInput: RequestInfo + /** + * Response object returned by the fetch call. + */ response?: Response + /** + * Error that occurred during the fetch call. + */ error?: Error + /** + * Browser performance entry for this resource. + */ performanceEntry?: PerformanceEntry + /** + * Whether the fetch call was aborted. + */ isAborted: boolean + /** + * Stack trace of where the resource was handled by the SDK. + */ handlingStack?: string } @@ -50,9 +83,21 @@ export interface RumFetchResourceEventDomainContext { * Additional information available when the SDK dispatches an **XHR** resource event. */ export interface RumXhrResourceEventDomainContext { + /** + * The XMLHttpRequest object that made the request. + */ xhr: XMLHttpRequest + /** + * Browser performance entry for this resource. + */ performanceEntry?: PerformanceEntry + /** + * Whether the XHR request was aborted. + */ isAborted: boolean + /** + * Stack trace of where the resource was handled by the SDK. + */ handlingStack?: string } @@ -60,6 +105,9 @@ export interface RumXhrResourceEventDomainContext { * Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR. */ export interface RumOtherResourceEventDomainContext { + /** + * Browser performance entry for this resource. + */ performanceEntry: PerformanceEntry } @@ -67,7 +115,13 @@ export interface RumOtherResourceEventDomainContext { * Additional information available when the SDK dispatches an **Error** event. */ export interface RumErrorEventDomainContext { + /** + * The original error object that was captured. + */ error: unknown + /** + * Stack trace of where the error was handled by the SDK. + */ handlingStack?: string } @@ -75,6 +129,9 @@ export interface RumErrorEventDomainContext { * Additional information available when the SDK dispatches a **Long Task** event. */ export interface RumLongTaskEventDomainContext { + /** + * Browser performance entry for this long task. + */ performanceEntry: PerformanceEntry } diff --git a/packages/rum-react/src/entries/main.ts b/packages/rum-react/src/entries/main.ts index b188d536c4..5fdd91b09f 100644 --- a/packages/rum-react/src/entries/main.ts +++ b/packages/rum-react/src/entries/main.ts @@ -1,3 +1,11 @@ +/** + * @packageDocumentation + * Datadog Browser RUM React Integration - Additional components and hooks for React applications. + * Provides React-specific features like Error Boundaries and component performance tracking. + * + * @see {@link https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#react | RUM React Integration} + */ + export { ErrorBoundary, addReactError } from '../domain/error' export { reactPlugin } from '../domain/reactPlugin' // eslint-disable-next-line camelcase diff --git a/packages/rum-slim/src/entries/main.ts b/packages/rum-slim/src/entries/main.ts index 128d227535..670fbf80e5 100644 --- a/packages/rum-slim/src/entries/main.ts +++ b/packages/rum-slim/src/entries/main.ts @@ -1,4 +1,11 @@ -// Keep the following in sync with packages/rum/src/entries/main.ts +/** + * @packageDocumentation + * Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. + * Lightweight alternative for basic RUM monitoring with reduced bundle size. + * + * @see {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup} + */ + import { defineGlobal, getGlobalObject } from '@datadog/browser-core' import type { RumPublicApi } from '@datadog/browser-rum-core' import { makeRumPublicApi, startRum } from '@datadog/browser-rum-core' @@ -28,6 +35,10 @@ export type { } from '@datadog/browser-rum-core' export { DefaultPrivacyLevel } from '@datadog/browser-core' +/** + * The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods. + * @see {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup} + */ export const datadogRum = makeRumPublicApi(startRum, makeRecorderApiStub(), makeProfilerApiStub()) interface BrowserWindow extends Window { diff --git a/packages/rum/src/entries/main.ts b/packages/rum/src/entries/main.ts index 7a49f92fbd..ec467de6ab 100644 --- a/packages/rum/src/entries/main.ts +++ b/packages/rum/src/entries/main.ts @@ -1,3 +1,11 @@ +/** + * @packageDocumentation + * Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. + * Use this package to monitor your web application's performance and user experience. + * + * @see {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup} + */ + // Keep the following in sync with packages/rum-slim/src/entries/main.ts import { defineGlobal, getGlobalObject } from '@datadog/browser-core' import type { RumPublicApi } from '@datadog/browser-rum-core' @@ -34,6 +42,10 @@ const recorderApi = makeRecorderApi(lazyLoadRecorder) const profilerApi = makeProfilerApi() +/** + * The global RUM instance. Use this to call RUM methods. + * @see {@link https://docs.datadoghq.com/real_user_monitoring/browser/ | RUM Browser Monitoring Setup} + */ export const datadogRum = makeRumPublicApi(startRum, recorderApi, profilerApi, { startDeflateWorker, createDeflateEncoder, diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js index 1922232ae6..aba8a3e7d5 100644 --- a/scripts/fix-doc-links.js +++ b/scripts/fix-doc-links.js @@ -13,12 +13,19 @@ function convertLinks(markdown) { }) } +// Fix markdown formatting issues +function fixFormatting(markdown) { + // Remove underscores around (Optional) + return markdown.replace(/_\(Optional\)_/g, '(Optional)') +} + function runMain() { const docsDir = path.join(__dirname, '..', 'docs') const files = globSync(`${docsDir}/**/*.md`, { nodir: true }) files.forEach((file) => { const content = fs.readFileSync(file, 'utf8') - const transformed = convertLinks(content) + let transformed = convertLinks(content) + transformed = fixFormatting(transformed) if (content !== transformed) { fs.writeFileSync(file, transformed, 'utf8') } From 71c3ae7aa009d17981cd005a3acb31d7eb46ebec Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 15:04:42 +0200 Subject: [PATCH 14/21] change --- docs/browser-logs.datadoglogs.md | 111 ++++++- docs/browser-logs.handlertype.md | 111 ++++++- docs/browser-logs.logger._constructor_.md | 113 ++++++- docs/browser-logs.logger.alert.md | 111 ++++++- docs/browser-logs.logger.clearcontext.md | 111 ++++++- docs/browser-logs.logger.critical.md | 111 ++++++- docs/browser-logs.logger.debug.md | 111 ++++++- docs/browser-logs.logger.emerg.md | 111 ++++++- docs/browser-logs.logger.error.md | 111 ++++++- docs/browser-logs.logger.getcontext.md | 111 ++++++- docs/browser-logs.logger.gethandler.md | 113 ++++++- docs/browser-logs.logger.getlevel.md | 111 ++++++- docs/browser-logs.logger.info.md | 111 ++++++- docs/browser-logs.logger.log.md | 111 ++++++- docs/browser-logs.logger.logimplementation.md | 111 ++++++- docs/browser-logs.logger.md | 111 ++++++- docs/browser-logs.logger.notice.md | 111 ++++++- docs/browser-logs.logger.ok.md | 111 ++++++- ...owser-logs.logger.removecontextproperty.md | 111 ++++++- docs/browser-logs.logger.setcontext.md | 111 ++++++- .../browser-logs.logger.setcontextproperty.md | 111 ++++++- docs/browser-logs.logger.sethandler.md | 113 ++++++- docs/browser-logs.logger.setlevel.md | 111 ++++++- docs/browser-logs.logger.warn.md | 111 ++++++- ...rowser-logs.loggerconfiguration.context.md | 111 ++++++- ...rowser-logs.loggerconfiguration.handler.md | 111 ++++++- .../browser-logs.loggerconfiguration.level.md | 111 ++++++- docs/browser-logs.loggerconfiguration.md | 113 ++++++- docs/browser-logs.logsevent.application_id.md | 111 ++++++- docs/browser-logs.logsevent.date.md | 111 ++++++- docs/browser-logs.logsevent.error.md | 111 ++++++- docs/browser-logs.logsevent.http.md | 111 ++++++- docs/browser-logs.logsevent.logger.md | 111 ++++++- docs/browser-logs.logsevent.md | 125 +++++++- docs/browser-logs.logsevent.message.md | 111 ++++++- docs/browser-logs.logsevent.origin.md | 111 ++++++- docs/browser-logs.logsevent.service.md | 111 ++++++- docs/browser-logs.logsevent.session.md | 111 ++++++- docs/browser-logs.logsevent.session_id.md | 111 ++++++- docs/browser-logs.logsevent.status.md | 111 ++++++- docs/browser-logs.logsevent.view.md | 111 ++++++- docs/browser-logs.logseventdomaincontext.md | 111 ++++++- docs/browser-logs.logsglobal.clearaccount.md | 111 ++++++- ...wser-logs.logsglobal.clearglobalcontext.md | 113 ++++++- docs/browser-logs.logsglobal.clearuser.md | 113 ++++++- docs/browser-logs.logsglobal.createlogger.md | 113 ++++++- docs/browser-logs.logsglobal.getaccount.md | 111 ++++++- ...rowser-logs.logsglobal.getglobalcontext.md | 113 ++++++- ...er-logs.logsglobal.getinitconfiguration.md | 111 ++++++- ...wser-logs.logsglobal.getinternalcontext.md | 115 ++++++- docs/browser-logs.logsglobal.getlogger.md | 113 ++++++- docs/browser-logs.logsglobal.getuser.md | 113 ++++++- docs/browser-logs.logsglobal.init.md | 111 ++++++- docs/browser-logs.logsglobal.logger.md | 111 ++++++- docs/browser-logs.logsglobal.md | 139 ++++++++- ...r-logs.logsglobal.removeaccountproperty.md | 111 ++++++- ....logsglobal.removeglobalcontextproperty.md | 113 ++++++- ...wser-logs.logsglobal.removeuserproperty.md | 113 ++++++- docs/browser-logs.logsglobal.setaccount.md | 111 ++++++- ...wser-logs.logsglobal.setaccountproperty.md | 111 ++++++- ...rowser-logs.logsglobal.setglobalcontext.md | 111 ++++++- ...ogs.logsglobal.setglobalcontextproperty.md | 111 ++++++- ...wser-logs.logsglobal.settrackingconsent.md | 111 ++++++- docs/browser-logs.logsglobal.setuser.md | 113 ++++++- docs/browser-logs.logsglobal.setuser_1.md | 111 ++++++- ...browser-logs.logsglobal.setuserproperty.md | 111 ++++++- ...r-logs.logsinitconfiguration.beforesend.md | 111 ++++++- ...ogsinitconfiguration.forwardconsolelogs.md | 111 ++++++- ...gsinitconfiguration.forwarderrorstologs.md | 111 ++++++- ...gs.logsinitconfiguration.forwardreports.md | 113 ++++++- docs/browser-logs.logsinitconfiguration.md | 123 +++++++- ...logs.logsinitconfiguration.usepciintake.md | 113 ++++++- docs/browser-logs.logsmessage.context.md | 111 ++++++- docs/browser-logs.logsmessage.md | 111 ++++++- docs/browser-logs.logsmessage.message.md | 111 ++++++- docs/browser-logs.logsmessage.status.md | 111 ++++++- docs/browser-logs.md | 111 ++++++- docs/browser-logs.statustype.md | 111 ++++++- docs/browser-rum-react.addreacterror.md | 111 ++++++- ...r-rum-react.errorboundary._constructor_.md | 111 ++++++- ...m-react.errorboundary.componentdidcatch.md | 111 ++++++- ....errorboundary.getderivedstatefromerror.md | 111 ++++++- docs/browser-rum-react.errorboundary.md | 111 ++++++- .../browser-rum-react.errorboundary.render.md | 111 ++++++- ...wser-rum-react.errorboundary.reseterror.md | 111 ++++++- docs/browser-rum-react.md | 111 ++++++- docs/browser-rum-react.reactplugin.md | 111 ++++++- ...um-react.unstable_reactcomponenttracker.md | 111 ++++++- docs/browser-rum-slim.datadogrum.md | 111 ++++++- docs/browser-rum-slim.md | 111 ++++++- docs/browser-rum.commonproperties._dd.md | 111 ++++++- docs/browser-rum.commonproperties.account.md | 111 ++++++- ...rowser-rum.commonproperties.application.md | 111 ++++++- docs/browser-rum.commonproperties.build_id.md | 111 ++++++- ...wser-rum.commonproperties.build_version.md | 111 ++++++- docs/browser-rum.commonproperties.ci_test.md | 111 ++++++- ...owser-rum.commonproperties.connectivity.md | 111 ++++++- docs/browser-rum.commonproperties.context.md | 111 ++++++- docs/browser-rum.commonproperties.date.md | 111 ++++++- docs/browser-rum.commonproperties.device.md | 111 ++++++- docs/browser-rum.commonproperties.display.md | 111 ++++++- docs/browser-rum.commonproperties.md | 139 ++++++++- docs/browser-rum.commonproperties.os.md | 111 ++++++- docs/browser-rum.commonproperties.service.md | 111 ++++++- docs/browser-rum.commonproperties.session.md | 111 ++++++- docs/browser-rum.commonproperties.source.md | 111 ++++++- ...browser-rum.commonproperties.synthetics.md | 111 ++++++- docs/browser-rum.commonproperties.usr.md | 111 ++++++- docs/browser-rum.commonproperties.version.md | 111 ++++++- docs/browser-rum.commonproperties.view.md | 111 ++++++- docs/browser-rum.datadogrum.md | 111 ++++++- docs/browser-rum.md | 111 ++++++- docs/browser-rum.rumactionevent.md | 111 ++++++- ...-rum.rumactioneventdomaincontext.events.md | 111 ++++++- ...mactioneventdomaincontext.handlingstack.md | 111 ++++++- ...browser-rum.rumactioneventdomaincontext.md | 113 ++++++- docs/browser-rum.rumerrorevent.md | 111 ++++++- ...er-rum.rumerroreventdomaincontext.error.md | 111 ++++++- ...umerroreventdomaincontext.handlingstack.md | 111 ++++++- .../browser-rum.rumerroreventdomaincontext.md | 111 ++++++- docs/browser-rum.rumevent.md | 111 ++++++- docs/browser-rum.rumeventdomaincontext.md | 111 ++++++- ...umfetchresourceeventdomaincontext.error.md | 111 ++++++- ...esourceeventdomaincontext.handlingstack.md | 111 ++++++- ...tchresourceeventdomaincontext.isaborted.md | 111 ++++++- ...-rum.rumfetchresourceeventdomaincontext.md | 111 ++++++- ...urceeventdomaincontext.performanceentry.md | 111 ++++++- ...hresourceeventdomaincontext.requestinit.md | 111 ++++++- ...resourceeventdomaincontext.requestinput.md | 111 ++++++- ...etchresourceeventdomaincontext.response.md | 111 ++++++- docs/browser-rum.rumglobal.addaction.md | 111 ++++++- .../browser-rum.rumglobal.adddurationvital.md | 111 ++++++- docs/browser-rum.rumglobal.adderror.md | 111 ++++++- ...-rum.rumglobal.addfeatureflagevaluation.md | 111 ++++++- docs/browser-rum.rumglobal.addtiming.md | 111 ++++++- docs/browser-rum.rumglobal.clearaccount.md | 111 ++++++- ...rowser-rum.rumglobal.clearglobalcontext.md | 113 ++++++- docs/browser-rum.rumglobal.clearuser.md | 113 ++++++- docs/browser-rum.rumglobal.getaccount.md | 111 ++++++- .../browser-rum.rumglobal.getglobalcontext.md | 113 ++++++- ...wser-rum.rumglobal.getinitconfiguration.md | 111 ++++++- ...rowser-rum.rumglobal.getinternalcontext.md | 113 ++++++- ...wser-rum.rumglobal.getsessionreplaylink.md | 113 ++++++- docs/browser-rum.rumglobal.getuser.md | 113 ++++++- docs/browser-rum.rumglobal.getviewcontext.md | 111 ++++++- docs/browser-rum.rumglobal.init.md | 111 ++++++- docs/browser-rum.rumglobal.md | 141 ++++++++- ...ser-rum.rumglobal.removeaccountproperty.md | 111 ++++++- ...m.rumglobal.removeglobalcontextproperty.md | 113 ++++++- ...rowser-rum.rumglobal.removeuserproperty.md | 113 ++++++- docs/browser-rum.rumglobal.setaccount.md | 111 ++++++- ...rowser-rum.rumglobal.setaccountproperty.md | 111 ++++++- .../browser-rum.rumglobal.setglobalcontext.md | 111 ++++++- ...-rum.rumglobal.setglobalcontextproperty.md | 111 ++++++- ...rowser-rum.rumglobal.settrackingconsent.md | 111 ++++++- docs/browser-rum.rumglobal.setuser.md | 113 ++++++- docs/browser-rum.rumglobal.setuser_1.md | 111 ++++++- docs/browser-rum.rumglobal.setuserproperty.md | 111 ++++++- docs/browser-rum.rumglobal.setviewcontext.md | 111 ++++++- ...er-rum.rumglobal.setviewcontextproperty.md | 111 ++++++- docs/browser-rum.rumglobal.setviewname.md | 111 ++++++- ...rowser-rum.rumglobal.startdurationvital.md | 111 ++++++- ...m.rumglobal.startsessionreplayrecording.md | 113 ++++++- docs/browser-rum.rumglobal.startview.md | 111 ++++++- ...browser-rum.rumglobal.stopdurationvital.md | 111 ++++++- docs/browser-rum.rumglobal.stopsession.md | 111 ++++++- ...um.rumglobal.stopsessionreplayrecording.md | 113 ++++++- ...uminitconfiguration.actionnameattribute.md | 111 ++++++- ...ruminitconfiguration.allowedtracingurls.md | 111 ++++++- ...-rum.ruminitconfiguration.applicationid.md | 111 ++++++- ...ser-rum.ruminitconfiguration.beforesend.md | 111 ++++++- ...nitconfiguration.compressintakerequests.md | 111 ++++++- ...uminitconfiguration.defaultprivacylevel.md | 111 ++++++- ...onfiguration.enableprivacyforactionname.md | 111 ++++++- ...minitconfiguration.excludedactivityurls.md | 111 ++++++- docs/browser-rum.ruminitconfiguration.md | 153 ++++++++-- ...rowser-rum.ruminitconfiguration.plugins.md | 111 ++++++- ...uminitconfiguration.profilingsamplerate.md | 111 ++++++- ...initconfiguration.propagatetracebaggage.md | 111 ++++++- ...initconfiguration.remoteconfigurationid.md | 111 ++++++- ...itconfiguration.sessionreplaysamplerate.md | 113 ++++++- ...ion.startsessionreplayrecordingmanually.md | 111 ++++++- ...wser-rum.ruminitconfiguration.subdomain.md | 111 ++++++- ...initconfiguration.tracecontextinjection.md | 111 ++++++- ...um.ruminitconfiguration.tracesamplerate.md | 111 ++++++- ...onfiguration.trackfeatureflagsforevents.md | 111 ++++++- ...rum.ruminitconfiguration.tracklongtasks.md | 111 ++++++- ...rum.ruminitconfiguration.trackresources.md | 111 ++++++- ...initconfiguration.trackuserinteractions.md | 111 ++++++- ...ruminitconfiguration.trackviewsmanually.md | 111 ++++++- ...wser-rum.ruminitconfiguration.workerurl.md | 111 ++++++- docs/browser-rum.rumlongtaskevent.md | 111 ++++++- ...owser-rum.rumlongtaskeventdomaincontext.md | 111 ++++++- ...taskeventdomaincontext.performanceentry.md | 111 ++++++- ...-rum.rumotherresourceeventdomaincontext.md | 111 ++++++- ...urceeventdomaincontext.performanceentry.md | 111 ++++++- docs/browser-rum.rumresourceevent.md | 111 ++++++- docs/browser-rum.rumviewevent.md | 111 ++++++- ...-rum.rumvieweventdomaincontext.location.md | 111 ++++++- docs/browser-rum.rumvieweventdomaincontext.md | 111 ++++++- docs/browser-rum.rumvitalevent.md | 111 ++++++- ...esourceeventdomaincontext.handlingstack.md | 111 ++++++- ...xhrresourceeventdomaincontext.isaborted.md | 111 ++++++- ...er-rum.rumxhrresourceeventdomaincontext.md | 111 ++++++- ...urceeventdomaincontext.performanceentry.md | 111 ++++++- ...um.rumxhrresourceeventdomaincontext.xhr.md | 111 ++++++- docs/index.md | 111 ++++++- docs/style.css | 121 ++++++++ scripts/fix-doc-links.js | 289 +++++++++++++++++- 209 files changed, 23282 insertions(+), 319 deletions(-) create mode 100644 docs/style.css diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index e8080c46a6..36a76bb761 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > datadogLogs diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index 4c647614b6..e89f39b462 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > HandlerType diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index e3619d1fab..b560414647 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > (constructor) @@ -67,7 +176,7 @@ handlerType -HandlerType \| HandlerType\[\] +HandlerType | HandlerType[] diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 48011cc323..109b27f2a7 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > alert diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index a61699e2ae..5cba14afc0 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > clearContext diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 0b16b394ca..7049c80e15 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > critical diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 52ef50524e..5daf12f4f3 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > debug diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index ee6a6c3abe..9d9c9f04a1 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > emerg diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index b16b6e1f49..1999c617c6 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > error diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 847897dc6a..41059d29bd 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > getContext diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 7e09bd4314..66494da7dc 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > getHandler @@ -11,5 +120,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType \| HandlerType\[\] +HandlerType | HandlerType[] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 116d582953..f9bca49cde 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > getLevel diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index c68fc09ce5..1d29ba119c 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > info diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 9534e2dbaa..8afbb1d797 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > log diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index d4d15f44f7..57f537d265 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > logImplementation diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 537cfee72a..d36336e65f 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index f9836a7c30..8c68164e74 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > notice diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index eb4ab969a7..0310487c98 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > ok diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index a1e0ebd782..82dd5b3451 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > removeContextProperty diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 10c3e47398..a395bd27de 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > setContext diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 37ce71e0b9..0561bce728 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > setContextProperty diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index a92a47f79c..10570eec94 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > setHandler @@ -35,7 +144,7 @@ handler -HandlerType \| HandlerType\[\] +HandlerType | HandlerType[] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 0367f97bf3..3754aa3ca7 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > setLevel diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 2dd15971ba..c55dedb046 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > Logger > warn diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index da351e1643..aa70d1b491 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > context diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 906fea4454..62f53f5732 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > handler diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 0f64773a54..aee84243cf 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > level diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index e2b8267b7e..1840d8dc79 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LoggerConfiguration @@ -62,7 +171,7 @@ object -HandlerType \| HandlerType\[\] +HandlerType | HandlerType[] diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 55763153a4..3a01ce1bd9 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > application\_id diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index ec9e4e24fb..fff8b3a5ad 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > date diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 462b2e1f6c..040f8c501a 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > error diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 3206ecd365..b0af055caf 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > http diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 87d2079448..c0da1378c2 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > logger diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index dff3e73297..946bca9272 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent @@ -81,7 +190,7 @@ Start of the log in ms from epoch -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; [k: string]: unknown; } @@ -100,7 +209,7 @@ Start of the log in ms from epoch -{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } +{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status\_code: number; url: string; [k: string]: unknown; } @@ -119,7 +228,7 @@ Start of the log in ms from epoch -{ name: string; \[k: string\]: unknown; } +{ name: string; [k: string]: unknown; } @@ -157,7 +266,7 @@ The log message -'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' +'network' | 'source' | 'console' | 'logger' | 'agent' | 'report' @@ -214,7 +323,7 @@ string -{ id?: string; \[k: string\]: unknown; } +{ id?: string; [k: string]: unknown; } @@ -233,7 +342,7 @@ string -'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' +'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg' @@ -252,7 +361,7 @@ The log status -{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } +{ referrer?: string; url: string; id?: string; [k: string]: unknown; } diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 0e688c568e..ad073e8762 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > message diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 1b4dbf42f8..31999be448 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > origin diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index 251a28d0bd..8a65768d3a 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > service diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 179cbc5713..49f4df476c 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > session diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 76891367dc..5758baae73 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > session\_id diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 898f1fe479..459e157819 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > status diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 3ac0abb479..b4b9c7f1e1 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEvent > view diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 867014bb3b..d2bb80df34 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsEventDomainContext diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index 9df5f06c88..f0eb699322 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearAccount diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index 5c5e536b07..ed7748e1b0 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext @@ -6,7 +115,7 @@ Clear the global context -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 8adcc276b4..bf791e2980 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearUser @@ -6,7 +115,7 @@ Clear all user information -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 2503071fe4..8ec1c8bf76 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > createLogger @@ -6,7 +115,7 @@ The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 43d16fefcf..0515d4a058 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getAccount diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index d10bbe30d9..d05e88137f 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getGlobalContext @@ -6,7 +115,7 @@ Get the global Context -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index a1a53cc138..efa58ca90e 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index c22bd2af3e..7bbcb4ec3b 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,12 +1,121 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context -See \Access internal context\ for further information. +See Access internal context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 1cb3fb0ae6..1a1a2bd2fe 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getLogger @@ -6,7 +115,7 @@ Get a logger -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 0cb46a9696..258bf4926c 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > getUser @@ -6,7 +115,7 @@ Get user information -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 65bcd0c20f..d6765e2966 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > init diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index c5a9be9bfe..eb11dbdab5 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > logger diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 082fc0b13a..f04553dd00 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal @@ -70,7 +179,7 @@ Clear all account information Clear the global context -See \Overwrite context\ for further information. +See Overwrite context for further information. @@ -91,7 +200,7 @@ See \User context\ for further information. +See User context for further information. @@ -112,7 +221,7 @@ See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. @@ -152,7 +261,7 @@ Get account information Get the global Context -See \Overwrite context\ for further information. +See Overwrite context for further information. @@ -166,7 +275,7 @@ See \LogsInitConfiguration \| undefined +() => LogsInitConfiguration | undefined @@ -185,14 +294,14 @@ Get the init configuration -(startTime?: number) => InternalContext \| undefined +(startTime?: number) => InternalContext | undefined -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context -See \Access internal context\ for further information. +See Access internal context for further information. @@ -206,14 +315,14 @@ See \Logger \| undefined +(name: string) => Logger | undefined Get a logger -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. @@ -234,7 +343,7 @@ See \User context\ for further information. +See User context for further information. @@ -310,7 +419,7 @@ Remove an account property Remove a global context property -See \Overwrite context\ for further information. +See Overwrite context for further information. @@ -331,7 +440,7 @@ See \User context\ for further information. +See User context for further information. @@ -473,7 +582,7 @@ Description Set user information to all events, stored in `@usr` -See \User context\ for further information. +See User context for further information. diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 2321d5b50e..3782fb41b1 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index d64200108f..3fe37187c5 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty @@ -6,7 +115,7 @@ Remove a global context property -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 47942669d5..4539749439 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeUserProperty @@ -6,7 +115,7 @@ Remove a user property -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index d4273bc766..a6d289ebe0 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setAccount diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 0ff6da5fd5..985480e5cf 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setAccountProperty diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index f07063e025..946e9decf8 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContext diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 9e475d236d..4660d79f7b 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index b59ca39ee6..4556892778 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 76ad33f57a..a547b75d1a 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUser @@ -6,7 +115,7 @@ Set user information to all events, stored in `@usr` -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 9570bc14e2..98560b844a 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUser diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 1aa3195263..e68e077534 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUserProperty diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index d0b1eb8d6b..96de854c73 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index cdd472a5e8..c192f82fb9 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index f1920aa7f3..ee2a9eaea1 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index fd149e19fb..55fb4932fd 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,10 +1,119 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property -Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index a241bdb8bf..bc9d2cda5e 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration @@ -44,7 +153,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined @@ -63,7 +172,7 @@ Description -ConsoleApiName\[\] \| 'all' \| undefined +ConsoleApiName[] | 'all' | undefined @@ -82,7 +191,7 @@ ConsoleApiName\[\] \| 'all' \| undefined -boolean \| undefined +boolean | undefined @@ -101,12 +210,12 @@ boolean \| undefined -RawReportType\[\] \| 'all' \| undefined +RawReportType[] | 'all' | undefined -(Optional) Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +(Optional) Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. @@ -125,7 +234,7 @@ boolean -(Optional) Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false +(Optional) Use PCI-compliant intake. See PCI DSS Compliance for further information. false diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 24859ac38e..75575af44e 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,10 +1,119 @@ - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property -Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false +Use PCI-compliant intake. See PCI DSS Compliance for further information. false **Signature:** diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 537ccc7a78..b962af643f 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsMessage > context diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 107876469a..8a8a28df05 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsMessage diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index ba97f70fb7..c6abc4f88b 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsMessage > message diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 3217ac3816..0cb27433bf 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > LogsMessage > status diff --git a/docs/browser-logs.md b/docs/browser-logs.md index cbafd19deb..7c3d60be63 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 4d9dade523..8a4c47733d 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-logs > StatusType diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index e00eafc47e..ac1b94befa 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > addReactError diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 8ccd318cde..1f8b6f5a3a 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index b14b0fb664..0ec18ab35e 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 5b987d5bdc..4836266c66 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 0a6b26b377..43f3158e5f 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 7c6ac00636..e5c97e901b 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > render diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 48532c6c9f..1923a645cf 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > resetError diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 8228bf87f4..7fada25351 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 94c4d7e535..3306a1ce23 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > reactPlugin diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 595b895ff8..08edcaff59 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 917da31e02..29f4f3c709 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-slim > datadogRum diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index ca909b306e..c4e73031a9 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum-slim diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index ad1cb08af6..38a9f25e3b 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > \_dd diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 45368c8e6e..1f857a545d 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > account diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index cd13d05e30..9f1628f504 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > application diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index b86a419740..85b91f2b1a 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > build\_id diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 9633cbb6ea..b73aa451e5 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > build\_version diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 49573e6d83..9200293fc6 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > ci\_test diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 487f61ebe0..e3b891cf7e 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > connectivity diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index e565438b7b..60ee86c122 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > context diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index bdb152047d..84c512356e 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > date diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index c1a3c6a1e0..72e14a83b5 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > device diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 861e290d0e..fc02ba7835 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > display diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 2cfeef35c1..7b1bcb5173 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties @@ -47,7 +156,7 @@ Description -{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } +{ readonly format\_version: 2; session?: { plan?: 1 | 2; readonly session\_precondition?: 'user\_app\_launch' | 'inactivity\_timeout' | 'max\_duration' | 'background\_launch' | 'prewarm' | 'from\_non\_interactive\_session' | 'explicit\_stop'; [k: string]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; [k: string]: unknown; }; readonly browser\_sdk\_version?: string; [k: string]: unknown; } @@ -68,7 +177,7 @@ Internal properties -{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } +{ readonly id: string; readonly name?: string; [k: string]: unknown; } @@ -89,7 +198,7 @@ Internal properties -{ readonly id: string; \[k: string\]: unknown; } +{ readonly id: string; [k: string]: unknown; } @@ -152,7 +261,7 @@ string -{ readonly test\_execution\_id: string; \[k: string\]: unknown; } +{ readonly test\_execution\_id: string; [k: string]: unknown; } @@ -171,7 +280,7 @@ string -{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } +{ readonly status: 'connected' | 'not\_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; readonly effective\_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; [k: string]: unknown; }; [k: string]: unknown; } @@ -190,7 +299,7 @@ string -{ \[k: string\]: unknown; } +{ [k: string]: unknown; } @@ -230,7 +339,7 @@ Start of the event in ms from epoch -{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } +{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming\_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; [k: string]: unknown; } @@ -249,7 +358,7 @@ Start of the event in ms from epoch -{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } +{ readonly viewport?: { readonly width: number; readonly height: number; [k: string]: unknown; }; [k: string]: unknown; } @@ -268,7 +377,7 @@ Start of the event in ms from epoch -{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } +{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; [k: string]: unknown; } @@ -308,7 +417,7 @@ string -{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } +{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci\_test'; readonly has\_replay?: boolean; [k: string]: unknown; } @@ -329,7 +438,7 @@ Session properties -'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' +'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform' @@ -350,7 +459,7 @@ Session properties -{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } +{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; [k: string]: unknown; } @@ -371,7 +480,7 @@ Session properties -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; [k: string]: unknown; } @@ -411,7 +520,7 @@ string -{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } +{ readonly id: string; referrer?: string; url: string; name?: string; [k: string]: unknown; } diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 536aa92efd..0ff7e26911 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > os diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index 75bd81afa2..edd3d6edb3 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > service diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index d546e76ce3..677456e00b 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > session diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index c3de043c5d..cbea58e330 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > source diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 2fafb2b1a1..f4c65072ca 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > synthetics diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 7b6b5f4cd4..673752c9f3 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > usr diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 9854d3ef1c..376ba27e2a 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > version diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index b2a07261e5..1fd15768e6 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > CommonProperties > view diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 2b39faf4bc..58f5eb0f40 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > datadogRum diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 743101b513..811c379a87 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 5df82dc308..546721db08 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumActionEvent diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 6698f63bae..e742a9c394 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext > events diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 3a381da3c1..6f2c64ac9b 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 91937c5cdf..6c063df35c 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext @@ -43,7 +152,7 @@ Description -Event\[\] +Event[] diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index d539728f58..96b369360d 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumErrorEvent diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 833d7b2a30..53299be681 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext > error diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index fe21529635..91bb7886af 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index aa70a3ef61..27c173f579 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 2e3d079ae0..f83bdbd939 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumEvent diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 7e9b0b07ea..a97e4ceaf8 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 384bf37e94..4e48fc8384 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index e8c761d8d7..cd391a6a31 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 1245b6a516..6ba40e8a4d 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index c93b2f9144..8983ed4ad2 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index dd65de0e81..78adbad0a2 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 49ccfc94fe..f6384af879 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 66999ec3d0..4bf0ce16f9 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 50db70b5a5..d1f940f7df 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 1d2b039ff5..a2d0bff7d5 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > addAction diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index fc23fa7b0f..c527375eb3 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > addDurationVital diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index d560b0591b..dd094832d7 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > addError diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 706ce9c41f..78fe5c7973 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 3fcd32fd26..28c96e56e2 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > addTiming diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 07b37b26d5..df5259e1d6 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > clearAccount diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index c4c687ba47..cb25e398b4 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > clearGlobalContext @@ -6,7 +115,7 @@ Clear the global context -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 7e42ce3c9a..b1a4e8bcb1 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > clearUser @@ -6,7 +115,7 @@ Clear all user information -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index dba65370b3..f940305b50 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getAccount diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 6ca297788e..f1525479f2 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getGlobalContext @@ -6,7 +115,7 @@ Get the global Context -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 207a9ba9b4..6a89ed913c 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getInitConfiguration diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 9377e29955..7010d7010f 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,10 +1,119 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context **Signature:** diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 523e21415a..ffe8398be5 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink @@ -6,7 +115,7 @@ Get the Session Replay Link. -See \Connect Session Replay To Your Third-Party Tools\ for further information. +See Connect Session Replay To Your Third-Party Tools for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index f443dcd8d0..cd1c1b9ead 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getUser @@ -6,7 +115,7 @@ Get user information -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 7fc407f915..92d59f7e52 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > getViewContext diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 1142877612..6c33e3ab24 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > init diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index a9c624b401..bf6a3bf3ea 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal @@ -165,7 +274,7 @@ Clear all account information Clear the global context -See \Global context\ for further information. +See Global context for further information. @@ -186,7 +295,7 @@ See \User session\ for further information. +See User session for further information. @@ -226,7 +335,7 @@ Get account information Get the global Context -See \Global context\ for further information. +See Global context for further information. @@ -240,7 +349,7 @@ See \RumInitConfiguration \| undefined +() => RumInitConfiguration | undefined @@ -259,12 +368,12 @@ Get the init configuration -(startTime?: number) => InternalContext \| undefined +(startTime?: number) => InternalContext | undefined -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context @@ -278,14 +387,14 @@ Get the init configuration -() => string \| undefined +() => string | undefined Get the Session Replay Link. -See \Connect Session Replay To Your Third-Party Tools\ for further information. +See Connect Session Replay To Your Third-Party Tools for further information. @@ -306,7 +415,7 @@ See \User session\ for further information. +See User session for further information. @@ -384,7 +493,7 @@ Remove an account property Remove a global context property -See \Global context\ for further information. +See Global context for further information. @@ -405,7 +514,7 @@ See \User session\ for further information. +See User session for further information. @@ -624,7 +733,7 @@ If you plan to have multiple durations for the same vital, you should use the re Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. @@ -657,7 +766,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void +(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void @@ -702,7 +811,7 @@ Stop the session. A new session will start at the next user interaction with the Stop Session Replay recording. -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. @@ -730,7 +839,7 @@ Description Set user information to all events, stored in `@usr` -See \User session\ for further information. +See User session for further information. diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index e8f1c73c0b..414d2b9db4 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > removeAccountProperty diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index b57a72c511..18e981ee25 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty @@ -6,7 +115,7 @@ Remove a global context property -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 190cc5cf6d..1769fa405d 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > removeUserProperty @@ -6,7 +115,7 @@ Remove a user property -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index a559156d79..1abc92887b 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setAccount diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 6d41e04cb2..0d7733fd43 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setAccountProperty diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 08d98484b9..e381d526ec 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setGlobalContext diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 542c3c639b..155fa594d4 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 41efadfec9..f2cbdb1e09 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setTrackingConsent diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index a086a3e0f5..6077b45c9f 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setUser @@ -6,7 +115,7 @@ Set user information to all events, stored in `@usr` -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 972a0ae9f2..1d18a47d47 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setUser diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 1165900244..3d2dacf911 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setUserProperty diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 95f2670ab2..b76d89dfa2 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewContext diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 19adf5c441..c8348006c4 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewContextProperty diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 5077efb0d9..f8899e7a55 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewName diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 58a2ff805c..68e1088c0a 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > startDurationVital diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 8cb1159886..803adca16b 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording @@ -6,7 +115,7 @@ Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index efddb37e3a..a76976d122 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > startView diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 40272a366e..0ab7d4d9aa 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > stopDurationVital diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 776655c5cf..a96b7f6a42 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > stopSession diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index fac27e9aa0..ac56d1484a 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording @@ -6,7 +115,7 @@ Stop Session Replay recording. -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 1e48a2c7ef..df44cd11c7 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 7804d4d183..67b4a71d63 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index b93cb36c87..eabdcd55b8 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > applicationId diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 40e6814128..d4313810c4 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > beforeSend diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 3413d6cb14..69b7006006 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index d82ab6acac..b6df1bbaf1 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 71a0cbe060..78778ebd6b 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index af9c9bf573..b5fe1be865 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index f4ec74019b..9e186d2909 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration @@ -44,7 +153,7 @@ Description -string \| undefined +string | undefined @@ -63,7 +172,7 @@ string \| undefined -Array<MatchOption \| TracingOption> \| undefined +Array<MatchOption | TracingOption> | undefined @@ -101,7 +210,7 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined @@ -122,7 +231,7 @@ See Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +(Optional) The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. @@ -293,7 +402,7 @@ number \| undefined -boolean \| undefined +boolean | undefined @@ -331,7 +440,7 @@ string -TraceContextInjection \| undefined +TraceContextInjection | undefined @@ -350,7 +459,7 @@ TraceContextInjection \| undefined -number \| undefined +number | undefined @@ -369,7 +478,7 @@ number \| undefined -FeatureFlagsForEvents\[\] +FeatureFlagsForEvents[] @@ -388,7 +497,7 @@ FeatureFlagsForEvents\[\] -boolean \| undefined +boolean | undefined @@ -407,7 +516,7 @@ boolean \| undefined -boolean \| undefined +boolean | undefined @@ -426,7 +535,7 @@ boolean \| undefined -boolean \| undefined +boolean | undefined @@ -445,7 +554,7 @@ boolean \| undefined -boolean \| undefined +boolean | undefined diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 1e521d1a29..9a7a462a30 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > plugins diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index c08a3537d5..df85a70e64 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 42f57c809a..07eb856fc1 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 925f00267a..3eafb31915 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 0057df27ea..825cab12b1 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,10 +1,119 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property -The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 427130229c..b01ab6e041 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index ed3d388410..160bc2371b 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > subdomain diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index b5593bdb99..f2dcb0ca3f 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index f509245641..d32c7cd413 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 11f8345f45..f94c158eb8 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 8b2b7a0f5f..c38abc919b 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 9c05a1120b..8312ac284f 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackResources diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index 198c9f2565..c9055f36a1 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index d028a6d8ac..40b714f2b9 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index fdb93f3581..06c01e2132 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > workerUrl diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 4bec40e6c7..69059151aa 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumLongTaskEvent diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 47e7b1500f..203c8117e1 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 71f23621a5..786002fc42 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 316fd6bedf..4dde66fe14 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 6bc0840e08..b383c9bc13 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 20eb3f5607..f17ecd5396 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumResourceEvent diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 14076df1df..0e11fe7a85 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumViewEvent diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 084978dfb8..5c3fea4fdb 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumViewEventDomainContext > location diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index f2d51a2686..229e466f62 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumViewEventDomainContext diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 95c1c41d20..292eaa1af4 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumVitalEvent diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index c3c3e7c215..cbc6737f97 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 1da2a404dc..3b33551436 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 23ec8cab4f..c10cc01681 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 23288a5767..752d4668f0 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 7a02ed5a6c..0183d92ecd 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,4 +1,113 @@ - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr diff --git a/docs/index.md b/docs/index.md index 752a2b7655..419a425d7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,113 @@ - + + + + + Home diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000000..5ed78aa04e --- /dev/null +++ b/docs/style.css @@ -0,0 +1,121 @@ +/* Modern documentation styling */ +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +body { + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif; + line-height: 1.6; + color: #333; + max-width: 1200px; + margin: 0 auto; + padding: 20px; + background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%); + min-height: 100vh; +} + +h1, h2, h3, h4, h5, h6 { + color: #2c3e50; + font-weight: 600; + margin-top: 2em; + margin-bottom: 0.5em; +} + +h1 { + border-bottom: 2px solid #632ca6; + padding-bottom: 0.5em; + color: #632ca6; +} + +h2 { + border-bottom: 1px solid #e1e4e8; + padding-bottom: 0.3em; +} + +table { + width: 100%; + border-collapse: collapse; + margin: 1em 0; + background-color: white; + border-radius: 6px; + overflow: hidden; + box-shadow: 0 1px 3px rgba(0,0,0,0.1); +} + +thead { + background-color: #632ca6; + color: white; +} + +th, td { + padding: 12px; + text-align: left; + border-bottom: 1px solid #e1e4e8; +} + +th { + font-weight: 600; + font-size: 0.9em; + text-transform: uppercase; + letter-spacing: 0.5px; +} + +tbody tr:hover { + background-color: #f8f9fa; +} + +code { + background-color: #f1f3f4; + padding: 2px 6px; + border-radius: 3px; + font-family: 'SF Mono', 'Monaco', 'Inconsolata', 'Roboto Mono', monospace; + font-size: 0.9em; + color: #d73a49; +} + +pre { + background-color: #f6f8fa; + border: 1px solid #e1e4e8; + border-radius: 6px; + padding: 16px; + overflow-x: auto; + margin: 1em 0; +} + +a { + color: #632ca6; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +table a { + font-weight: 500; + padding: 4px 8px; + background-color: #f1f3f4; + border-radius: 4px; + transition: background-color 0.2s; +} + +table a:hover { + background-color: #e1e4e8; + text-decoration: none; +} + +@media (max-width: 768px) { + body { + padding: 10px; + } + + table { + font-size: 0.9em; + } + + th, td { + padding: 8px; + } +} diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js index aba8a3e7d5..f31e073684 100644 --- a/scripts/fix-doc-links.js +++ b/scripts/fix-doc-links.js @@ -1,3 +1,5 @@ +#!/usr/bin/env node + const fs = require('fs') const path = require('path') const { globSync } = require('glob') @@ -13,26 +15,303 @@ function convertLinks(markdown) { }) } -// Fix markdown formatting issues +// Fix markdown formatting issues and add modern styling function fixFormatting(markdown) { + let content = markdown + // Remove underscores around (Optional) - return markdown.replace(/_\(Optional\)_/g, '(Optional)') + content = content.replace(/_\(Optional\)_/g, '(Optional)') + + // Fix escaped links back to proper HTML + content = content.replace(/\\]*>([^<]+)\\<\/a>/g, '$2') + + // Remove inappropriate backslashes around text + content = content.replace(/\\(\[Internal API\])/g, '$1') + content = content.replace(/\\(\[k: string\])/g, '$1') + content = content.replace(/\\(\[)/g, '[') + content = content.replace(/\\(\])/g, ']') + content = content.replace(/\\(\{)/g, '{') + content = content.replace(/\\(\})/g, '}') + + // Fix escaped characters in table cells and code + content = content.replace(/\\\|/g, '|') + content = content.replace(/\\\//g, '/') + + // Fix specific problematic text patterns like "User session\" + content = content.replace(/([A-Za-z\s]+)\\"/g, '$1"') + content = content.replace(/\\"([A-Za-z\s]+)/g, '"$1') + + // Improve readability of array notation + content = content.replace(/\\\[\\\]/g, '[]') + + // Add modern CSS styling at the beginning of the document + if (!content.includes(' + +` + + // Insert CSS at the beginning of the document after the comment + if (content.includes('/, `$&\n\n${cssStyles}`) + } else { + content = cssStyles + content + } + } + + return content } function runMain() { const docsDir = path.join(__dirname, '..', 'docs') const files = globSync(`${docsDir}/**/*.md`, { nodir: true }) + let processedFiles = 0 + files.forEach((file) => { const content = fs.readFileSync(file, 'utf8') let transformed = convertLinks(content) transformed = fixFormatting(transformed) if (content !== transformed) { fs.writeFileSync(file, transformed, 'utf8') + processedFiles++ } }) - console.log(`Processed ${files.length} markdown files, converted markdown links to HTML tags.`) + + // Create modern CSS file + const cssContent = `/* Modern documentation styling */ +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +body { + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif; + line-height: 1.6; + color: #333; + max-width: 1200px; + margin: 0 auto; + padding: 20px; + background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%); + min-height: 100vh; +} + +h1, h2, h3, h4, h5, h6 { + color: #2c3e50; + font-weight: 600; + margin-top: 2em; + margin-bottom: 0.5em; +} + +h1 { + border-bottom: 2px solid #632ca6; + padding-bottom: 0.5em; + color: #632ca6; +} + +h2 { + border-bottom: 1px solid #e1e4e8; + padding-bottom: 0.3em; +} + +table { + width: 100%; + border-collapse: collapse; + margin: 1em 0; + background-color: white; + border-radius: 6px; + overflow: hidden; + box-shadow: 0 1px 3px rgba(0,0,0,0.1); } -if (require.main === module) { - runMain() +thead { + background-color: #632ca6; + color: white; } + +th, td { + padding: 12px; + text-align: left; + border-bottom: 1px solid #e1e4e8; +} + +th { + font-weight: 600; + font-size: 0.9em; + text-transform: uppercase; + letter-spacing: 0.5px; +} + +tbody tr:hover { + background-color: #f8f9fa; +} + +code { + background-color: #f1f3f4; + padding: 2px 6px; + border-radius: 3px; + font-family: 'SF Mono', 'Monaco', 'Inconsolata', 'Roboto Mono', monospace; + font-size: 0.9em; + color: #d73a49; +} + +pre { + background-color: #f6f8fa; + border: 1px solid #e1e4e8; + border-radius: 6px; + padding: 16px; + overflow-x: auto; + margin: 1em 0; +} + +a { + color: #632ca6; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +table a { + font-weight: 500; + padding: 4px 8px; + background-color: #f1f3f4; + border-radius: 4px; + transition: background-color 0.2s; +} + +table a:hover { + background-color: #e1e4e8; + text-decoration: none; +} + +@media (max-width: 768px) { + body { + padding: 10px; + } + + table { + font-size: 0.9em; + } + + th, td { + padding: 8px; + } +} +` + + const cssPath = path.join(docsDir, 'style.css') + fs.writeFileSync(cssPath, cssContent) + + console.log( + `Processed ${processedFiles} markdown files, converted markdown links to HTML tags and added modern styling.` + ) + console.log('Created modern CSS styling file: docs/style.css') +} + +runMain() From c9287bd2f6344767a807f73c98bf5c92757b1ccb Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 15:07:53 +0200 Subject: [PATCH 15/21] change --- docs/browser-logs.datadoglogs.md | 111 +------ docs/browser-logs.handlertype.md | 111 +------ docs/browser-logs.logger._constructor_.md | 113 +------ docs/browser-logs.logger.alert.md | 111 +------ docs/browser-logs.logger.clearcontext.md | 111 +------ docs/browser-logs.logger.critical.md | 111 +------ docs/browser-logs.logger.debug.md | 111 +------ docs/browser-logs.logger.emerg.md | 111 +------ docs/browser-logs.logger.error.md | 111 +------ docs/browser-logs.logger.getcontext.md | 111 +------ docs/browser-logs.logger.gethandler.md | 113 +------ docs/browser-logs.logger.getlevel.md | 111 +------ docs/browser-logs.logger.info.md | 111 +------ docs/browser-logs.logger.log.md | 111 +------ docs/browser-logs.logger.logimplementation.md | 111 +------ docs/browser-logs.logger.md | 111 +------ docs/browser-logs.logger.notice.md | 111 +------ docs/browser-logs.logger.ok.md | 111 +------ ...owser-logs.logger.removecontextproperty.md | 111 +------ docs/browser-logs.logger.setcontext.md | 111 +------ .../browser-logs.logger.setcontextproperty.md | 111 +------ docs/browser-logs.logger.sethandler.md | 113 +------ docs/browser-logs.logger.setlevel.md | 111 +------ docs/browser-logs.logger.warn.md | 111 +------ ...rowser-logs.loggerconfiguration.context.md | 111 +------ ...rowser-logs.loggerconfiguration.handler.md | 111 +------ .../browser-logs.loggerconfiguration.level.md | 111 +------ docs/browser-logs.loggerconfiguration.md | 113 +------ docs/browser-logs.logsevent.application_id.md | 111 +------ docs/browser-logs.logsevent.date.md | 111 +------ docs/browser-logs.logsevent.error.md | 111 +------ docs/browser-logs.logsevent.http.md | 111 +------ docs/browser-logs.logsevent.logger.md | 111 +------ docs/browser-logs.logsevent.md | 125 +------- docs/browser-logs.logsevent.message.md | 111 +------ docs/browser-logs.logsevent.origin.md | 111 +------ docs/browser-logs.logsevent.service.md | 111 +------ docs/browser-logs.logsevent.session.md | 111 +------ docs/browser-logs.logsevent.session_id.md | 111 +------ docs/browser-logs.logsevent.status.md | 111 +------ docs/browser-logs.logsevent.view.md | 111 +------ docs/browser-logs.logseventdomaincontext.md | 111 +------ docs/browser-logs.logsglobal.clearaccount.md | 111 +------ ...wser-logs.logsglobal.clearglobalcontext.md | 113 +------ docs/browser-logs.logsglobal.clearuser.md | 113 +------ docs/browser-logs.logsglobal.createlogger.md | 113 +------ docs/browser-logs.logsglobal.getaccount.md | 111 +------ ...rowser-logs.logsglobal.getglobalcontext.md | 113 +------ ...er-logs.logsglobal.getinitconfiguration.md | 111 +------ ...wser-logs.logsglobal.getinternalcontext.md | 115 +------ docs/browser-logs.logsglobal.getlogger.md | 113 +------ docs/browser-logs.logsglobal.getuser.md | 113 +------ docs/browser-logs.logsglobal.init.md | 111 +------ docs/browser-logs.logsglobal.logger.md | 111 +------ docs/browser-logs.logsglobal.md | 139 +-------- ...r-logs.logsglobal.removeaccountproperty.md | 111 +------ ....logsglobal.removeglobalcontextproperty.md | 113 +------ ...wser-logs.logsglobal.removeuserproperty.md | 113 +------ docs/browser-logs.logsglobal.setaccount.md | 111 +------ ...wser-logs.logsglobal.setaccountproperty.md | 111 +------ ...rowser-logs.logsglobal.setglobalcontext.md | 111 +------ ...ogs.logsglobal.setglobalcontextproperty.md | 111 +------ ...wser-logs.logsglobal.settrackingconsent.md | 111 +------ docs/browser-logs.logsglobal.setuser.md | 113 +------ docs/browser-logs.logsglobal.setuser_1.md | 111 +------ ...browser-logs.logsglobal.setuserproperty.md | 111 +------ ...r-logs.logsinitconfiguration.beforesend.md | 111 +------ ...ogsinitconfiguration.forwardconsolelogs.md | 111 +------ ...gsinitconfiguration.forwarderrorstologs.md | 111 +------ ...gs.logsinitconfiguration.forwardreports.md | 113 +------ docs/browser-logs.logsinitconfiguration.md | 123 +------- ...logs.logsinitconfiguration.usepciintake.md | 113 +------ docs/browser-logs.logsmessage.context.md | 111 +------ docs/browser-logs.logsmessage.md | 111 +------ docs/browser-logs.logsmessage.message.md | 111 +------ docs/browser-logs.logsmessage.status.md | 111 +------ docs/browser-logs.md | 111 +------ docs/browser-logs.statustype.md | 111 +------ docs/browser-rum-react.addreacterror.md | 111 +------ ...r-rum-react.errorboundary._constructor_.md | 111 +------ ...m-react.errorboundary.componentdidcatch.md | 111 +------ ....errorboundary.getderivedstatefromerror.md | 111 +------ docs/browser-rum-react.errorboundary.md | 111 +------ .../browser-rum-react.errorboundary.render.md | 111 +------ ...wser-rum-react.errorboundary.reseterror.md | 111 +------ docs/browser-rum-react.md | 111 +------ docs/browser-rum-react.reactplugin.md | 111 +------ ...um-react.unstable_reactcomponenttracker.md | 111 +------ docs/browser-rum-slim.datadogrum.md | 111 +------ docs/browser-rum-slim.md | 111 +------ docs/browser-rum.commonproperties._dd.md | 111 +------ docs/browser-rum.commonproperties.account.md | 111 +------ ...rowser-rum.commonproperties.application.md | 111 +------ docs/browser-rum.commonproperties.build_id.md | 111 +------ ...wser-rum.commonproperties.build_version.md | 111 +------ docs/browser-rum.commonproperties.ci_test.md | 111 +------ ...owser-rum.commonproperties.connectivity.md | 111 +------ docs/browser-rum.commonproperties.context.md | 111 +------ docs/browser-rum.commonproperties.date.md | 111 +------ docs/browser-rum.commonproperties.device.md | 111 +------ docs/browser-rum.commonproperties.display.md | 111 +------ docs/browser-rum.commonproperties.md | 139 +-------- docs/browser-rum.commonproperties.os.md | 111 +------ docs/browser-rum.commonproperties.service.md | 111 +------ docs/browser-rum.commonproperties.session.md | 111 +------ docs/browser-rum.commonproperties.source.md | 111 +------ ...browser-rum.commonproperties.synthetics.md | 111 +------ docs/browser-rum.commonproperties.usr.md | 111 +------ docs/browser-rum.commonproperties.version.md | 111 +------ docs/browser-rum.commonproperties.view.md | 111 +------ docs/browser-rum.datadogrum.md | 111 +------ docs/browser-rum.md | 111 +------ docs/browser-rum.rumactionevent.md | 111 +------ ...-rum.rumactioneventdomaincontext.events.md | 111 +------ ...mactioneventdomaincontext.handlingstack.md | 111 +------ ...browser-rum.rumactioneventdomaincontext.md | 113 +------ docs/browser-rum.rumerrorevent.md | 111 +------ ...er-rum.rumerroreventdomaincontext.error.md | 111 +------ ...umerroreventdomaincontext.handlingstack.md | 111 +------ .../browser-rum.rumerroreventdomaincontext.md | 111 +------ docs/browser-rum.rumevent.md | 111 +------ docs/browser-rum.rumeventdomaincontext.md | 111 +------ ...umfetchresourceeventdomaincontext.error.md | 111 +------ ...esourceeventdomaincontext.handlingstack.md | 111 +------ ...tchresourceeventdomaincontext.isaborted.md | 111 +------ ...-rum.rumfetchresourceeventdomaincontext.md | 111 +------ ...urceeventdomaincontext.performanceentry.md | 111 +------ ...hresourceeventdomaincontext.requestinit.md | 111 +------ ...resourceeventdomaincontext.requestinput.md | 111 +------ ...etchresourceeventdomaincontext.response.md | 111 +------ docs/browser-rum.rumglobal.addaction.md | 111 +------ .../browser-rum.rumglobal.adddurationvital.md | 111 +------ docs/browser-rum.rumglobal.adderror.md | 111 +------ ...-rum.rumglobal.addfeatureflagevaluation.md | 111 +------ docs/browser-rum.rumglobal.addtiming.md | 111 +------ docs/browser-rum.rumglobal.clearaccount.md | 111 +------ ...rowser-rum.rumglobal.clearglobalcontext.md | 113 +------ docs/browser-rum.rumglobal.clearuser.md | 113 +------ docs/browser-rum.rumglobal.getaccount.md | 111 +------ .../browser-rum.rumglobal.getglobalcontext.md | 113 +------ ...wser-rum.rumglobal.getinitconfiguration.md | 111 +------ ...rowser-rum.rumglobal.getinternalcontext.md | 113 +------ ...wser-rum.rumglobal.getsessionreplaylink.md | 113 +------ docs/browser-rum.rumglobal.getuser.md | 113 +------ docs/browser-rum.rumglobal.getviewcontext.md | 111 +------ docs/browser-rum.rumglobal.init.md | 111 +------ docs/browser-rum.rumglobal.md | 141 +-------- ...ser-rum.rumglobal.removeaccountproperty.md | 111 +------ ...m.rumglobal.removeglobalcontextproperty.md | 113 +------ ...rowser-rum.rumglobal.removeuserproperty.md | 113 +------ docs/browser-rum.rumglobal.setaccount.md | 111 +------ ...rowser-rum.rumglobal.setaccountproperty.md | 111 +------ .../browser-rum.rumglobal.setglobalcontext.md | 111 +------ ...-rum.rumglobal.setglobalcontextproperty.md | 111 +------ ...rowser-rum.rumglobal.settrackingconsent.md | 111 +------ docs/browser-rum.rumglobal.setuser.md | 113 +------ docs/browser-rum.rumglobal.setuser_1.md | 111 +------ docs/browser-rum.rumglobal.setuserproperty.md | 111 +------ docs/browser-rum.rumglobal.setviewcontext.md | 111 +------ ...er-rum.rumglobal.setviewcontextproperty.md | 111 +------ docs/browser-rum.rumglobal.setviewname.md | 111 +------ ...rowser-rum.rumglobal.startdurationvital.md | 111 +------ ...m.rumglobal.startsessionreplayrecording.md | 113 +------ docs/browser-rum.rumglobal.startview.md | 111 +------ ...browser-rum.rumglobal.stopdurationvital.md | 111 +------ docs/browser-rum.rumglobal.stopsession.md | 111 +------ ...um.rumglobal.stopsessionreplayrecording.md | 113 +------ ...uminitconfiguration.actionnameattribute.md | 111 +------ ...ruminitconfiguration.allowedtracingurls.md | 111 +------ ...-rum.ruminitconfiguration.applicationid.md | 111 +------ ...ser-rum.ruminitconfiguration.beforesend.md | 111 +------ ...nitconfiguration.compressintakerequests.md | 111 +------ ...uminitconfiguration.defaultprivacylevel.md | 111 +------ ...onfiguration.enableprivacyforactionname.md | 111 +------ ...minitconfiguration.excludedactivityurls.md | 111 +------ docs/browser-rum.ruminitconfiguration.md | 153 ++-------- ...rowser-rum.ruminitconfiguration.plugins.md | 111 +------ ...uminitconfiguration.profilingsamplerate.md | 111 +------ ...initconfiguration.propagatetracebaggage.md | 111 +------ ...initconfiguration.remoteconfigurationid.md | 111 +------ ...itconfiguration.sessionreplaysamplerate.md | 113 +------ ...ion.startsessionreplayrecordingmanually.md | 111 +------ ...wser-rum.ruminitconfiguration.subdomain.md | 111 +------ ...initconfiguration.tracecontextinjection.md | 111 +------ ...um.ruminitconfiguration.tracesamplerate.md | 111 +------ ...onfiguration.trackfeatureflagsforevents.md | 111 +------ ...rum.ruminitconfiguration.tracklongtasks.md | 111 +------ ...rum.ruminitconfiguration.trackresources.md | 111 +------ ...initconfiguration.trackuserinteractions.md | 111 +------ ...ruminitconfiguration.trackviewsmanually.md | 111 +------ ...wser-rum.ruminitconfiguration.workerurl.md | 111 +------ docs/browser-rum.rumlongtaskevent.md | 111 +------ ...owser-rum.rumlongtaskeventdomaincontext.md | 111 +------ ...taskeventdomaincontext.performanceentry.md | 111 +------ ...-rum.rumotherresourceeventdomaincontext.md | 111 +------ ...urceeventdomaincontext.performanceentry.md | 111 +------ docs/browser-rum.rumresourceevent.md | 111 +------ docs/browser-rum.rumviewevent.md | 111 +------ ...-rum.rumvieweventdomaincontext.location.md | 111 +------ docs/browser-rum.rumvieweventdomaincontext.md | 111 +------ docs/browser-rum.rumvitalevent.md | 111 +------ ...esourceeventdomaincontext.handlingstack.md | 111 +------ ...xhrresourceeventdomaincontext.isaborted.md | 111 +------ ...er-rum.rumxhrresourceeventdomaincontext.md | 111 +------ ...urceeventdomaincontext.performanceentry.md | 111 +------ ...um.rumxhrresourceeventdomaincontext.xhr.md | 111 +------ docs/index.md | 111 +------ docs/style.css | 121 -------- scripts/fix-doc-links.js | 289 +----------------- 209 files changed, 319 insertions(+), 23282 deletions(-) delete mode 100644 docs/style.css diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index 36a76bb761..e8080c46a6 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > datadogLogs diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index e89f39b462..4c647614b6 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > HandlerType diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index b560414647..e3619d1fab 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > (constructor) @@ -176,7 +67,7 @@ handlerType -HandlerType | HandlerType[] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 109b27f2a7..48011cc323 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > alert diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 5cba14afc0..a61699e2ae 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > clearContext diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 7049c80e15..0b16b394ca 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > critical diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 5daf12f4f3..52ef50524e 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > debug diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index 9d9c9f04a1..ee6a6c3abe 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > emerg diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 1999c617c6..b16b6e1f49 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > error diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 41059d29bd..847897dc6a 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > getContext diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 66494da7dc..7e09bd4314 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > getHandler @@ -120,5 +11,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType | HandlerType[] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index f9bca49cde..116d582953 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > getLevel diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index 1d29ba119c..c68fc09ce5 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > info diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 8afbb1d797..9534e2dbaa 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > log diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 57f537d265..d4d15f44f7 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > logImplementation diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index d36336e65f..537cfee72a 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index 8c68164e74..f9836a7c30 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > notice diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 0310487c98..eb4ab969a7 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > ok diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index 82dd5b3451..a1e0ebd782 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > removeContextProperty diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index a395bd27de..10c3e47398 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > setContext diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 0561bce728..37ce71e0b9 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > setContextProperty diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index 10570eec94..a92a47f79c 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > setHandler @@ -144,7 +35,7 @@ handler -HandlerType | HandlerType[] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 3754aa3ca7..0367f97bf3 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > setLevel diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index c55dedb046..2dd15971ba 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > Logger > warn diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index aa70d1b491..da351e1643 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LoggerConfiguration > context diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 62f53f5732..906fea4454 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LoggerConfiguration > handler diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index aee84243cf..0f64773a54 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LoggerConfiguration > level diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 1840d8dc79..e2b8267b7e 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LoggerConfiguration @@ -171,7 +62,7 @@ object -HandlerType | HandlerType[] +HandlerType \| HandlerType\[\] diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 3a01ce1bd9..55763153a4 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > application\_id diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index fff8b3a5ad..ec9e4e24fb 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > date diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 040f8c501a..462b2e1f6c 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > error diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index b0af055caf..3206ecd365 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > http diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index c0da1378c2..87d2079448 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > logger diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 946bca9272..dff3e73297 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent @@ -190,7 +81,7 @@ Start of the log in ms from epoch -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; [k: string]: unknown; } +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } @@ -209,7 +100,7 @@ Start of the log in ms from epoch -{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status\_code: number; url: string; [k: string]: unknown; } +{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } @@ -228,7 +119,7 @@ Start of the log in ms from epoch -{ name: string; [k: string]: unknown; } +{ name: string; \[k: string\]: unknown; } @@ -266,7 +157,7 @@ The log message -'network' | 'source' | 'console' | 'logger' | 'agent' | 'report' +'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' @@ -323,7 +214,7 @@ string -{ id?: string; [k: string]: unknown; } +{ id?: string; \[k: string\]: unknown; } @@ -342,7 +233,7 @@ string -'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg' +'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' @@ -361,7 +252,7 @@ The log status -{ referrer?: string; url: string; id?: string; [k: string]: unknown; } +{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index ad073e8762..0e688c568e 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > message diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 31999be448..1b4dbf42f8 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > origin diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index 8a65768d3a..251a28d0bd 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > service diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 49f4df476c..179cbc5713 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > session diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 5758baae73..76891367dc 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > session\_id diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 459e157819..898f1fe479 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > status diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index b4b9c7f1e1..3ac0abb479 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEvent > view diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index d2bb80df34..867014bb3b 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsEventDomainContext diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index f0eb699322..9df5f06c88 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > clearAccount diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index ed7748e1b0..5c5e536b07 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext @@ -115,7 +6,7 @@ table a:hover { Clear the global context -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index bf791e2980..8adcc276b4 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > clearUser @@ -115,7 +6,7 @@ table a:hover { Clear all user information -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 8ec1c8bf76..2503071fe4 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > createLogger @@ -115,7 +6,7 @@ table a:hover { The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 0515d4a058..43d16fefcf 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getAccount diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index d05e88137f..d10bbe30d9 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getGlobalContext @@ -115,7 +6,7 @@ table a:hover { Get the global Context -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index efa58ca90e..a1a53cc138 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index 7bbcb4ec3b..c22bd2af3e 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,121 +1,12 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context -See Access internal context for further information. +See \Access internal context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 1a1a2bd2fe..1cb3fb0ae6 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getLogger @@ -115,7 +6,7 @@ table a:hover { Get a logger -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 258bf4926c..0cb46a9696 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > getUser @@ -115,7 +6,7 @@ table a:hover { Get user information -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index d6765e2966..65bcd0c20f 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > init diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index eb11dbdab5..c5a9be9bfe 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > logger diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index f04553dd00..082fc0b13a 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal @@ -179,7 +70,7 @@ Clear all account information Clear the global context -See Overwrite context for further information. +See \Overwrite context\ for further information. @@ -200,7 +91,7 @@ See User context for further information. +See \User context\ for further information. @@ -221,7 +112,7 @@ See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. @@ -261,7 +152,7 @@ Get account information Get the global Context -See Overwrite context for further information. +See \Overwrite context\ for further information. @@ -275,7 +166,7 @@ See LogsInitConfiguration | undefined +() => LogsInitConfiguration \| undefined @@ -294,14 +185,14 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext \| undefined -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context -See Access internal context for further information. +See \Access internal context\ for further information. @@ -315,14 +206,14 @@ See Logger | undefined +(name: string) => Logger \| undefined Get a logger -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. @@ -343,7 +234,7 @@ See User context for further information. +See \User context\ for further information. @@ -419,7 +310,7 @@ Remove an account property Remove a global context property -See Overwrite context for further information. +See \Overwrite context\ for further information. @@ -440,7 +331,7 @@ See User context for further information. +See \User context\ for further information. @@ -582,7 +473,7 @@ Description Set user information to all events, stored in `@usr` -See User context for further information. +See \User context\ for further information. diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 3782fb41b1..2321d5b50e 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index 3fe37187c5..d64200108f 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty @@ -115,7 +6,7 @@ table a:hover { Remove a global context property -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 4539749439..47942669d5 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > removeUserProperty @@ -115,7 +6,7 @@ table a:hover { Remove a user property -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index a6d289ebe0..d4273bc766 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setAccount diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 985480e5cf..0ff6da5fd5 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setAccountProperty diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index 946e9decf8..f07063e025 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setGlobalContext diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 4660d79f7b..9e475d236d 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 4556892778..b59ca39ee6 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index a547b75d1a..76ad33f57a 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setUser @@ -115,7 +6,7 @@ table a:hover { Set user information to all events, stored in `@usr` -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 98560b844a..9570bc14e2 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setUser diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index e68e077534..1aa3195263 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsGlobal > setUserProperty diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index 96de854c73..d0b1eb8d6b 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index c192f82fb9..cdd472a5e8 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index ee2a9eaea1..f1920aa7f3 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index 55fb4932fd..fd149e19fb 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,119 +1,10 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property -Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index bc9d2cda5e..a241bdb8bf 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration @@ -153,7 +44,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined @@ -172,7 +63,7 @@ Description -ConsoleApiName[] | 'all' | undefined +ConsoleApiName\[\] \| 'all' \| undefined @@ -191,7 +82,7 @@ ConsoleApiName[] | 'all' | undefined -boolean | undefined +boolean \| undefined @@ -210,12 +101,12 @@ boolean | undefined -RawReportType[] | 'all' | undefined +RawReportType\[\] \| 'all' \| undefined -(Optional) Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +(Optional) Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. @@ -234,7 +125,7 @@ boolean -(Optional) Use PCI-compliant intake. See PCI DSS Compliance for further information. false +(Optional) Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 75575af44e..24859ac38e 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,119 +1,10 @@ - - - - - + Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property -Use PCI-compliant intake. See PCI DSS Compliance for further information. false +Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false **Signature:** diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index b962af643f..537ccc7a78 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsMessage > context diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 8a8a28df05..107876469a 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsMessage diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index c6abc4f88b..ba97f70fb7 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsMessage > message diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 0cb27433bf..3217ac3816 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > LogsMessage > status diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 7c3d60be63..cbafd19deb 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 8a4c47733d..4d9dade523 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-logs > StatusType diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index ac1b94befa..e00eafc47e 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > addReactError diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 1f8b6f5a3a..8ccd318cde 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 0ec18ab35e..b14b0fb664 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 4836266c66..5b987d5bdc 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 43f3158e5f..0a6b26b377 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index e5c97e901b..7c6ac00636 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary > render diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 1923a645cf..48532c6c9f 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > ErrorBoundary > resetError diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 7fada25351..8228bf87f4 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 3306a1ce23..94c4d7e535 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > reactPlugin diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 08edcaff59..595b895ff8 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 29f4f3c709..917da31e02 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-slim > datadogRum diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index c4e73031a9..ca909b306e 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum-slim diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 38a9f25e3b..ad1cb08af6 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > \_dd diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 1f857a545d..45368c8e6e 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > account diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index 9f1628f504..cd13d05e30 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > application diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 85b91f2b1a..b86a419740 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > build\_id diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index b73aa451e5..9633cbb6ea 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > build\_version diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 9200293fc6..49573e6d83 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > ci\_test diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index e3b891cf7e..487f61ebe0 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > connectivity diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index 60ee86c122..e565438b7b 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > context diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index 84c512356e..bdb152047d 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > date diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index 72e14a83b5..c1a3c6a1e0 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > device diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index fc02ba7835..861e290d0e 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > display diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 7b1bcb5173..2cfeef35c1 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties @@ -156,7 +47,7 @@ Description -{ readonly format\_version: 2; session?: { plan?: 1 | 2; readonly session\_precondition?: 'user\_app\_launch' | 'inactivity\_timeout' | 'max\_duration' | 'background\_launch' | 'prewarm' | 'from\_non\_interactive\_session' | 'explicit\_stop'; [k: string]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; [k: string]: unknown; }; readonly browser\_sdk\_version?: string; [k: string]: unknown; } +{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } @@ -177,7 +68,7 @@ Internal properties -{ readonly id: string; readonly name?: string; [k: string]: unknown; } +{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } @@ -198,7 +89,7 @@ Internal properties -{ readonly id: string; [k: string]: unknown; } +{ readonly id: string; \[k: string\]: unknown; } @@ -261,7 +152,7 @@ string -{ readonly test\_execution\_id: string; [k: string]: unknown; } +{ readonly test\_execution\_id: string; \[k: string\]: unknown; } @@ -280,7 +171,7 @@ string -{ readonly status: 'connected' | 'not\_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; readonly effective\_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; [k: string]: unknown; }; [k: string]: unknown; } +{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } @@ -299,7 +190,7 @@ string -{ [k: string]: unknown; } +{ \[k: string\]: unknown; } @@ -339,7 +230,7 @@ Start of the event in ms from epoch -{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming\_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; [k: string]: unknown; } +{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } @@ -358,7 +249,7 @@ Start of the event in ms from epoch -{ readonly viewport?: { readonly width: number; readonly height: number; [k: string]: unknown; }; [k: string]: unknown; } +{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } @@ -377,7 +268,7 @@ Start of the event in ms from epoch -{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; [k: string]: unknown; } +{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } @@ -417,7 +308,7 @@ string -{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci\_test'; readonly has\_replay?: boolean; [k: string]: unknown; } +{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } @@ -438,7 +329,7 @@ Session properties -'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform' +'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' @@ -459,7 +350,7 @@ Session properties -{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; [k: string]: unknown; } +{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } @@ -480,7 +371,7 @@ Session properties -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; [k: string]: unknown; } +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } @@ -520,7 +411,7 @@ string -{ readonly id: string; referrer?: string; url: string; name?: string; [k: string]: unknown; } +{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 0ff7e26911..536aa92efd 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > os diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index edd3d6edb3..75bd81afa2 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > service diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index 677456e00b..d546e76ce3 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > session diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index cbea58e330..c3de043c5d 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > source diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index f4c65072ca..2fafb2b1a1 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > synthetics diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 673752c9f3..7b6b5f4cd4 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > usr diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 376ba27e2a..9854d3ef1c 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > version diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index 1fd15768e6..b2a07261e5 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > CommonProperties > view diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 58f5eb0f40..2b39faf4bc 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > datadogRum diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 811c379a87..743101b513 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 546721db08..5df82dc308 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumActionEvent diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index e742a9c394..6698f63bae 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumActionEventDomainContext > events diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 6f2c64ac9b..3a381da3c1 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 6c063df35c..91937c5cdf 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumActionEventDomainContext @@ -152,7 +43,7 @@ Description -Event[] +Event\[\] diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index 96b369360d..d539728f58 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumErrorEvent diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 53299be681..833d7b2a30 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumErrorEventDomainContext > error diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 91bb7886af..fe21529635 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 27c173f579..aa70a3ef61 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumErrorEventDomainContext diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index f83bdbd939..2e3d079ae0 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumEvent diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index a97e4ceaf8..7e9b0b07ea 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 4e48fc8384..384bf37e94 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index cd391a6a31..e8c761d8d7 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 6ba40e8a4d..1245b6a516 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 8983ed4ad2..c93b2f9144 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 78adbad0a2..dd65de0e81 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index f6384af879..49ccfc94fe 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 4bf0ce16f9..66999ec3d0 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index d1f940f7df..50db70b5a5 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index a2d0bff7d5..1d2b039ff5 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > addAction diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index c527375eb3..fc23fa7b0f 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > addDurationVital diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index dd094832d7..d560b0591b 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > addError diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 78fe5c7973..706ce9c41f 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 28c96e56e2..3fcd32fd26 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > addTiming diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index df5259e1d6..07b37b26d5 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > clearAccount diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index cb25e398b4..c4c687ba47 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > clearGlobalContext @@ -115,7 +6,7 @@ table a:hover { Clear the global context -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index b1a4e8bcb1..7e42ce3c9a 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > clearUser @@ -115,7 +6,7 @@ table a:hover { Clear all user information -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index f940305b50..dba65370b3 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getAccount diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index f1525479f2..6ca297788e 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getGlobalContext @@ -115,7 +6,7 @@ table a:hover { Get the global Context -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 6a89ed913c..207a9ba9b4 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getInitConfiguration diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 7010d7010f..9377e29955 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,119 +1,10 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context **Signature:** diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index ffe8398be5..523e21415a 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink @@ -115,7 +6,7 @@ table a:hover { Get the Session Replay Link. -See Connect Session Replay To Your Third-Party Tools for further information. +See \Connect Session Replay To Your Third-Party Tools\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index cd1c1b9ead..f443dcd8d0 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getUser @@ -115,7 +6,7 @@ table a:hover { Get user information -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 92d59f7e52..7fc407f915 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > getViewContext diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 6c33e3ab24..1142877612 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > init diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index bf6a3bf3ea..a9c624b401 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal @@ -274,7 +165,7 @@ Clear all account information Clear the global context -See Global context for further information. +See \Global context\ for further information. @@ -295,7 +186,7 @@ See User session for further information. +See \User session\ for further information. @@ -335,7 +226,7 @@ Get account information Get the global Context -See Global context for further information. +See \Global context\ for further information. @@ -349,7 +240,7 @@ See RumInitConfiguration | undefined +() => RumInitConfiguration \| undefined @@ -368,12 +259,12 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext \| undefined -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context @@ -387,14 +278,14 @@ Get the init configuration -() => string | undefined +() => string \| undefined Get the Session Replay Link. -See Connect Session Replay To Your Third-Party Tools for further information. +See \Connect Session Replay To Your Third-Party Tools\ for further information. @@ -415,7 +306,7 @@ See User session for further information. +See \User session\ for further information. @@ -493,7 +384,7 @@ Remove an account property Remove a global context property -See Global context for further information. +See \Global context\ for further information. @@ -514,7 +405,7 @@ See User session for further information. +See \User session\ for further information. @@ -733,7 +624,7 @@ If you plan to have multiple durations for the same vital, you should use the re Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. @@ -766,7 +657,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void +(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void @@ -811,7 +702,7 @@ Stop the session. A new session will start at the next user interaction with the Stop Session Replay recording. -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. @@ -839,7 +730,7 @@ Description Set user information to all events, stored in `@usr` -See User session for further information. +See \User session\ for further information. diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index 414d2b9db4..e8f1c73c0b 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > removeAccountProperty diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index 18e981ee25..b57a72c511 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty @@ -115,7 +6,7 @@ table a:hover { Remove a global context property -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 1769fa405d..190cc5cf6d 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > removeUserProperty @@ -115,7 +6,7 @@ table a:hover { Remove a user property -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 1abc92887b..a559156d79 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setAccount diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 0d7733fd43..6d41e04cb2 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setAccountProperty diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index e381d526ec..08d98484b9 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setGlobalContext diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 155fa594d4..542c3c639b 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index f2cbdb1e09..41efadfec9 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setTrackingConsent diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index 6077b45c9f..a086a3e0f5 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setUser @@ -115,7 +6,7 @@ table a:hover { Set user information to all events, stored in `@usr` -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 1d18a47d47..972a0ae9f2 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setUser diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 3d2dacf911..1165900244 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setUserProperty diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index b76d89dfa2..95f2670ab2 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setViewContext diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index c8348006c4..19adf5c441 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setViewContextProperty diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index f8899e7a55..5077efb0d9 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > setViewName diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 68e1088c0a..58a2ff805c 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > startDurationVital diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 803adca16b..8cb1159886 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording @@ -115,7 +6,7 @@ table a:hover { Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index a76976d122..efddb37e3a 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > startView diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 0ab7d4d9aa..40272a366e 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > stopDurationVital diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index a96b7f6a42..776655c5cf 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > stopSession diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index ac56d1484a..fac27e9aa0 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording @@ -115,7 +6,7 @@ table a:hover { Stop Session Replay recording. -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index df44cd11c7..1e48a2c7ef 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 67b4a71d63..7804d4d183 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index eabdcd55b8..b93cb36c87 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > applicationId diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index d4313810c4..40e6814128 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > beforeSend diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 69b7006006..3413d6cb14 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index b6df1bbaf1..d82ab6acac 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 78778ebd6b..71a0cbe060 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index b5fe1be865..af9c9bf573 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 9e186d2909..f4ec74019b 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration @@ -153,7 +44,7 @@ Description -string | undefined +string \| undefined @@ -172,7 +63,7 @@ string | undefined -Array<MatchOption | TracingOption> | undefined +Array<MatchOption \| TracingOption> \| undefined @@ -210,7 +101,7 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined @@ -231,7 +122,7 @@ See Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +(Optional) The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. @@ -402,7 +293,7 @@ number | undefined -boolean | undefined +boolean \| undefined @@ -440,7 +331,7 @@ string -TraceContextInjection | undefined +TraceContextInjection \| undefined @@ -459,7 +350,7 @@ TraceContextInjection | undefined -number | undefined +number \| undefined @@ -478,7 +369,7 @@ number | undefined -FeatureFlagsForEvents[] +FeatureFlagsForEvents\[\] @@ -497,7 +388,7 @@ FeatureFlagsForEvents[] -boolean | undefined +boolean \| undefined @@ -516,7 +407,7 @@ boolean | undefined -boolean | undefined +boolean \| undefined @@ -535,7 +426,7 @@ boolean | undefined -boolean | undefined +boolean \| undefined @@ -554,7 +445,7 @@ boolean | undefined -boolean | undefined +boolean \| undefined diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 9a7a462a30..1e521d1a29 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > plugins diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index df85a70e64..c08a3537d5 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 07eb856fc1..42f57c809a 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 3eafb31915..925f00267a 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 825cab12b1..0057df27ea 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,119 +1,10 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property -The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index b01ab6e041..427130229c 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 160bc2371b..ed3d388410 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > subdomain diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index f2dcb0ca3f..b5593bdb99 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index d32c7cd413..f509245641 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index f94c158eb8..11f8345f45 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index c38abc919b..8b2b7a0f5f 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 8312ac284f..9c05a1120b 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > trackResources diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index c9055f36a1..198c9f2565 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index 40b714f2b9..d028a6d8ac 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index 06c01e2132..fdb93f3581 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumInitConfiguration > workerUrl diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 69059151aa..4bec40e6c7 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumLongTaskEvent diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 203c8117e1..47e7b1500f 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumLongTaskEventDomainContext diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 786002fc42..71f23621a5 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 4dde66fe14..316fd6bedf 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index b383c9bc13..6bc0840e08 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index f17ecd5396..20eb3f5607 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumResourceEvent diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 0e11fe7a85..14076df1df 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumViewEvent diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 5c3fea4fdb..084978dfb8 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumViewEventDomainContext > location diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 229e466f62..f2d51a2686 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumViewEventDomainContext diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 292eaa1af4..95c1c41d20 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumVitalEvent diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index cbc6737f97..c3c3e7c215 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 3b33551436..1da2a404dc 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index c10cc01681..23ec8cab4f 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 752d4668f0..23288a5767 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 0183d92ecd..7a02ed5a6c 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,113 +1,4 @@ - - - - - + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr diff --git a/docs/index.md b/docs/index.md index 419a425d7c..752a2b7655 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,113 +1,4 @@ - - - - - + Home diff --git a/docs/style.css b/docs/style.css deleted file mode 100644 index 5ed78aa04e..0000000000 --- a/docs/style.css +++ /dev/null @@ -1,121 +0,0 @@ -/* Modern documentation styling */ -* { - margin: 0; - padding: 0; - box-sizing: border-box; -} - -body { - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif; - line-height: 1.6; - color: #333; - max-width: 1200px; - margin: 0 auto; - padding: 20px; - background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%); - min-height: 100vh; -} - -h1, h2, h3, h4, h5, h6 { - color: #2c3e50; - font-weight: 600; - margin-top: 2em; - margin-bottom: 0.5em; -} - -h1 { - border-bottom: 2px solid #632ca6; - padding-bottom: 0.5em; - color: #632ca6; -} - -h2 { - border-bottom: 1px solid #e1e4e8; - padding-bottom: 0.3em; -} - -table { - width: 100%; - border-collapse: collapse; - margin: 1em 0; - background-color: white; - border-radius: 6px; - overflow: hidden; - box-shadow: 0 1px 3px rgba(0,0,0,0.1); -} - -thead { - background-color: #632ca6; - color: white; -} - -th, td { - padding: 12px; - text-align: left; - border-bottom: 1px solid #e1e4e8; -} - -th { - font-weight: 600; - font-size: 0.9em; - text-transform: uppercase; - letter-spacing: 0.5px; -} - -tbody tr:hover { - background-color: #f8f9fa; -} - -code { - background-color: #f1f3f4; - padding: 2px 6px; - border-radius: 3px; - font-family: 'SF Mono', 'Monaco', 'Inconsolata', 'Roboto Mono', monospace; - font-size: 0.9em; - color: #d73a49; -} - -pre { - background-color: #f6f8fa; - border: 1px solid #e1e4e8; - border-radius: 6px; - padding: 16px; - overflow-x: auto; - margin: 1em 0; -} - -a { - color: #632ca6; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -table a { - font-weight: 500; - padding: 4px 8px; - background-color: #f1f3f4; - border-radius: 4px; - transition: background-color 0.2s; -} - -table a:hover { - background-color: #e1e4e8; - text-decoration: none; -} - -@media (max-width: 768px) { - body { - padding: 10px; - } - - table { - font-size: 0.9em; - } - - th, td { - padding: 8px; - } -} diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js index f31e073684..aba8a3e7d5 100644 --- a/scripts/fix-doc-links.js +++ b/scripts/fix-doc-links.js @@ -1,5 +1,3 @@ -#!/usr/bin/env node - const fs = require('fs') const path = require('path') const { globSync } = require('glob') @@ -15,303 +13,26 @@ function convertLinks(markdown) { }) } -// Fix markdown formatting issues and add modern styling +// Fix markdown formatting issues function fixFormatting(markdown) { - let content = markdown - // Remove underscores around (Optional) - content = content.replace(/_\(Optional\)_/g, '(Optional)') - - // Fix escaped links back to proper HTML - content = content.replace(/\\]*>([^<]+)\\<\/a>/g, '$2') - - // Remove inappropriate backslashes around text - content = content.replace(/\\(\[Internal API\])/g, '$1') - content = content.replace(/\\(\[k: string\])/g, '$1') - content = content.replace(/\\(\[)/g, '[') - content = content.replace(/\\(\])/g, ']') - content = content.replace(/\\(\{)/g, '{') - content = content.replace(/\\(\})/g, '}') - - // Fix escaped characters in table cells and code - content = content.replace(/\\\|/g, '|') - content = content.replace(/\\\//g, '/') - - // Fix specific problematic text patterns like "User session\" - content = content.replace(/([A-Za-z\s]+)\\"/g, '$1"') - content = content.replace(/\\"([A-Za-z\s]+)/g, '"$1') - - // Improve readability of array notation - content = content.replace(/\\\[\\\]/g, '[]') - - // Add modern CSS styling at the beginning of the document - if (!content.includes(' - -` - - // Insert CSS at the beginning of the document after the comment - if (content.includes('/, `$&\n\n${cssStyles}`) - } else { - content = cssStyles + content - } - } - - return content + return markdown.replace(/_\(Optional\)_/g, '(Optional)') } function runMain() { const docsDir = path.join(__dirname, '..', 'docs') const files = globSync(`${docsDir}/**/*.md`, { nodir: true }) - let processedFiles = 0 - files.forEach((file) => { const content = fs.readFileSync(file, 'utf8') let transformed = convertLinks(content) transformed = fixFormatting(transformed) if (content !== transformed) { fs.writeFileSync(file, transformed, 'utf8') - processedFiles++ } }) - - // Create modern CSS file - const cssContent = `/* Modern documentation styling */ -* { - margin: 0; - padding: 0; - box-sizing: border-box; -} - -body { - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif; - line-height: 1.6; - color: #333; - max-width: 1200px; - margin: 0 auto; - padding: 20px; - background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%); - min-height: 100vh; -} - -h1, h2, h3, h4, h5, h6 { - color: #2c3e50; - font-weight: 600; - margin-top: 2em; - margin-bottom: 0.5em; -} - -h1 { - border-bottom: 2px solid #632ca6; - padding-bottom: 0.5em; - color: #632ca6; -} - -h2 { - border-bottom: 1px solid #e1e4e8; - padding-bottom: 0.3em; -} - -table { - width: 100%; - border-collapse: collapse; - margin: 1em 0; - background-color: white; - border-radius: 6px; - overflow: hidden; - box-shadow: 0 1px 3px rgba(0,0,0,0.1); + console.log(`Processed ${files.length} markdown files, converted markdown links to HTML tags.`) } -thead { - background-color: #632ca6; - color: white; +if (require.main === module) { + runMain() } - -th, td { - padding: 12px; - text-align: left; - border-bottom: 1px solid #e1e4e8; -} - -th { - font-weight: 600; - font-size: 0.9em; - text-transform: uppercase; - letter-spacing: 0.5px; -} - -tbody tr:hover { - background-color: #f8f9fa; -} - -code { - background-color: #f1f3f4; - padding: 2px 6px; - border-radius: 3px; - font-family: 'SF Mono', 'Monaco', 'Inconsolata', 'Roboto Mono', monospace; - font-size: 0.9em; - color: #d73a49; -} - -pre { - background-color: #f6f8fa; - border: 1px solid #e1e4e8; - border-radius: 6px; - padding: 16px; - overflow-x: auto; - margin: 1em 0; -} - -a { - color: #632ca6; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -table a { - font-weight: 500; - padding: 4px 8px; - background-color: #f1f3f4; - border-radius: 4px; - transition: background-color 0.2s; -} - -table a:hover { - background-color: #e1e4e8; - text-decoration: none; -} - -@media (max-width: 768px) { - body { - padding: 10px; - } - - table { - font-size: 0.9em; - } - - th, td { - padding: 8px; - } -} -` - - const cssPath = path.join(docsDir, 'style.css') - fs.writeFileSync(cssPath, cssContent) - - console.log( - `Processed ${processedFiles} markdown files, converted markdown links to HTML tags and added modern styling.` - ) - console.log('Created modern CSS styling file: docs/style.css') -} - -runMain() From 7211784fd8c9f5af08d9eb0be48d4e0c037dd491 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 15:24:52 +0200 Subject: [PATCH 16/21] change --- docs/browser-logs.datadoglogs.md | 40 +++- docs/browser-logs.handlertype.md | 40 +++- docs/browser-logs.logger._constructor_.md | 42 +++- docs/browser-logs.logger.alert.md | 42 +++- docs/browser-logs.logger.clearcontext.md | 40 +++- docs/browser-logs.logger.critical.md | 42 +++- docs/browser-logs.logger.debug.md | 42 +++- docs/browser-logs.logger.emerg.md | 42 +++- docs/browser-logs.logger.error.md | 42 +++- docs/browser-logs.logger.getcontext.md | 40 +++- docs/browser-logs.logger.gethandler.md | 40 +++- docs/browser-logs.logger.getlevel.md | 40 +++- docs/browser-logs.logger.info.md | 42 +++- docs/browser-logs.logger.log.md | 42 +++- docs/browser-logs.logger.logimplementation.md | 42 +++- docs/browser-logs.logger.md | 42 +++- docs/browser-logs.logger.notice.md | 42 +++- docs/browser-logs.logger.ok.md | 42 +++- ...owser-logs.logger.removecontextproperty.md | 42 +++- docs/browser-logs.logger.setcontext.md | 42 +++- .../browser-logs.logger.setcontextproperty.md | 42 +++- docs/browser-logs.logger.sethandler.md | 42 +++- docs/browser-logs.logger.setlevel.md | 42 +++- docs/browser-logs.logger.warn.md | 42 +++- ...rowser-logs.loggerconfiguration.context.md | 40 +++- ...rowser-logs.loggerconfiguration.handler.md | 40 +++- .../browser-logs.loggerconfiguration.level.md | 40 +++- docs/browser-logs.loggerconfiguration.md | 42 +++- docs/browser-logs.logsevent.application_id.md | 40 +++- docs/browser-logs.logsevent.date.md | 40 +++- docs/browser-logs.logsevent.error.md | 40 +++- docs/browser-logs.logsevent.http.md | 40 +++- docs/browser-logs.logsevent.logger.md | 40 +++- docs/browser-logs.logsevent.md | 42 +++- docs/browser-logs.logsevent.message.md | 40 +++- docs/browser-logs.logsevent.origin.md | 40 +++- docs/browser-logs.logsevent.service.md | 40 +++- docs/browser-logs.logsevent.session.md | 40 +++- docs/browser-logs.logsevent.session_id.md | 40 +++- docs/browser-logs.logsevent.status.md | 40 +++- docs/browser-logs.logsevent.view.md | 40 +++- docs/browser-logs.logseventdomaincontext.md | 40 +++- docs/browser-logs.logsglobal.clearaccount.md | 40 +++- ...wser-logs.logsglobal.clearglobalcontext.md | 40 +++- docs/browser-logs.logsglobal.clearuser.md | 40 +++- docs/browser-logs.logsglobal.createlogger.md | 40 +++- docs/browser-logs.logsglobal.getaccount.md | 40 +++- ...rowser-logs.logsglobal.getglobalcontext.md | 40 +++- ...er-logs.logsglobal.getinitconfiguration.md | 40 +++- ...wser-logs.logsglobal.getinternalcontext.md | 40 +++- docs/browser-logs.logsglobal.getlogger.md | 40 +++- docs/browser-logs.logsglobal.getuser.md | 40 +++- docs/browser-logs.logsglobal.init.md | 40 +++- docs/browser-logs.logsglobal.logger.md | 40 +++- docs/browser-logs.logsglobal.md | 44 +++- ...r-logs.logsglobal.removeaccountproperty.md | 40 +++- ....logsglobal.removeglobalcontextproperty.md | 40 +++- ...wser-logs.logsglobal.removeuserproperty.md | 40 +++- docs/browser-logs.logsglobal.setaccount.md | 40 +++- ...wser-logs.logsglobal.setaccountproperty.md | 40 +++- ...rowser-logs.logsglobal.setglobalcontext.md | 40 +++- ...ogs.logsglobal.setglobalcontextproperty.md | 40 +++- ...wser-logs.logsglobal.settrackingconsent.md | 40 +++- docs/browser-logs.logsglobal.setuser.md | 42 +++- docs/browser-logs.logsglobal.setuser_1.md | 42 +++- ...browser-logs.logsglobal.setuserproperty.md | 40 +++- ...r-logs.logsinitconfiguration.beforesend.md | 40 +++- ...ogsinitconfiguration.forwardconsolelogs.md | 40 +++- ...gsinitconfiguration.forwarderrorstologs.md | 40 +++- ...gs.logsinitconfiguration.forwardreports.md | 40 +++- docs/browser-logs.logsinitconfiguration.md | 46 +++- ...logs.logsinitconfiguration.usepciintake.md | 40 +++- docs/browser-logs.logsmessage.context.md | 40 +++- docs/browser-logs.logsmessage.md | 42 +++- docs/browser-logs.logsmessage.message.md | 40 +++- docs/browser-logs.logsmessage.status.md | 40 +++- docs/browser-logs.md | 48 +++- docs/browser-logs.statustype.md | 40 +++- docs/browser-rum-react.addreacterror.md | 42 +++- ...r-rum-react.errorboundary._constructor_.md | 42 +++- ...m-react.errorboundary.componentdidcatch.md | 42 +++- ....errorboundary.getderivedstatefromerror.md | 42 +++- docs/browser-rum-react.errorboundary.md | 46 +++- .../browser-rum-react.errorboundary.render.md | 40 +++- ...wser-rum-react.errorboundary.reseterror.md | 40 +++- docs/browser-rum-react.md | 46 +++- docs/browser-rum-react.reactplugin.md | 42 +++- ...um-react.unstable_reactcomponenttracker.md | 40 +++- docs/browser-rum-slim.datadogrum.md | 40 +++- docs/browser-rum-slim.md | 42 +++- docs/browser-rum.commonproperties._dd.md | 40 +++- docs/browser-rum.commonproperties.account.md | 40 +++- ...rowser-rum.commonproperties.application.md | 40 +++- docs/browser-rum.commonproperties.build_id.md | 40 +++- ...wser-rum.commonproperties.build_version.md | 40 +++- docs/browser-rum.commonproperties.ci_test.md | 40 +++- ...owser-rum.commonproperties.connectivity.md | 40 +++- docs/browser-rum.commonproperties.context.md | 40 +++- docs/browser-rum.commonproperties.date.md | 40 +++- docs/browser-rum.commonproperties.device.md | 40 +++- docs/browser-rum.commonproperties.display.md | 40 +++- docs/browser-rum.commonproperties.md | 42 +++- docs/browser-rum.commonproperties.os.md | 40 +++- docs/browser-rum.commonproperties.service.md | 40 +++- docs/browser-rum.commonproperties.session.md | 40 +++- docs/browser-rum.commonproperties.source.md | 40 +++- ...browser-rum.commonproperties.synthetics.md | 40 +++- docs/browser-rum.commonproperties.usr.md | 40 +++- docs/browser-rum.commonproperties.version.md | 40 +++- docs/browser-rum.commonproperties.view.md | 40 +++- docs/browser-rum.datadogrum.md | 40 +++- docs/browser-rum.md | 46 +++- docs/browser-rum.rumactionevent.md | 40 +++- ...-rum.rumactioneventdomaincontext.events.md | 40 +++- ...mactioneventdomaincontext.handlingstack.md | 40 +++- ...browser-rum.rumactioneventdomaincontext.md | 58 +++-- docs/browser-rum.rumerrorevent.md | 40 +++- ...er-rum.rumerroreventdomaincontext.error.md | 40 +++- ...umerroreventdomaincontext.handlingstack.md | 40 +++- .../browser-rum.rumerroreventdomaincontext.md | 54 +++-- docs/browser-rum.rumevent.md | 40 +++- docs/browser-rum.rumeventdomaincontext.md | 40 +++- ...umfetchresourceeventdomaincontext.error.md | 40 +++- ...esourceeventdomaincontext.handlingstack.md | 40 +++- ...tchresourceeventdomaincontext.isaborted.md | 40 +++- ...-rum.rumfetchresourceeventdomaincontext.md | 87 +++---- ...urceeventdomaincontext.performanceentry.md | 40 +++- ...hresourceeventdomaincontext.requestinit.md | 40 +++- ...resourceeventdomaincontext.requestinput.md | 40 +++- ...etchresourceeventdomaincontext.response.md | 40 +++- docs/browser-rum.rumglobal.addaction.md | 40 +++- .../browser-rum.rumglobal.adddurationvital.md | 40 +++- docs/browser-rum.rumglobal.adderror.md | 40 +++- ...-rum.rumglobal.addfeatureflagevaluation.md | 40 +++- docs/browser-rum.rumglobal.addtiming.md | 40 +++- docs/browser-rum.rumglobal.clearaccount.md | 40 +++- ...rowser-rum.rumglobal.clearglobalcontext.md | 40 +++- docs/browser-rum.rumglobal.clearuser.md | 40 +++- docs/browser-rum.rumglobal.getaccount.md | 40 +++- .../browser-rum.rumglobal.getglobalcontext.md | 40 +++- ...wser-rum.rumglobal.getinitconfiguration.md | 40 +++- ...rowser-rum.rumglobal.getinternalcontext.md | 40 +++- ...wser-rum.rumglobal.getsessionreplaylink.md | 40 +++- docs/browser-rum.rumglobal.getuser.md | 40 +++- docs/browser-rum.rumglobal.getviewcontext.md | 40 +++- docs/browser-rum.rumglobal.init.md | 40 +++- docs/browser-rum.rumglobal.md | 44 +++- ...ser-rum.rumglobal.removeaccountproperty.md | 40 +++- ...m.rumglobal.removeglobalcontextproperty.md | 40 +++- ...rowser-rum.rumglobal.removeuserproperty.md | 40 +++- docs/browser-rum.rumglobal.setaccount.md | 40 +++- ...rowser-rum.rumglobal.setaccountproperty.md | 40 +++- .../browser-rum.rumglobal.setglobalcontext.md | 40 +++- ...-rum.rumglobal.setglobalcontextproperty.md | 40 +++- ...rowser-rum.rumglobal.settrackingconsent.md | 40 +++- docs/browser-rum.rumglobal.setuser.md | 42 +++- docs/browser-rum.rumglobal.setuser_1.md | 42 +++- docs/browser-rum.rumglobal.setuserproperty.md | 40 +++- docs/browser-rum.rumglobal.setviewcontext.md | 40 +++- ...er-rum.rumglobal.setviewcontextproperty.md | 40 +++- docs/browser-rum.rumglobal.setviewname.md | 40 +++- ...rowser-rum.rumglobal.startdurationvital.md | 40 +++- ...m.rumglobal.startsessionreplayrecording.md | 40 +++- docs/browser-rum.rumglobal.startview.md | 40 +++- ...browser-rum.rumglobal.stopdurationvital.md | 40 +++- docs/browser-rum.rumglobal.stopsession.md | 40 +++- ...um.rumglobal.stopsessionreplayrecording.md | 40 +++- ...uminitconfiguration.actionnameattribute.md | 40 +++- ...ruminitconfiguration.allowedtracingurls.md | 40 +++- ...-rum.ruminitconfiguration.applicationid.md | 40 +++- ...ser-rum.ruminitconfiguration.beforesend.md | 40 +++- ...nitconfiguration.compressintakerequests.md | 40 +++- ...uminitconfiguration.defaultprivacylevel.md | 40 +++- ...onfiguration.enableprivacyforactionname.md | 40 +++- ...minitconfiguration.excludedactivityurls.md | 40 +++- docs/browser-rum.ruminitconfiguration.md | 48 +++- ...rowser-rum.ruminitconfiguration.plugins.md | 40 +++- ...uminitconfiguration.profilingsamplerate.md | 40 +++- ...initconfiguration.propagatetracebaggage.md | 40 +++- ...initconfiguration.remoteconfigurationid.md | 40 +++- ...itconfiguration.sessionreplaysamplerate.md | 40 +++- ...ion.startsessionreplayrecordingmanually.md | 40 +++- ...wser-rum.ruminitconfiguration.subdomain.md | 40 +++- ...initconfiguration.tracecontextinjection.md | 40 +++- ...um.ruminitconfiguration.tracesamplerate.md | 40 +++- ...onfiguration.trackfeatureflagsforevents.md | 40 +++- ...rum.ruminitconfiguration.tracklongtasks.md | 40 +++- ...rum.ruminitconfiguration.trackresources.md | 40 +++- ...initconfiguration.trackuserinteractions.md | 40 +++- ...ruminitconfiguration.trackviewsmanually.md | 40 +++- ...wser-rum.ruminitconfiguration.workerurl.md | 40 +++- docs/browser-rum.rumlongtaskevent.md | 40 +++- ...owser-rum.rumlongtaskeventdomaincontext.md | 47 +++- ...taskeventdomaincontext.performanceentry.md | 40 +++- ...-rum.rumotherresourceeventdomaincontext.md | 47 +++- ...urceeventdomaincontext.performanceentry.md | 40 +++- docs/browser-rum.rumresourceevent.md | 40 +++- docs/browser-rum.rumviewevent.md | 40 +++- ...-rum.rumvieweventdomaincontext.location.md | 40 +++- docs/browser-rum.rumvieweventdomaincontext.md | 47 +++- docs/browser-rum.rumvitalevent.md | 40 +++- ...esourceeventdomaincontext.handlingstack.md | 40 +++- ...xhrresourceeventdomaincontext.isaborted.md | 40 +++- ...er-rum.rumxhrresourceeventdomaincontext.md | 66 ++++-- ...urceeventdomaincontext.performanceentry.md | 40 +++- ...um.rumxhrresourceeventdomaincontext.xhr.md | 40 +++- docs/index.md | 42 +++- package.json | 2 +- scripts/fix-api-docs-final.js | 216 ++++++++++++++++++ 209 files changed, 8166 insertions(+), 572 deletions(-) create mode 100644 scripts/fix-api-docs-final.js diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index e8080c46a6..449b5a6944 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > datadogLogs ## datadogLogs variable diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index 4c647614b6..c7488124a7 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > HandlerType ## HandlerType variable diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index e3619d1fab..91e076a123 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -14,7 +50,7 @@ constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handli ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 48011cc323..9d4abceb16 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > alert ## Logger.alert() method @@ -12,7 +48,7 @@ alert(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index a61699e2ae..19bc431214 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 0b16b394ca..476094ef46 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > critical ## Logger.critical() method @@ -12,7 +48,7 @@ critical(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 52ef50524e..6af6a21b60 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > debug ## Logger.debug() method @@ -12,7 +48,7 @@ debug(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index ee6a6c3abe..1ae3e8b8ad 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method @@ -12,7 +48,7 @@ emerg(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index b16b6e1f49..e7067829c1 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > error ## Logger.error() method @@ -12,7 +48,7 @@ error(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 847897dc6a..fda7634d60 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 7e09bd4314..0e743077fa 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 116d582953..39f9894dcb 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index c68fc09ce5..1915a02654 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > info ## Logger.info() method @@ -12,7 +48,7 @@ info(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 9534e2dbaa..809b389cd3 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -12,7 +48,7 @@ log(message: string, messageContext?: object, status?: StatusType, error?: Error ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index d4d15f44f7..05091c178e 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -12,7 +48,7 @@ logImplementation(message: string, messageContext?: object, status?: StatusType, ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 537cfee72a..1fa59aaa34 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger ## Logger interface @@ -12,7 +48,7 @@ export interface Logger ## Methods -
+
Method diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index f9836a7c30..ff1c988761 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > notice ## Logger.notice() method @@ -12,7 +48,7 @@ notice(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index eb4ab969a7..76ce03e582 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > ok ## Logger.ok() method @@ -12,7 +48,7 @@ ok(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index a1e0ebd782..8994ba23bf 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method @@ -12,7 +48,7 @@ removeContextProperty(key: string): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 10c3e47398..1f421087b2 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method @@ -12,7 +48,7 @@ setContext(context: object): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 37ce71e0b9..adcd6ef6bf 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method @@ -12,7 +48,7 @@ setContextProperty(key: string, value: any): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index a92a47f79c..de02e669ec 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -12,7 +48,7 @@ setHandler(handler: HandlerType | HandlerType[]): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 0367f97bf3..a8d4ce3f63 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -12,7 +48,7 @@ setLevel(level: StatusType): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 2dd15971ba..40bd389fe5 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > Logger > warn ## Logger.warn() method @@ -12,7 +48,7 @@ warn(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index da351e1643..358ec66305 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 906fea4454..b9fef7eb77 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 0f64773a54..dd09903237 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index e2b8267b7e..5e4760a501 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface @@ -12,7 +48,7 @@ export interface LoggerConfiguration ## Properties -
+
Property diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 55763153a4..3453428f87 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > application\_id ## LogsEvent.application\_id property diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index ec9e4e24fb..54d6e881c8 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 462b2e1f6c..203374ec86 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 3206ecd365..9c2dcd95ea 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 87d2079448..70eba066ba 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index dff3e73297..55e64ada9e 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent ## LogsEvent interface @@ -12,7 +48,7 @@ export interface LogsEvent ## Properties -
+
Property diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 0e688c568e..5415baba45 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 1b4dbf42f8..42512e7e63 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index 251a28d0bd..313a8d8873 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 179cbc5713..09fa7db670 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 76891367dc..4c548dbcf7 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > session\_id ## LogsEvent.session\_id property diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 898f1fe479..3762c76de3 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 3ac0abb479..cf82788694 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 867014bb3b..45782e72cc 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index 9df5f06c88..f6a34fd0de 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index 5c5e536b07..ee4d5268f7 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 8adcc276b4..6f64bbedd9 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 2503071fe4..733133d68a 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 43d16fefcf..baf5bbffac 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index d10bbe30d9..c568bfd5c9 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index a1a53cc138..4ef782ae9c 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index c22bd2af3e..a31edc9804 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 1cb3fb0ae6..55b58e2e64 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 0cb46a9696..184a80a979 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 65bcd0c20f..09749621bf 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index c5a9be9bfe..e702bbe233 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 082fc0b13a..a6af572d73 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface @@ -13,7 +49,7 @@ export interface LogsPublicApi extends PublicApi ## Properties -
+
Property @@ -453,7 +489,7 @@ Set or update the user property, stored in `@usr.` ## Methods -
+
Method diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 2321d5b50e..8d80afc63e 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index d64200108f..ba91648d9d 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 47942669d5..c4364913a4 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index d4273bc766..cf258b3969 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 0ff6da5fd5..1d806d9fc6 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index f07063e025..cc37fa135f 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 9e475d236d..9c873bb6a7 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index b59ca39ee6..1eb3cc4e22 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 76ad33f57a..ddec36253a 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method @@ -18,7 +54,7 @@ setUser(newUser: User & { ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 9570bc14e2..0dd9d78283 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method @@ -19,7 +55,7 @@ setUser(newUser: User): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 1aa3195263..dc603e5283 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index d0b1eb8d6b..9ce5c12d35 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index cdd472a5e8..b5b75ff273 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index f1920aa7f3..8d2d513425 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index fd149e19fb..827fbe9ade 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index a241bdb8bf..6e5ee21d2a 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface @@ -13,7 +49,7 @@ export interface LogsInitConfiguration extends InitConfiguration ## Properties -
+
Property @@ -63,7 +99,7 @@ Description -ConsoleApiName\[\] \| 'all' \| undefined +ConsoleApiName[] \| 'all' \| undefined @@ -101,7 +137,7 @@ boolean \| undefined -RawReportType\[\] \| 'all' \| undefined +RawReportType[] \| 'all' \| undefined diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 24859ac38e..6fcfe58601 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 537ccc7a78..0674fd5a99 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 107876469a..18533a70f8 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -12,7 +48,7 @@ export interface LogsMessage ## Properties -
+
Property diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index ba97f70fb7..99a121d30b 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 3217ac3816..9937ce97db 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index cbafd19deb..3f75c947dc 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs ## browser-logs package @@ -8,7 +44,7 @@ Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. ## Classes -
+
Class @@ -32,7 +68,7 @@ Description ## Interfaces -
+
Interface @@ -101,7 +137,7 @@ Description ## Variables -
+
Variable @@ -145,7 +181,7 @@ The global Logs instance. Use this to call Logs methods. ## Type Aliases -
+
Type Alias diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 4d9dade523..313f556f41 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-logs > StatusType ## StatusType variable diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index e00eafc47e..3b364377ca 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > addReactError ## addReactError() function @@ -12,7 +48,7 @@ export declare function addReactError(error: Error, info: ErrorInfo): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 8ccd318cde..2d45d5d026 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) @@ -14,7 +50,7 @@ constructor(props: Props); ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index b14b0fb664..1f27f87a88 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method @@ -12,7 +48,7 @@ componentDidCatch(error: Error, errorInfo: ErrorInfo): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 5b987d5bdc..c26c6503fb 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method @@ -12,7 +48,7 @@ static getDerivedStateFromError(error: Error): State; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 0a6b26b377..b3932488a7 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class @@ -13,7 +49,7 @@ export declare class ErrorBoundary extends React.Component ## Constructors -
+
Constructor @@ -47,7 +83,7 @@ Constructs a new instance of the `ErrorBoundary` class ## Properties -
+
Property @@ -89,7 +125,7 @@ Description ## Methods -
+
Method diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 7c6ac00636..123e22a7ad 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 48532c6c9f..b1add9bc62 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 8228bf87f4..689cac64c4 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react ## browser-rum-react package @@ -8,7 +44,7 @@ Datadog Browser RUM React Integration - Additional components and hooks for Reac ## Classes -
+
Class @@ -32,7 +68,7 @@ Description ## Functions -
+
Function @@ -65,7 +101,7 @@ Description ## Variables -
+
Variable diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 94c4d7e535..910c56b8a7 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function @@ -24,7 +60,7 @@ export declare function reactPlugin(configuration?: ReactPluginConfiguration): { ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 595b895ff8..1a01ba4b54 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker ## UNSTABLE\_ReactComponentTracker variable diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 917da31e02..b7e1f8eea1 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index ca909b306e..77695720ff 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum-slim ## browser-rum-slim package @@ -8,7 +44,7 @@ Datadog Browser RUM SDK - Slim version without Session Replay and Real User Prof ## Variables -
+
Variable diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index ad1cb08af6..175cd34afd 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > \_dd ## CommonProperties.\_dd property diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 45368c8e6e..f4160108b6 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index cd13d05e30..77e57f6e85 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index b86a419740..07f69281e6 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > build\_id ## CommonProperties.build\_id property diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 9633cbb6ea..723ff97bf7 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > build\_version ## CommonProperties.build\_version property diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 49573e6d83..4895939ac0 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > ci\_test ## CommonProperties.ci\_test property diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 487f61ebe0..33e4d79c6a 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index e565438b7b..a7cbcb4cec 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index bdb152047d..5ea60a4ba9 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index c1a3c6a1e0..d4b7d79f9d 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 861e290d0e..735c06e950 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 2cfeef35c1..bb80113251 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -14,7 +50,7 @@ export interface CommonProperties ## Properties -
+
Property diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 536aa92efd..47e1ca987e 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index 75bd81afa2..6c06408108 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index d546e76ce3..58c57bf9cc 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index c3de043c5d..ec7941adac 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 2fafb2b1a1..c7592ed516 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 7b6b5f4cd4..5b4b81496a 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 9854d3ef1c..9cf50c8113 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index b2a07261e5..0de52ea4e9 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 2b39faf4bc..4b6e44d59e 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 743101b513..a51a96739d 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum ## browser-rum package @@ -8,7 +44,7 @@ Datadog Browser RUM SDK - Full version with Session Replay and Real User Profili ## Interfaces -
+
Interface @@ -115,7 +151,7 @@ Schema of common properties of RUM events ## Variables -
+
Variable @@ -141,7 +177,7 @@ The global RUM instance. Use this to call RUM methods. ## Type Aliases -
+
Type Alias diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 5df82dc308..a922f3078f 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumActionEvent ## RumActionEvent type diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 6698f63bae..e2e8e797ad 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 3a381da3c1..8a60fbcb11 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 91937c5cdf..684801837b 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumActionEventDomainContext ## Properties -
+ + +
Property @@ -43,15 +79,10 @@ Description -Event\[\] - - - - -(Optional) +Event[] -
DOM events that triggered this action. (Optional)
handlingStack? @@ -65,10 +96,5 @@ Event\[\] string - - -(Optional) - - -
Stack trace of where the action was handled by the SDK. (Optional)
diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index d539728f58..a9636f3dd2 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 833d7b2a30..be1f6e9da6 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index fe21529635..768b4d2fb7 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index aa70a3ef61..cab07ea45d 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumErrorEventDomainContext ## Properties -
+ + +
Property @@ -46,10 +82,7 @@ Description unknown - - - -
The original error object that was captured.
handlingStack? @@ -63,10 +96,5 @@ unknown string - - -(Optional) - - -
Stack trace of where the error was handled by the SDK. (Optional)
diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 2e3d079ae0..6df3dcabb4 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumEvent ## RumEvent type diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 7e9b0b07ea..7bc118b3b5 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 384bf37e94..6374532839 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index e8c761d8d7..2013739634 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 1245b6a516..fe7bd593ab 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index c93b2f9144..3f4c39581c 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumFetchResourceEventDomainContext ## Properties -\n') - return content -} - -function processDocFile(file) { - let content = fs.readFileSync(file, 'utf8') - - content = fixTypeBackslashes(content) - content = fixArrayTypes(content) - content = fixOptionalFormatting(content) - content = convertMarkdownLinks(content) - content = fixHtmlEntities(content) - content = removeEmptyHtmlComments(content) - content = fixEscapedTags(content) - content = fixBackslashes(content) - content = fixHtmlTables(content) - content = dedupClosingTableTags(content) - content = cleanupSpacing(content) - - fs.writeFileSync(file, content, 'utf8') -} - -function runMain() { - const docsDir = path.join(__dirname, '..', 'docs') - const docFiles = globSync(`${docsDir}/*.md`) - - for (const file of docFiles) { - try { - processDocFile(file) - } catch (error) { - console.error(`Error processing ${file}:`, error.message) - } - } -} - -if (require.main === module) { - runMain() -}
+ + + + + + + +
Property @@ -46,12 +82,7 @@ Description Error - - -(Optional) - - -
Error that occurred during the fetch call. (Optional)
handlingStack? @@ -65,12 +96,7 @@ Error string - - -(Optional) - - -
Stack trace of where the resource was handled by the SDK. (Optional)
isAborted @@ -84,10 +110,7 @@ string boolean - - - -
Whether the fetch call was aborted.
performanceEntry? @@ -101,12 +124,7 @@ boolean PerformanceEntry - - -(Optional) - - -
Browser performance entry for this resource. (Optional)
requestInit? @@ -120,12 +138,7 @@ PerformanceEntry RequestInit - - -(Optional) - - -
Init object passed to the fetch call. (Optional)
requestInput @@ -139,10 +152,7 @@ RequestInit RequestInfo - - - -
Input parameter passed to the fetch call.
response? @@ -156,10 +166,5 @@ RequestInfo Response - - -(Optional) - - -
Response object returned by the fetch call. (Optional)
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index dd65de0e81..3ded6e60d2 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 49ccfc94fe..0467466e9b 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 66999ec3d0..91e1897f02 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 50db70b5a5..c31cf4030f 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 1d2b039ff5..1bfd7ce95f 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index fc23fa7b0f..a53bc1c1c1 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index d560b0591b..ec33d14d43 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 706ce9c41f..f1d10b5d7e 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 3fcd32fd26..2400df43fa 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 07b37b26d5..1889036a5e 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index c4c687ba47..a763251d3b 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 7e42ce3c9a..2ea6233546 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index dba65370b3..6afd404920 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 6ca297788e..5cc8faf710 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 207a9ba9b4..07e6c09b27 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 9377e29955..af454a35cf 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 523e21415a..4b90b80d1e 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index f443dcd8d0..122e59a8ef 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 7fc407f915..39808a46e4 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 1142877612..5d7a7a1bd5 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index a9c624b401..cca833d0d6 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal ## RumGlobal interface @@ -13,7 +49,7 @@ export interface RumPublicApi extends PublicApi ## Properties - @@ -49,25 +54,23 @@ Description @@ -88,12 +91,12 @@ Description diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index e7fcff1a09..79ce85e066 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,28 +1,33 @@ +--- +layout: default +title: "reactPlugin() function" +nav_order: 121 +permalink: /browser-rum-react.reactplugin.html +--- + -Home > @datadog/browser-rum-react > reactPlugin +Home > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function -Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). - -The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM \*Error\* events) - Optional react-router view tracking - Component performance tracking utilities (see UNSTABLE_ReactComponentTracker). +Factory function that creates the React plugin for Datadog RUM, enabling features like ErrorBoundary integration, optional react-router view tracking, and component performance tracking utilities. **Signature:** ```typescript export declare function reactPlugin(configuration?: ReactPluginConfiguration): { - name: string; - onInit({ publicApi, initConfiguration }: { - initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; - publicApi: RumPublicApi; - }): void; - onRumStart({ strategy }: { - strategy: Strategy; - }): void; - getConfigurationTelemetry(): { - router: boolean; - }; + name: string; + onInit({ publicApi, initConfiguration }: { + initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; + publicApi: RumPublicApi; + }): void; + onRumStart({ strategy }: { + strategy: Strategy; + }): void; + getConfigurationTelemetry(): { + router: boolean; + }; }; ``` @@ -56,7 +61,7 @@ ReactPluginConfiguration @@ -65,5 +70,3 @@ ReactPluginConfiguration { name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } -A RUM plugin instance to include in the SDK init. - diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 184a68fff4..3ef3eac0d1 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,16 +1,23 @@ +--- +layout: default +title: "UNSTABLE_ReactComponentTracker variable" +nav_order: 120 +permalink: /browser-rum-react.unstable_reactcomponenttracker.html +--- + -Home > @datadog/browser-rum-react > UNSTABLE_ReactComponentTracker +Home > @datadog/browser-rum-react > UNSTABLE_ReactComponentTracker ## UNSTABLE_ReactComponentTracker variable -Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`. +Experimental component that tracks the render lifecycle of its children and reports a duration vital named `reactComponentRender`. **Signature:** ```typescript UNSTABLE_ReactComponentTracker: ({ name: componentName, children, }: { - name: string; - children?: React.ReactNode; + name: string; + children?: React.ReactNode; }) => React.JSX.Element ``` diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index dc358aea7b..0ff50abd54 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "datadogRum variable" +nav_order: 119 +permalink: /browser-rum-slim.datadogrum.html +--- + -Home > @datadog/browser-rum-slim > datadogRum +Home > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index 995582d35b..1258247aed 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "browser-rum-slim package" +nav_order: 118 +permalink: /browser-rum-slim.html +--- + -Home > @datadog/browser-rum-slim +Home > @datadog/browser-rum-slim ## browser-rum-slim package @@ -21,7 +28,7 @@ Description @@ -725,20 +732,20 @@ Description diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 9eef7688ca..5bff45a334 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration.plugins property" +nav_order: 31 +permalink: /browser-rum.ruminitconfiguration.plugins.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > plugins +Home > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index 4387987ca1..37ba115f11 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.profilingSampleRate property" +nav_order: 30 +permalink: /browser-rum.ruminitconfiguration.profilingsamplerate.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property -Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 726e6a232a..723e7a3978 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.propagateTraceBaggage property" +nav_order: 29 +permalink: /browser-rum.ruminitconfiguration.propagatetracebaggage.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage +Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property -Whether to propagate user and account IDs in the baggage header of trace requests. false +Whether to propagate user and account IDs in the baggage header of trace requests. false **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index dfd05d19be..4018b274fb 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration.remoteConfigurationId property" +nav_order: 28 +permalink: /browser-rum.ruminitconfiguration.remoteconfigurationid.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId +Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index e21045d625..c1c2d6b7dc 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.sessionReplaySampleRate property" +nav_order: 27 +permalink: /browser-rum.ruminitconfiguration.sessionreplaysamplerate.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate +Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property -The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index be9a682fe4..c603e46404 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.startSessionReplayRecordingManually property" +nav_order: 26 +permalink: /browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually +Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property -If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. +If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 8d460d94d8..e0f7d9d859 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.subdomain property" +nav_order: 25 +permalink: /browser-rum.ruminitconfiguration.subdomain.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > subdomain +Home > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property -If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. +If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 0ab150c0e6..c7ad8a7dce 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.traceContextInjection property" +nav_order: 24 +permalink: /browser-rum.ruminitconfiguration.tracecontextinjection.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection +Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property -If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index aaad5ff369..db9d64057b 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.traceSampleRate property" +nav_order: 23 +permalink: /browser-rum.ruminitconfiguration.tracesamplerate.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property -The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. +The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 6eeacadda5..a60104d00c 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration.trackFeatureFlagsForEvents property" +nav_order: 22 +permalink: /browser-rum.ruminitconfiguration.trackfeatureflagsforevents.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents +Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index a2a157e639..b5d3705c3a 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.trackLongTasks property" +nav_order: 21 +permalink: /browser-rum.ruminitconfiguration.tracklongtasks.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks +Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property -Enables collection of long task events. true +Enables collection of long task events. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 0bef3c1d99..3cc126c590 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.trackResources property" +nav_order: 20 +permalink: /browser-rum.ruminitconfiguration.trackresources.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > trackResources +Home > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property -Enables collection of resource events. true +Enables collection of resource events. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index cd03846cb0..9c5ca0e103 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.trackUserInteractions property" +nav_order: 19 +permalink: /browser-rum.ruminitconfiguration.trackuserinteractions.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions +Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property -Enables automatic collection of users actions. See Tracking User Actions for further information. true +Enables automatic collection of users actions. See Tracking User Actions for further information. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index a74d32f90e..0de658e040 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.trackViewsManually property" +nav_order: 18 +permalink: /browser-rum.ruminitconfiguration.trackviewsmanually.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually +Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property -Allows you to control RUM views creation. See Override default RUM view names for further information. +Allows you to control RUM views creation. See Override default RUM view names for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index 018db81b83..fecc441b71 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.workerUrl property" +nav_order: 17 +permalink: /browser-rum.ruminitconfiguration.workerurl.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > workerUrl +Home > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property -URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. +URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. **Signature:** diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index ff58b3c6d6..cf231c0488 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumLongTaskEvent type" +nav_order: 16 +permalink: /browser-rum.rumlongtaskevent.html +--- + -Home > @datadog/browser-rum > RumLongTaskEvent +Home > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type @@ -10,39 +17,39 @@ Schema of all properties of a Long Task event ```typescript export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'long_task'; - readonly long_task: { - readonly id?: string; - readonly start_time?: number; - readonly entry_type?: 'long-task' | 'long-animation-frame'; - readonly duration: number; - readonly blocking_duration?: number; - readonly render_start?: number; - readonly style_and_layout_start?: number; - readonly first_ui_event_timestamp?: number; - readonly is_frozen_frame?: boolean; - readonly scripts?: { - readonly duration?: number; - readonly pause_duration?: number; - readonly forced_style_and_layout_duration?: number; - readonly start_time?: number; - readonly execution_start?: number; - source_url?: string; - readonly source_function_name?: string; - readonly source_char_position?: number; - invoker?: string; - readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; - readonly window_attribution?: string; - [k: string]: unknown; - }[]; - [k: string]: unknown; - }; - readonly _dd?: { - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'long_task'; + readonly long_task: { + readonly id?: string; + readonly start_time?: number; + readonly entry_type?: 'long-task' | 'long-animation-frame'; + readonly duration: number; + readonly blocking_duration?: number; + readonly render_start?: number; + readonly style_and_layout_start?: number; + readonly first_ui_event_timestamp?: number; + readonly is_frozen_frame?: boolean; + readonly scripts?: { + readonly duration?: number; + readonly pause_duration?: number; + readonly forced_style_and_layout_duration?: number; + readonly start_time?: number; + readonly execution_start?: number; + source_url?: string; + readonly source_function_name?: string; + readonly source_char_position?: number; + invoker?: string; + readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; + readonly window_attribution?: string; + [k: string]: unknown; + }[]; + [k: string]: unknown; + }; + readonly _dd?: { + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index e36cf0224e..ee854fc5f2 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumLongTaskEventDomainContext interface" +nav_order: 15 +permalink: /browser-rum.rumlongtaskeventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumLongTaskEventDomainContext +Home > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface @@ -37,7 +44,7 @@ Description
+
Property @@ -710,7 +746,7 @@ See \
Method diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index e8f1c73c0b..2c3a1db1f4 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index b57a72c511..b8cecb67d9 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 190cc5cf6d..df65c90921 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index a559156d79..28ce965030 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 6d41e04cb2..6aab22366c 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 08d98484b9..0bc85d4394 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 542c3c639b..e83d03271f 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 41efadfec9..d5d48b36f6 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index a086a3e0f5..667825daf5 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method @@ -18,7 +54,7 @@ setUser(newUser: User & { ## Parameters -\n') + return content +} + function processDocFile(file) { let content = fs.readFileSync(file, 'utf8') @@ -80,6 +88,7 @@ function processDocFile(file) { content = fixEscapedTags(content) content = fixBackslashes(content) content = fixHtmlTables(content) + content = dedupClosingTableTags(content) content = cleanupSpacing(content) fs.writeFileSync(file, content, 'utf8') From 502123c11a8a2f6b00b7fbbfb289a3709dda9041 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Fri, 13 Jun 2025 10:57:44 +0200 Subject: [PATCH 21/21] index --- .github/workflows/api-docs-release.yml | 71 ++++ .github/workflows/pages.yml | 0 Gemfile | 12 + Gemfile.lock | 309 ++++++++++++++++++ _config_docs.yml | 33 ++ docs/browser-logs.datadoglogs.md | 9 +- docs/browser-logs.handlertype.md | 17 +- docs/browser-logs.logger._constructor_.md | 15 +- docs/browser-logs.logger.alert.md | 9 +- docs/browser-logs.logger.clearcontext.md | 9 +- docs/browser-logs.logger.critical.md | 9 +- docs/browser-logs.logger.debug.md | 9 +- docs/browser-logs.logger.emerg.md | 9 +- docs/browser-logs.logger.error.md | 9 +- docs/browser-logs.logger.getcontext.md | 9 +- docs/browser-logs.logger.gethandler.md | 11 +- docs/browser-logs.logger.getlevel.md | 11 +- docs/browser-logs.logger.info.md | 9 +- docs/browser-logs.logger.log.md | 11 +- docs/browser-logs.logger.logimplementation.md | 11 +- docs/browser-logs.logger.md | 31 +- docs/browser-logs.logger.notice.md | 9 +- docs/browser-logs.logger.ok.md | 9 +- ...owser-logs.logger.removecontextproperty.md | 9 +- docs/browser-logs.logger.setcontext.md | 9 +- .../browser-logs.logger.setcontextproperty.md | 9 +- docs/browser-logs.logger.sethandler.md | 11 +- docs/browser-logs.logger.setlevel.md | 11 +- docs/browser-logs.logger.warn.md | 9 +- ...rowser-logs.loggerconfiguration.context.md | 9 +- ...rowser-logs.loggerconfiguration.handler.md | 9 +- .../browser-logs.loggerconfiguration.level.md | 9 +- docs/browser-logs.loggerconfiguration.md | 21 +- docs/browser-logs.logsevent.application_id.md | 9 +- docs/browser-logs.logsevent.date.md | 9 +- docs/browser-logs.logsevent.error.md | 33 +- docs/browser-logs.logsevent.http.md | 19 +- docs/browser-logs.logsevent.logger.md | 15 +- docs/browser-logs.logsevent.md | 45 ++- docs/browser-logs.logsevent.message.md | 9 +- docs/browser-logs.logsevent.origin.md | 9 +- docs/browser-logs.logsevent.service.md | 9 +- docs/browser-logs.logsevent.session.md | 15 +- docs/browser-logs.logsevent.session_id.md | 9 +- docs/browser-logs.logsevent.status.md | 9 +- docs/browser-logs.logsevent.view.md | 19 +- docs/browser-logs.logseventdomaincontext.md | 9 +- docs/browser-logs.logsglobal.clearaccount.md | 9 +- ...wser-logs.logsglobal.clearglobalcontext.md | 11 +- docs/browser-logs.logsglobal.clearuser.md | 11 +- docs/browser-logs.logsglobal.createlogger.md | 13 +- docs/browser-logs.logsglobal.getaccount.md | 9 +- ...rowser-logs.logsglobal.getglobalcontext.md | 11 +- ...er-logs.logsglobal.getinitconfiguration.md | 9 +- ...wser-logs.logsglobal.getinternalcontext.md | 13 +- docs/browser-logs.logsglobal.getlogger.md | 11 +- docs/browser-logs.logsglobal.getuser.md | 11 +- docs/browser-logs.logsglobal.init.md | 9 +- docs/browser-logs.logsglobal.logger.md | 9 +- docs/browser-logs.logsglobal.md | 123 +++---- ...r-logs.logsglobal.removeaccountproperty.md | 9 +- ....logsglobal.removeglobalcontextproperty.md | 11 +- ...wser-logs.logsglobal.removeuserproperty.md | 11 +- docs/browser-logs.logsglobal.setaccount.md | 9 +- ...wser-logs.logsglobal.setaccountproperty.md | 9 +- ...rowser-logs.logsglobal.setglobalcontext.md | 9 +- ...ogs.logsglobal.setglobalcontextproperty.md | 9 +- ...wser-logs.logsglobal.settrackingconsent.md | 9 +- docs/browser-logs.logsglobal.setuser.md | 17 +- docs/browser-logs.logsglobal.setuser_1.md | 9 +- ...browser-logs.logsglobal.setuserproperty.md | 9 +- ...r-logs.logsinitconfiguration.beforesend.md | 9 +- ...ogsinitconfiguration.forwardconsolelogs.md | 11 +- ...gsinitconfiguration.forwarderrorstologs.md | 11 +- ...gs.logsinitconfiguration.forwardreports.md | 11 +- docs/browser-logs.logsinitconfiguration.md | 35 +- ...logs.logsinitconfiguration.usepciintake.md | 11 +- docs/browser-logs.logsmessage.context.md | 9 +- docs/browser-logs.logsmessage.md | 17 +- docs/browser-logs.logsmessage.message.md | 9 +- docs/browser-logs.logsmessage.status.md | 9 +- docs/browser-logs.md | 51 ++- docs/browser-logs.statustype.md | 29 +- docs/browser-rum-react.addreacterror.md | 15 +- ...r-rum-react.errorboundary._constructor_.md | 9 +- ...m-react.errorboundary.componentdidcatch.md | 9 +- ....errorboundary.getderivedstatefromerror.md | 9 +- docs/browser-rum-react.errorboundary.md | 27 +- .../browser-rum-react.errorboundary.render.md | 9 +- ...wser-rum-react.errorboundary.reseterror.md | 9 +- docs/browser-rum-react.md | 29 +- docs/browser-rum-react.reactplugin.md | 39 ++- ...um-react.unstable_reactcomponenttracker.md | 15 +- docs/browser-rum-slim.datadogrum.md | 9 +- docs/browser-rum-slim.md | 11 +- docs/browser-rum.commonproperties._dd.md | 37 ++- docs/browser-rum.commonproperties.account.md | 17 +- ...rowser-rum.commonproperties.application.md | 15 +- docs/browser-rum.commonproperties.build_id.md | 9 +- ...wser-rum.commonproperties.build_version.md | 9 +- docs/browser-rum.commonproperties.ci_test.md | 15 +- ...owser-rum.commonproperties.connectivity.md | 29 +- docs/browser-rum.commonproperties.context.md | 13 +- docs/browser-rum.commonproperties.date.md | 9 +- docs/browser-rum.commonproperties.device.md | 23 +- docs/browser-rum.commonproperties.display.md | 23 +- docs/browser-rum.commonproperties.md | 73 +++-- docs/browser-rum.commonproperties.os.md | 21 +- docs/browser-rum.commonproperties.service.md | 9 +- docs/browser-rum.commonproperties.session.md | 19 +- docs/browser-rum.commonproperties.source.md | 9 +- ...browser-rum.commonproperties.synthetics.md | 19 +- docs/browser-rum.commonproperties.usr.md | 21 +- docs/browser-rum.commonproperties.version.md | 9 +- docs/browser-rum.commonproperties.view.md | 21 +- docs/browser-rum.datadogrum.md | 9 +- docs/browser-rum.md | 47 +-- docs/browser-rum.rumactionevent.md | 119 +++---- ...-rum.rumactioneventdomaincontext.events.md | 9 +- ...mactioneventdomaincontext.handlingstack.md | 9 +- ...browser-rum.rumactioneventdomaincontext.md | 15 +- docs/browser-rum.rumerrorevent.md | 167 +++++----- ...er-rum.rumerroreventdomaincontext.error.md | 9 +- ...umerroreventdomaincontext.handlingstack.md | 9 +- .../browser-rum.rumerroreventdomaincontext.md | 13 +- docs/browser-rum.rumevent.md | 11 +- docs/browser-rum.rumeventdomaincontext.md | 11 +- ...umfetchresourceeventdomaincontext.error.md | 9 +- ...esourceeventdomaincontext.handlingstack.md | 9 +- ...tchresourceeventdomaincontext.isaborted.md | 9 +- ...-rum.rumfetchresourceeventdomaincontext.md | 23 +- ...urceeventdomaincontext.performanceentry.md | 9 +- ...hresourceeventdomaincontext.requestinit.md | 9 +- ...resourceeventdomaincontext.requestinput.md | 9 +- ...etchresourceeventdomaincontext.response.md | 9 +- docs/browser-rum.rumglobal.addaction.md | 9 +- .../browser-rum.rumglobal.adddurationvital.md | 19 +- docs/browser-rum.rumglobal.adderror.md | 11 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 9 +- docs/browser-rum.rumglobal.addtiming.md | 9 +- docs/browser-rum.rumglobal.clearaccount.md | 9 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 11 +- docs/browser-rum.rumglobal.clearuser.md | 11 +- docs/browser-rum.rumglobal.getaccount.md | 9 +- .../browser-rum.rumglobal.getglobalcontext.md | 11 +- ...wser-rum.rumglobal.getinitconfiguration.md | 9 +- ...rowser-rum.rumglobal.getinternalcontext.md | 11 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 11 +- docs/browser-rum.rumglobal.getuser.md | 11 +- docs/browser-rum.rumglobal.getviewcontext.md | 9 +- docs/browser-rum.rumglobal.init.md | 9 +- docs/browser-rum.rumglobal.md | 171 +++++----- ...ser-rum.rumglobal.removeaccountproperty.md | 9 +- ...m.rumglobal.removeglobalcontextproperty.md | 11 +- ...rowser-rum.rumglobal.removeuserproperty.md | 11 +- docs/browser-rum.rumglobal.setaccount.md | 9 +- ...rowser-rum.rumglobal.setaccountproperty.md | 9 +- .../browser-rum.rumglobal.setglobalcontext.md | 9 +- ...-rum.rumglobal.setglobalcontextproperty.md | 9 +- ...rowser-rum.rumglobal.settrackingconsent.md | 9 +- docs/browser-rum.rumglobal.setuser.md | 17 +- docs/browser-rum.rumglobal.setuser_1.md | 9 +- docs/browser-rum.rumglobal.setuserproperty.md | 9 +- docs/browser-rum.rumglobal.setviewcontext.md | 9 +- ...er-rum.rumglobal.setviewcontextproperty.md | 9 +- docs/browser-rum.rumglobal.setviewname.md | 9 +- ...rowser-rum.rumglobal.startdurationvital.md | 15 +- ...m.rumglobal.startsessionreplayrecording.md | 11 +- docs/browser-rum.rumglobal.startview.md | 15 +- ...browser-rum.rumglobal.stopdurationvital.md | 15 +- docs/browser-rum.rumglobal.stopsession.md | 9 +- ...um.rumglobal.stopsessionreplayrecording.md | 11 +- ...uminitconfiguration.actionnameattribute.md | 11 +- ...ruminitconfiguration.allowedtracingurls.md | 11 +- ...-rum.ruminitconfiguration.applicationid.md | 9 +- ...ser-rum.ruminitconfiguration.beforesend.md | 11 +- ...nitconfiguration.compressintakerequests.md | 11 +- ...uminitconfiguration.defaultprivacylevel.md | 11 +- ...onfiguration.enableprivacyforactionname.md | 9 +- ...minitconfiguration.excludedactivityurls.md | 11 +- docs/browser-rum.ruminitconfiguration.md | 101 +++--- ...rowser-rum.ruminitconfiguration.plugins.md | 9 +- ...uminitconfiguration.profilingsamplerate.md | 11 +- ...initconfiguration.propagatetracebaggage.md | 11 +- ...initconfiguration.remoteconfigurationid.md | 9 +- ...itconfiguration.sessionreplaysamplerate.md | 11 +- ...ion.startsessionreplayrecordingmanually.md | 11 +- ...wser-rum.ruminitconfiguration.subdomain.md | 11 +- ...initconfiguration.tracecontextinjection.md | 11 +- ...um.ruminitconfiguration.tracesamplerate.md | 11 +- ...onfiguration.trackfeatureflagsforevents.md | 9 +- ...rum.ruminitconfiguration.tracklongtasks.md | 11 +- ...rum.ruminitconfiguration.trackresources.md | 11 +- ...initconfiguration.trackuserinteractions.md | 11 +- ...ruminitconfiguration.trackviewsmanually.md | 11 +- ...wser-rum.ruminitconfiguration.workerurl.md | 11 +- docs/browser-rum.rumlongtaskevent.md | 75 +++-- ...owser-rum.rumlongtaskeventdomaincontext.md | 11 +- ...taskeventdomaincontext.performanceentry.md | 9 +- ...-rum.rumotherresourceeventdomaincontext.md | 11 +- ...urceeventdomaincontext.performanceentry.md | 9 +- docs/browser-rum.rumresourceevent.md | 157 ++++----- docs/browser-rum.rumviewevent.md | 265 +++++++-------- ...-rum.rumvieweventdomaincontext.location.md | 9 +- docs/browser-rum.rumvieweventdomaincontext.md | 13 +- docs/browser-rum.rumvitalevent.md | 51 +-- ...esourceeventdomaincontext.handlingstack.md | 9 +- ...xhrresourceeventdomaincontext.isaborted.md | 9 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 17 +- ...urceeventdomaincontext.performanceentry.md | 9 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 9 +- docs/index.md | 17 +- etc/browser-logs.api.json | 14 +- etc/browser-rum-react.api.json | 8 +- package.json | 6 +- packages/logs/src/boot/logsPublicApi.ts | 13 +- packages/logs/src/domain/configuration.ts | 6 + packages/logs/src/domain/logger.ts | 13 +- .../logs/src/domain/logger/isAuthorized.ts | 3 + packages/logs/src/logsEvent.types.ts | 4 + .../src/domain/error/addReactError.ts | 8 +- .../src/domain/error/errorBoundary.ts | 7 +- .../performance/reactComponentTracker.tsx | 4 +- packages/rum-react/src/domain/reactPlugin.ts | 14 +- scripts/docs-jekyll.js | 66 ++++ scripts/fix-api-docs-final.js | 112 ------- 226 files changed, 3163 insertions(+), 1323 deletions(-) create mode 100644 .github/workflows/api-docs-release.yml delete mode 100644 .github/workflows/pages.yml create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config_docs.yml create mode 100644 scripts/docs-jekyll.js delete mode 100644 scripts/fix-api-docs-final.js diff --git a/.github/workflows/api-docs-release.yml b/.github/workflows/api-docs-release.yml new file mode 100644 index 0000000000..6162662bbc --- /dev/null +++ b/.github/workflows/api-docs-release.yml @@ -0,0 +1,71 @@ +name: Publish API Documentation on Release + +permissions: + contents: read + pages: write + id-token: write + +on: + push: + branches: + - romanG/api-reference + tags: + - 'v*.*.*' + workflow_dispatch: + +concurrency: + group: 'api-docs-release' + cancel-in-progress: false + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '18' + cache: 'yarn' + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.1' + bundler-cache: true + + - name: Install Node dependencies + run: yarn install --frozen-lockfile + + - name: Build TS declarations + run: yarn build + + - name: Build types and generate API docs + run: | + echo "Building API documentation for version ${{ steps.version.outputs.version }}" + yarn docs:api + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Build with Jekyll + run: | + bundle exec jekyll build --source docs --destination _site --config _config_docs.yml + env: + JEKYLL_ENV: production + PAGES_REPO_NWO: ${{ github.repository }} + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000000..57d615bc20 --- /dev/null +++ b/Gemfile @@ -0,0 +1,12 @@ +source "https://rubygems.org" + +gem "github-pages", group: :jekyll_plugins + +group :jekyll_plugins do + gem "jekyll-sitemap" + gem "jekyll-seo-tag" + gem "jekyll-relative-links" + gem "jekyll-remote-theme" +end + +gem "webrick", "~> 1.7" \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000000..40f8fa50c3 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,309 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (7.2.2.1) + base64 + benchmark (>= 0.3) + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + base64 (0.2.0) + benchmark (0.4.1) + bigdecimal (3.2.2) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.12.2) + colorator (1.1.0) + commonmarker (0.23.11) + concurrent-ruby (1.3.5) + connection_pool (2.5.3) + dnsruby (1.72.4) + base64 (~> 0.2.0) + logger (~> 1.6.5) + simpleidn (~> 0.2.1) + drb (2.2.3) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + ethon (0.16.0) + ffi (>= 1.15.0) + eventmachine (1.2.7) + execjs (2.10.0) + faraday (2.13.1) + faraday-net_http (>= 2.0, < 3.5) + json + logger + faraday-net_http (3.4.1) + net-http (>= 0.5.0) + ffi (1.17.2-aarch64-linux-gnu) + ffi (1.17.2-aarch64-linux-musl) + ffi (1.17.2-arm-linux-gnu) + ffi (1.17.2-arm-linux-musl) + ffi (1.17.2-arm64-darwin) + ffi (1.17.2-x86_64-darwin) + ffi (1.17.2-x86_64-linux-gnu) + ffi (1.17.2-x86_64-linux-musl) + forwardable-extended (2.6.0) + gemoji (4.1.0) + github-pages (230) + github-pages-health-check (= 1.18.2) + jekyll (= 3.9.5) + jekyll-avatar (= 0.8.0) + jekyll-coffeescript (= 1.2.2) + jekyll-commonmark-ghpages (= 0.4.0) + jekyll-default-layout (= 0.1.5) + jekyll-feed (= 0.17.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.16.1) + jekyll-include-cache (= 0.2.1) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.7.0) + jekyll-remote-theme (= 0.4.3) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.8.0) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.2.0) + jekyll-theme-cayman (= 0.2.0) + jekyll-theme-dinky (= 0.2.0) + jekyll-theme-hacker (= 0.2.0) + jekyll-theme-leap-day (= 0.2.0) + jekyll-theme-merlot (= 0.2.0) + jekyll-theme-midnight (= 0.2.0) + jekyll-theme-minimal (= 0.2.0) + jekyll-theme-modernist (= 0.2.0) + jekyll-theme-primer (= 0.6.0) + jekyll-theme-slate (= 0.2.0) + jekyll-theme-tactile (= 0.2.0) + jekyll-theme-time-machine (= 0.2.0) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.13.0) + kramdown (= 2.4.0) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.4) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.13.6, < 2.0) + rouge (= 3.30.0) + terminal-table (~> 1.4) + github-pages-health-check (1.18.2) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (>= 4, < 8) + public_suffix (>= 3.0, < 6.0) + typhoeus (~> 1.3) + html-pipeline (2.14.3) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.8.0) + i18n (1.14.7) + concurrent-ruby (~> 1.0) + jekyll (3.9.5) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (>= 0.7, < 2) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.8.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.2.2) + coffee-script (~> 2.2) + coffee-script-source (~> 1.12) + jekyll-commonmark (1.4.0) + commonmarker (~> 0.22) + jekyll-commonmark-ghpages (0.4.0) + commonmarker (~> 0.23.7) + jekyll (~> 3.9.0) + jekyll-commonmark (~> 1.4.0) + rouge (>= 2.0, < 5.0) + jekyll-default-layout (0.1.5) + jekyll (>= 3.0, < 5.0) + jekyll-feed (0.17.0) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.16.1) + jekyll (>= 3.4, < 5.0) + octokit (>= 4, < 7, != 4.4.0) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.7.0) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.6.0) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.13.0) + gemoji (>= 3, < 5) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + json (2.12.2) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + logger (1.6.6) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.25.5) + net-http (0.6.0) + uri + nokogiri (1.18.8-aarch64-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.8-aarch64-linux-musl) + racc (~> 1.4) + nokogiri (1.18.8-arm-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.8-arm-linux-musl) + racc (~> 1.4) + nokogiri (1.18.8-arm64-darwin) + racc (~> 1.4) + nokogiri (1.18.8-x86_64-darwin) + racc (~> 1.4) + nokogiri (1.18.8-x86_64-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.8-x86_64-linux-musl) + racc (~> 1.4) + octokit (4.25.1) + faraday (>= 1, < 3) + sawyer (~> 0.9) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (5.1.1) + racc (1.8.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rexml (3.4.1) + rouge (3.30.0) + rubyzip (2.4.1) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.9.2) + addressable (>= 2.3.5) + faraday (>= 0.17.3, < 3) + securerandom (0.4.1) + simpleidn (0.2.3) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + typhoeus (1.4.1) + ethon (>= 0.9.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (1.8.0) + uri (1.0.3) + webrick (1.9.1) + +PLATFORMS + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-gnu + arm-linux-musl + arm64-darwin + x86_64-darwin + x86_64-linux-gnu + x86_64-linux-musl + +DEPENDENCIES + github-pages + jekyll-relative-links + jekyll-remote-theme + jekyll-seo-tag + jekyll-sitemap + webrick (~> 1.7) + +BUNDLED WITH + 2.6.9 diff --git a/_config_docs.yml b/_config_docs.yml new file mode 100644 index 0000000000..cdc88fbb89 --- /dev/null +++ b/_config_docs.yml @@ -0,0 +1,33 @@ + +title: "Datadog Browser SDK Docs" +description: "API documentation for the Datadog Browser SDK." + +url: "https://datadoghq.dev" +baseurl: "/browser-sdk" + + +remote_theme: "just-the-docs/just-the-docs" + +just_the_docs: + search_enabled: true + nav_depth: 2 + +plugins: + - jekyll-remote-theme + - jekyll-seo-tag + - jekyll-sitemap + - jekyll-relative-links + +exclude: + - node_modules/ + - vendor/ + - Gemfile* + - package*.json + - yarn.lock + - _site/ + +defaults: + - scope: + path: "" + values: + layout: "default" diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index ef093d8344..1484f0f44f 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "datadogLogs variable" +nav_order: 207 +permalink: /browser-logs.datadoglogs.html +--- + -Home > @datadog/browser-logs > datadogLogs +Home > @datadog/browser-logs > datadogLogs ## datadogLogs variable diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index cbad0ad967..b46b306e33 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,15 +1,24 @@ +--- +layout: default +title: "HandlerType variable" +nav_order: 206 +permalink: /browser-logs.handlertype.html +--- + -Home > @datadog/browser-logs > HandlerType +Home > @datadog/browser-logs > HandlerType ## HandlerType variable +Defines the types of handlers for processing logs: console, HTTP, or silent. + **Signature:** ```typescript HandlerType: { - readonly console: "console"; - readonly http: "http"; - readonly silent: "silent"; + readonly console: "console"; + readonly http: "http"; + readonly silent: "silent"; } ``` diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index c1d8528bb8..7483d7fb90 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.(constructor)" +nav_order: 205 +permalink: /browser-logs.logger._constructor_.html +--- + -Home > @datadog/browser-logs > Logger > (constructor) +Home > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -37,7 +44,7 @@ handleLogStrategy diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 1f309bfbaa..7e95126b6f 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "LogsInitConfiguration.usePciIntake property" +nav_order: 136 +permalink: /browser-logs.logsinitconfiguration.usepciintake.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake +Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property -Use PCI-compliant intake. See PCI DSS Compliance for further information. false +Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false **Signature:** diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 2b025ba6d5..2149fec220 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsMessage.context property" +nav_order: 135 +permalink: /browser-logs.logsmessage.context.html +--- + -Home > @datadog/browser-logs > LogsMessage > context +Home > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 7892477a42..a66be457a3 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsMessage interface" +nav_order: 134 +permalink: /browser-logs.logsmessage.html +--- + -Home > @datadog/browser-logs > LogsMessage +Home > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -37,7 +44,7 @@ Description
+ @@ -61,3 +65,5 @@ ReactPluginConfiguration { name: string; onInit({ publicApi, initConfiguration }: { initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; publicApi: RumPublicApi; }): void; onRumStart({ strategy }: { strategy: Strategy; }): void; getConfigurationTelemetry(): { router: boolean; }; } +A RUM plugin instance to include in the SDK init. + diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 080a753230..184a68fff4 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -4,6 +4,8 @@ ## UNSTABLE_ReactComponentTracker variable +Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`. + **Signature:** ```typescript diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 47fff1e4e9..45330f2515 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -37,7 +37,7 @@ Schema of common properties of RUM events @@ -48,7 +48,7 @@ Additional information available when the SDK dispatches a RUM \*\*Action\*\* ev @@ -59,7 +59,7 @@ Additional information available when the SDK dispatches an \*\*Error\*\* event. @@ -92,7 +92,7 @@ Configuration options to pass to the `init()` method when initializing the RUM S @@ -103,7 +103,7 @@ Additional information available when the SDK dispatches a \*\*Long Task\*\* eve @@ -114,7 +114,7 @@ Additional information available when the SDK dispatches a \*\*Resource\*\* even @@ -125,7 +125,7 @@ Additional information available when the SDK dispatches a RUM \*\*View\*\* even diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 090559196c..e7eb94c577 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -4,7 +4,7 @@ ## RumActionEventDomainContext interface -Additional information available when the SDK dispatches a RUM \*\*Action\*\* event. +Additional information available when the SDK dispatches a RUM Action event. **Signature:** diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 3074a67321..9c50c3762e 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -4,7 +4,7 @@ ## RumErrorEventDomainContext interface -Additional information available when the SDK dispatches an \*\*Error\*\* event. +Additional information available when the SDK dispatches an Error event. **Signature:** diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index f467b35c6e..0d303e091e 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -4,7 +4,7 @@ ## RumFetchResourceEventDomainContext interface -Additional information available when the SDK dispatches a \*\*Fetch\*\* resource event. +Additional information available when the SDK dispatches a Fetch resource event. **Signature:** diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index a2a9eb756c..e36cf0224e 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -4,7 +4,7 @@ ## RumLongTaskEventDomainContext interface -Additional information available when the SDK dispatches a \*\*Long Task\*\* event. +Additional information available when the SDK dispatches a Long Task event. **Signature:** diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index b00f68d864..0a9fbbfa2d 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -4,7 +4,7 @@ ## RumOtherResourceEventDomainContext interface -Additional information available when the SDK dispatches a \*\*Resource\*\* event that is neither fetch nor XHR. +Additional information available when the SDK dispatches a Resource event that is neither fetch nor XHR. **Signature:** diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 566ba8ae49..0701dabef9 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -4,7 +4,7 @@ ## RumViewEventDomainContext interface -Additional information available when the SDK dispatches a RUM \*\*View\*\* event. +Additional information available when the SDK dispatches a RUM View event. **Signature:** diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index d37e01623a..03760fc503 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -4,7 +4,7 @@ ## RumXhrResourceEventDomainContext interface -Additional information available when the SDK dispatches an \*\*XHR\*\* resource event. +Additional information available when the SDK dispatches an XHR resource event. **Signature:** diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 3d8ca9520f..0000000000 --- a/docs/index.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - Datadog Browser SDKs - API Documentation - - - -
-
-

Datadog Browser SDKs

-

API Reference Documentation

-
-
- -
-
-
-

Welcome to Datadog Browser SDKs Documentation

-

- This documentation provides a comprehensive API reference for all Datadog Browser SDKs. - Choose a package below to explore its API: -

-
    -
  • RUM (Real User Monitoring) - Monitor and analyze the real-time performance and user experience of your web application
    • -
  • Logs - Collect and analyze browser logs in real-time
    • -
  • Session Replay - Record and replay user sessions to understand user behavior
    • -
-
- -
-
-
-

@datadog/browser-rum

-

- Full RUM SDK with Session Replay and Real User Profiling capabilities. - Monitor your web application's performance and user experience. -

-
- View API Documentation -
-
- -
-

@datadog/browser-rum-slim

-

- Lightweight version of the RUM SDK without Session Replay. - Ideal for performance-sensitive applications. -

-
- View API Documentation -
-
- -
-

@datadog/browser-logs

-

- Browser logs collection SDK. - Collect, process, and analyze logs from your web applications. -

-
- View API Documentation -
-
- -
-

@datadog/browser-rum-react

-

- React-specific integrations for the RUM SDK. - Includes React error boundaries and component tracking. -

-
- View API Documentation -
-
-
-
-
-
- - - - \ No newline at end of file diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json index 845b586288..300e8c9a2e 100644 --- a/etc/browser-logs.api.json +++ b/etc/browser-logs.api.json @@ -1037,7 +1037,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!Logger:interface", - "docComment": "", + "docComment": "/**\n * Set of convenience methods for each supported log level.\n *\n * All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1052,7 +1052,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#alert:member(1)", - "docComment": "", + "docComment": "/**\n * Add an ALERT log (action must be taken immediately).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1130,7 +1130,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#critical:member(1)", - "docComment": "", + "docComment": "/**\n * Add a CRITICAL log (serious failure).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1208,7 +1208,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#debug:member(1)", - "docComment": "", + "docComment": "/**\n * Add a DEBUG log (developer usage).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1286,7 +1286,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#emerg:member(1)", - "docComment": "", + "docComment": "/**\n * Add an EMERGENCY log (system is unusable).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1364,7 +1364,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#error:member(1)", - "docComment": "", + "docComment": "/**\n * Add an ERROR log (runtime error).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1442,7 +1442,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#info:member(1)", - "docComment": "", + "docComment": "/**\n * Add an INFO log (notable but expected).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1520,7 +1520,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#notice:member(1)", - "docComment": "", + "docComment": "/**\n * Add a NOTICE log (normal but significant).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1598,7 +1598,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#ok:member(1)", - "docComment": "", + "docComment": "/**\n * Add an OK log (success).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1676,7 +1676,7 @@ { "kind": "MethodSignature", "canonicalReference": "@datadog/browser-logs!Logger#warn:member(1)", - "docComment": "", + "docComment": "/**\n * Add a WARN log (unexpected behaviour).\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3350,7 +3350,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!LogsMessage:interface", - "docComment": "", + "docComment": "/**\n * Structure passed to the internal log handling strategy.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3365,7 +3365,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-logs!LogsMessage#context:member", - "docComment": "", + "docComment": "/**\n * Optional context attached to the log\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3393,7 +3393,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-logs!LogsMessage#message:member", - "docComment": "", + "docComment": "/**\n * Raw message provided by the customer\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3420,7 +3420,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-logs!LogsMessage#status:member", - "docComment": "", + "docComment": "/**\n * Severity of the log\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json index b5dcc2ad6f..1a5ac137a3 100644 --- a/etc/browser-rum-react.api.json +++ b/etc/browser-rum-react.api.json @@ -175,7 +175,7 @@ { "kind": "Function", "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", - "docComment": "", + "docComment": "/**\n * Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the {@link ErrorBoundary} component or React's error lifecycle.\n *\n * @param error - The JavaScript `Error` instance thrown by React.\n *\n * @param info - Additional React error information, including the component stack.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -238,7 +238,7 @@ { "kind": "Class", "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", - "docComment": "", + "docComment": "/**\n * Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught.\n *\n * @extends React.Component\n */\n", "excerptTokens": [ { "kind": "Content", @@ -503,7 +503,7 @@ { "kind": "Function", "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", - "docComment": "", + "docComment": "/**\n * Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }).\n *\n * The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM *Error* events) - Optional react-router view tracking - Component performance tracking utilities (see {@link UNSTABLE_ReactComponentTracker}).\n *\n * @param configuration - React plugin specific configuration.\n *\n * @returns A RUM plugin instance to include in the SDK init.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -576,7 +576,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", - "docComment": "", + "docComment": "/**\n * Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`.\n *\n * @experimental\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index 377856ad0f..b1f9c8a9b9 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -814,7 +814,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches a RUM **Action** event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches a RUM Action event.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -940,7 +940,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches an **Error** event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches an Error event.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1266,7 +1266,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches a **Fetch** resource event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches a Fetch resource event.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3398,7 +3398,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches a **Long Task** event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches a Long Task event.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3444,7 +3444,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches a Resource event that is neither fetch nor XHR.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3615,7 +3615,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches a RUM **View** event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches a RUM View event.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3714,7 +3714,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", - "docComment": "/**\n * Additional information available when the SDK dispatches an **XHR** resource event.\n */\n", + "docComment": "/**\n * Additional information available when the SDK dispatches an XHR resource event.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/packages/logs/src/boot/logsPublicApi.ts b/packages/logs/src/boot/logsPublicApi.ts index 35584855e8..4964a460b2 100644 --- a/packages/logs/src/boot/logsPublicApi.ts +++ b/packages/logs/src/boot/logsPublicApi.ts @@ -20,6 +20,7 @@ import type { InternalContext } from '../domain/contexts/internalContext' import type { StartLogs, StartLogsResult } from './startLogs' import { createPreStartStrategy } from './preStartLogs' +// export interface LoggerConfiguration { level?: StatusType handler?: HandlerType | HandlerType[] diff --git a/packages/logs/src/domain/logger.ts b/packages/logs/src/domain/logger.ts index 8efbe115e7..d7e45f04db 100644 --- a/packages/logs/src/domain/logger.ts +++ b/packages/logs/src/domain/logger.ts @@ -15,9 +15,17 @@ import { import { isAuthorized, StatusType } from './logger/isAuthorized' import { createErrorFieldFromRawError } from './createErrorFieldFromRawError' +/** + * Structure passed to the internal log handling strategy. + * + * @public + */ export interface LogsMessage { + /** Raw message provided by the customer */ message: string + /** Severity of the log */ status: StatusType + /** Optional context attached to the log */ context?: Context } @@ -149,17 +157,35 @@ Logger.prototype.alert = createLoggerMethod(StatusType.alert) Logger.prototype.emerg = createLoggerMethod(StatusType.emerg) /* eslint-enable local-rules/disallow-side-effects */ -// note: it is safe to merge declarations as long as the methods are actually defined on the prototype +/** + * Set of convenience methods for each supported log level. + * + * All methods accept the same parameters: + * `message`: human-readable log text. + * `messageContext`: optional JSON-serialisable object merged with the log context. + * `error`: optional `Error` instance captured with the log. + * + * @public + */ // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging export interface Logger { + /** Add an OK log (success). */ ok(message: string, messageContext?: object, error?: Error): void + /** Add a DEBUG log (developer usage). */ debug(message: string, messageContext?: object, error?: Error): void + /** Add an INFO log (notable but expected). */ info(message: string, messageContext?: object, error?: Error): void + /** Add a NOTICE log (normal but significant). */ notice(message: string, messageContext?: object, error?: Error): void + /** Add a WARN log (unexpected behaviour). */ warn(message: string, messageContext?: object, error?: Error): void + /** Add an ERROR log (runtime error). */ error(message: string, messageContext?: object, error?: Error): void + /** Add a CRITICAL log (serious failure). */ critical(message: string, messageContext?: object, error?: Error): void + /** Add an ALERT log (action must be taken immediately). */ alert(message: string, messageContext?: object, error?: Error): void + /** Add an EMERGENCY log (system is unusable). */ emerg(message: string, messageContext?: object, error?: Error): void } diff --git a/packages/rum-core/src/domainContext.types.ts b/packages/rum-core/src/domainContext.types.ts index 12213570b8..f5a861df56 100644 --- a/packages/rum-core/src/domainContext.types.ts +++ b/packages/rum-core/src/domainContext.types.ts @@ -22,7 +22,7 @@ export type RumEventDomainContext = T extends RumE : never /** - * Additional information available when the SDK dispatches a RUM **View** event. + * Additional information available when the SDK dispatches a RUM View event. */ export interface RumViewEventDomainContext { /** @@ -32,7 +32,7 @@ export interface RumViewEventDomainContext { } /** - * Additional information available when the SDK dispatches a RUM **Action** event. + * Additional information available when the SDK dispatches a RUM Action event. */ export interface RumActionEventDomainContext { /** @@ -46,7 +46,7 @@ export interface RumActionEventDomainContext { } /** - * Additional information available when the SDK dispatches a **Fetch** resource event. + * Additional information available when the SDK dispatches a Fetch resource event. */ export interface RumFetchResourceEventDomainContext { /** @@ -80,7 +80,7 @@ export interface RumFetchResourceEventDomainContext { } /** - * Additional information available when the SDK dispatches an **XHR** resource event. + * Additional information available when the SDK dispatches an XHR resource event. */ export interface RumXhrResourceEventDomainContext { /** @@ -102,7 +102,7 @@ export interface RumXhrResourceEventDomainContext { } /** - * Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR. + * Additional information available when the SDK dispatches a Resource event that is neither fetch nor XHR. */ export interface RumOtherResourceEventDomainContext { /** @@ -112,7 +112,7 @@ export interface RumOtherResourceEventDomainContext { } /** - * Additional information available when the SDK dispatches an **Error** event. + * Additional information available when the SDK dispatches an Error event. */ export interface RumErrorEventDomainContext { /** @@ -126,7 +126,7 @@ export interface RumErrorEventDomainContext { } /** - * Additional information available when the SDK dispatches a **Long Task** event. + * Additional information available when the SDK dispatches a Long Task event. */ export interface RumLongTaskEventDomainContext { /** @@ -136,6 +136,6 @@ export interface RumLongTaskEventDomainContext { } /** - * Additional information available when the SDK dispatches a **Vital** event. + * Additional information available when the SDK dispatches a Vital event. */ export type RumVitalEventDomainContext = Record diff --git a/packages/rum-react/src/domain/error/addReactError.ts b/packages/rum-react/src/domain/error/addReactError.ts index 2930aa4571..17d395baf5 100644 --- a/packages/rum-react/src/domain/error/addReactError.ts +++ b/packages/rum-react/src/domain/error/addReactError.ts @@ -2,6 +2,14 @@ import type { ErrorInfo } from 'react' import { callMonitored, clocksNow, createHandlingStack } from '@datadog/browser-core' import { onRumStart } from '../reactPlugin' +/** + * Report an error originating from React (Error Boundary or `componentDidCatch`) + * to Datadog RUM. This helper should not be called directly; prefer to use the + * {@link ErrorBoundary} component or React's error lifecycle. + * + * @param error The JavaScript `Error` instance thrown by React. + * @param info Additional React error information, including the component stack. + */ export function addReactError(error: Error, info: ErrorInfo) { const handlingStack = createHandlingStack('react error') const startClocks = clocksNow() diff --git a/packages/rum-react/src/domain/error/errorBoundary.ts b/packages/rum-react/src/domain/error/errorBoundary.ts index 920a565fbc..9aa591d695 100644 --- a/packages/rum-react/src/domain/error/errorBoundary.ts +++ b/packages/rum-react/src/domain/error/errorBoundary.ts @@ -2,11 +2,24 @@ import React from 'react' import type { ErrorInfo } from 'react' import { addReactError } from './addReactError' +/** + * React Error Boundary that captures uncaught errors thrown by its children + * and reports them as RUM *Error* events. + * + * @public + */ interface Props { + /** React component rendered when an error is caught. */ fallback: Fallback + /** Elements to render inside the boundary. */ children: React.ReactNode } +/** + * Signature of the fallback component rendered by {@link ErrorBoundary} when an + * error occurs. + * + */ export type Fallback = React.ComponentType<{ error: Error; resetError: () => void }> type State = @@ -21,6 +34,13 @@ type State = const INITIAL_STATE: State = { didCatch: false, error: null } +/** + * Error Boundary component used to capture runtime errors in the React tree + * below and report them to Datadog RUM. It renders the `fallback` component + * when an error is caught. + * + * @extends React.Component + */ // eslint-disable-next-line no-restricted-syntax export class ErrorBoundary extends React.Component { constructor(props: Props) { diff --git a/packages/rum-react/src/domain/performance/reactComponentTracker.tsx b/packages/rum-react/src/domain/performance/reactComponentTracker.tsx index a070e01ff9..1fa4496eb0 100644 --- a/packages/rum-react/src/domain/performance/reactComponentTracker.tsx +++ b/packages/rum-react/src/domain/performance/reactComponentTracker.tsx @@ -2,6 +2,12 @@ import * as React from 'react' import { createTimer } from './timer' import { addDurationVital } from './addDurationVital' +/** + * Experimental component that measures the render lifecycle of its children + * and reports a duration vital named `reactComponentRender`. + * + * @experimental + */ // eslint-disable-next-line export const UNSTABLE_ReactComponentTracker = ({ name: componentName, diff --git a/packages/rum-react/src/domain/reactPlugin.ts b/packages/rum-react/src/domain/reactPlugin.ts index a35c122240..b1b075478c 100644 --- a/packages/rum-react/src/domain/reactPlugin.ts +++ b/packages/rum-react/src/domain/reactPlugin.ts @@ -9,13 +9,33 @@ type StartSubscriber = (strategy: Strategy) => void const onRumInitSubscribers: InitSubscriber[] = [] const onRumStartSubscribers: StartSubscriber[] = [] +/** + * Configuration options for the React integration plugin. + * + * @public + */ export interface ReactPluginConfiguration { /** - * Enable react-router integration + * Enable react-router integration (v6+). When set, the underlying RUM SDK + * will switch to manual view tracking so that view updates follow your SPA + * routing logic. */ router?: boolean } +/** + * Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). + * + * The plugin wires React-specific features such as: + * - ErrorBoundary integration (errors forwarded as RUM *Error* events) + * - Optional react-router view tracking + * - Component performance tracking utilities (see {@link UNSTABLE_ReactComponentTracker}). + * + * + * @param configuration React plugin specific configuration. + * @returns A RUM plugin instance to include in the SDK init. + * @public + */ export function reactPlugin(configuration: ReactPluginConfiguration = {}) { return { name: 'react', diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js index fcea981ef2..02408dc461 100644 --- a/scripts/fix-api-docs-final.js +++ b/scripts/fix-api-docs-final.js @@ -68,6 +68,14 @@ function fixBackslashes(content) { return content } +function dedupClosingTableTags(content) { + // Keep a single occurrence of closing tags to prevent malformed tables while + // avoiding duplicated tags sometimes produced by api-documenter. + content = content.replace(/(<\/tbody><\/table>\s*){2,}/g, '
Parameter diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 972a0ae9f2..4049486fe7 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method @@ -19,7 +55,7 @@ setUser(newUser: User): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 1165900244..aa8361c378 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 95f2670ab2..d1abd2395b 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 19adf5c441..6c7fc4e446 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 5077efb0d9..c1651b39ac 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 58a2ff805c..e4b2657d95 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 8cb1159886..5c810cbd56 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index efddb37e3a..8362acf615 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 40272a366e..19d035a551 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 776655c5cf..c1f6725131 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index fac27e9aa0..8a5d80d1f3 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 1e48a2c7ef..24d0776c41 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 7804d4d183..902c96f39e 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index b93cb36c87..1630d35e28 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 40e6814128..8551f0f6b1 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 3413d6cb14..82aa85f11b 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index d82ab6acac..6ac527658a 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 71a0cbe060..ac0e816435 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index af9c9bf573..d98769ed01 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index f4ec74019b..f9533280c4 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface @@ -13,7 +49,7 @@ export interface RumInitConfiguration extends InitConfiguration ## Properties -
+
Property @@ -179,7 +215,7 @@ boolean \| undefined -MatchOption\[\] \| undefined +MatchOption[] \| undefined @@ -198,7 +234,7 @@ MatchOption\[\] \| undefined -RumPlugin\[\] \| undefined +RumPlugin[] \| undefined @@ -369,7 +405,7 @@ number \| undefined -FeatureFlagsForEvents\[\] +FeatureFlagsForEvents[] diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 1e521d1a29..0325d7eb11 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index c08a3537d5..d486933709 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 42f57c809a..9339b96952 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 925f00267a..201fd4c12a 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 0057df27ea..6b3e70f9a2 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 427130229c..83c47a1ccc 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index ed3d388410..3233dcbb51 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index b5593bdb99..0ab85a0c05 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index f509245641..e4c8e7214c 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 11f8345f45..a9cb2c3a7a 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 8b2b7a0f5f..07b36ec1aa 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 9c05a1120b..a8590de9d9 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index 198c9f2565..6a7b734d81 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index d028a6d8ac..0d9cb8b436 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index fdb93f3581..48d51d6d8d 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 4bec40e6c7..ca5786ed10 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 47e7b1500f..b1519d9ee4 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumLongTaskEventDomainContext ## Properties -
+ +
Property @@ -46,8 +82,5 @@ Description PerformanceEntry - - - -
Browser performance entry for this long task.
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 71f23621a5..d35217a915 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 316fd6bedf..fbd80ab475 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumOtherResourceEventDomainContext ## Properties - @@ -67,6 +69,8 @@ string
+ +
Property @@ -46,8 +82,5 @@ Description PerformanceEntry - - - -
Browser performance entry for this resource.
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 6bc0840e08..46157836e6 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 20eb3f5607..29b3f23e19 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 14076df1df..39484b059f 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumViewEvent ## RumViewEvent type diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 084978dfb8..cbeeb703d4 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index f2d51a2686..703b2b07ea 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumViewEventDomainContext ## Properties -`) - currentRow = [] - } - fixedLines.push(lines[i]) - inTable = false - continue - } - - if (inTable) { - if ( - line === '' || - line === '' || - line === '' || - line === '' || - line === '' - ) { - continue - } - - if (line.startsWith('') || line.includes('') || line.includes('')) { - if (currentRow.length > 0) { - fixedLines.push(`${currentRow.join(' ')}`) - currentRow = [] - } - fixedLines.push(lines[i]) - } else if (line.startsWith('`) - } - - return fixedLines.join('\n') + return content } function cleanupSpacing(content) { From 0a87d0b03687979d72b2a88f256de438a801f01a Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Thu, 12 Jun 2025 17:07:39 +0200 Subject: [PATCH 20/21] change --- docs/browser-logs.logger.alert.md | 2 + docs/browser-logs.logger.critical.md | 2 + docs/browser-logs.logger.debug.md | 2 + docs/browser-logs.logger.emerg.md | 2 + docs/browser-logs.logger.error.md | 2 + docs/browser-logs.logger.info.md | 2 + docs/browser-logs.logger.md | 22 ++ docs/browser-logs.logger.notice.md | 2 + docs/browser-logs.logger.ok.md | 2 + docs/browser-logs.logger.warn.md | 2 + docs/browser-logs.logsmessage.context.md | 2 + docs/browser-logs.logsmessage.md | 8 +- docs/browser-logs.logsmessage.message.md | 2 + docs/browser-logs.logsmessage.status.md | 2 + docs/browser-logs.md | 6 + docs/browser-rum-react.addreacterror.md | 6 + docs/browser-rum-react.errorboundary.md | 4 + docs/browser-rum-react.md | 12 + docs/browser-rum-react.reactplugin.md | 8 +- ...um-react.unstable_reactcomponenttracker.md | 2 + docs/browser-rum.md | 14 +- ...browser-rum.rumactioneventdomaincontext.md | 2 +- .../browser-rum.rumerroreventdomaincontext.md | 2 +- ...-rum.rumfetchresourceeventdomaincontext.md | 2 +- ...owser-rum.rumlongtaskeventdomaincontext.md | 2 +- ...-rum.rumotherresourceeventdomaincontext.md | 2 +- docs/browser-rum.rumvieweventdomaincontext.md | 2 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 2 +- docs/index.html | 236 ------------------ etc/browser-logs.api.json | 28 +-- etc/browser-rum-react.api.json | 8 +- etc/browser-rum.api.json | 14 +- packages/logs/src/boot/logsPublicApi.ts | 1 + packages/logs/src/domain/logger.ts | 28 ++- packages/rum-core/src/domainContext.types.ts | 16 +- .../src/domain/error/addReactError.ts | 8 + .../src/domain/error/errorBoundary.ts | 20 ++ .../performance/reactComponentTracker.tsx | 6 + packages/rum-react/src/domain/reactPlugin.ts | 22 +- scripts/fix-api-docs-final.js | 9 + 40 files changed, 229 insertions(+), 287 deletions(-) delete mode 100644 docs/index.html diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index a0539e0a4c..2b2c3c7a94 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -4,6 +4,8 @@ ## Logger.alert() method +Add an ALERT log (action must be taken immediately). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index a186625918..eb915d8715 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -4,6 +4,8 @@ ## Logger.critical() method +Add a CRITICAL log (serious failure). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 45f99c39ed..01901a51d3 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -4,6 +4,8 @@ ## Logger.debug() method +Add a DEBUG log (developer usage). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index dd9400ed1a..aca5c175ed 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -4,6 +4,8 @@ ## Logger.emerg() method +Add an EMERGENCY log (system is unusable). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 77f28262f4..5ce44d8b73 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -4,6 +4,8 @@ ## Logger.error() method +Add an ERROR log (runtime error). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index 87d6fb3506..dd511cc4e6 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -4,6 +4,8 @@ ## Logger.info() method +Add an INFO log (notable but expected). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 04a0bc6313..12ea1b5190 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -4,6 +4,10 @@ ## Logger interface +Set of convenience methods for each supported log level. + +All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log. + **Signature:** ```typescript @@ -30,6 +34,8 @@ Description
+ +
Property @@ -46,8 +82,5 @@ Description Readonly<Location> - - - -
The browser location object at the time the view was created.
diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 95c1c41d20..219cd703f1 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index c3c3e7c215..67bf2dd9ec 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 1da2a404dc..19441d8838 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 23ec8cab4f..49fed177bc 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface @@ -12,7 +48,7 @@ export interface RumXhrResourceEventDomainContext ## Properties -
+ + + + +
Property @@ -46,12 +82,7 @@ Description string - - -(Optional) - - -
Stack trace of where the resource was handled by the SDK. (Optional)
isAborted @@ -65,10 +96,7 @@ string boolean - - - -
Whether the XHR request was aborted.
performanceEntry? @@ -82,12 +110,7 @@ boolean PerformanceEntry - - -(Optional) - - -
Browser performance entry for this resource. (Optional)
xhr @@ -101,8 +124,5 @@ PerformanceEntry XMLHttpRequest - - - -
The XMLHttpRequest object that made the request.
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 23288a5767..d0b245545c 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 7a02ed5a6c..989f00bd05 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,5 +1,41 @@ - - + + + + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property diff --git a/docs/index.md b/docs/index.md index 752a2b7655..1000736c36 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,48 @@ - - + + + + + Home ## API Reference ## Packages -
+`, + 'i' + ) + + content = content.replace(propPattern, (match, _type) => { + const isOptional = match.includes('?') || match.includes('Optional') + const desc = isOptional ? `${propDesc} (Optional)` : propDesc + return match.replace(/`) + }) + } + } + + return content +} + +function processDocFile(file) { + console.log(`Processing: ${file}`) + + let content = fs.readFileSync(file, 'utf8') + const fileName = path.basename(file) + + // Applique toutes les transformations + content = cleanupStyles(content) + content = fixArrayTypes(content) + content = convertMarkdownLinks(content) + content = enhanceDescriptions(content, fileName) + + // Améliore les tableaux + content = content.replace(/
Package diff --git a/package.json b/package.json index 9c94f1c27f..958c269aa3 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "size": "node scripts/show-bundle-size.js", "woke": "scripts/cli woke", "build:types": "lerna run build:esm --stream", - "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs && node scripts/fix-doc-links.js" + "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs && node scripts/fix-api-docs-final.js" }, "devDependencies": { "@eslint/js": "9.26.0", diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js new file mode 100644 index 0000000000..2aa448f419 --- /dev/null +++ b/scripts/fix-api-docs-final.js @@ -0,0 +1,216 @@ +const fs = require('fs') +const path = require('path') +const { globSync } = require('glob') + +const TYPE_DESCRIPTIONS = { + RumActionEventDomainContext: { + main: 'Additional information available when the SDK dispatches a RUM **Action** event.', + properties: { + events: 'DOM events that triggered this action.', + handlingStack: 'Stack trace of where the action was handled by the SDK.', + }, + }, + RumViewEventDomainContext: { + main: 'Additional information available when the SDK dispatches a RUM **View** event.', + properties: { + location: 'The browser location object at the time the view was created.', + }, + }, + RumFetchResourceEventDomainContext: { + main: 'Additional information available when the SDK dispatches a **Fetch** resource event.', + properties: { + requestInit: 'Init object passed to the fetch call.', + requestInput: 'Input parameter passed to the fetch call.', + response: 'Response object returned by the fetch call.', + error: 'Error that occurred during the fetch call.', + performanceEntry: 'Browser performance entry for this resource.', + isAborted: 'Whether the fetch call was aborted.', + handlingStack: 'Stack trace of where the resource was handled by the SDK.', + }, + }, + RumXhrResourceEventDomainContext: { + main: 'Additional information available when the SDK dispatches an **XHR** resource event.', + properties: { + xhr: 'The XMLHttpRequest object that made the request.', + performanceEntry: 'Browser performance entry for this resource.', + isAborted: 'Whether the XHR request was aborted.', + handlingStack: 'Stack trace of where the resource was handled by the SDK.', + }, + }, + RumOtherResourceEventDomainContext: { + main: 'Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR.', + properties: { + performanceEntry: 'Browser performance entry for this resource.', + }, + }, + RumErrorEventDomainContext: { + main: 'Additional information available when the SDK dispatches an **Error** event.', + properties: { + error: 'The original error object that was captured.', + handlingStack: 'Stack trace of where the error was handled by the SDK.', + }, + }, + RumLongTaskEventDomainContext: { + main: 'Additional information available when the SDK dispatches a **Long Task** event.', + properties: { + performanceEntry: 'Browser performance entry for this long task.', + }, + }, +} + +function cleanupStyles(content) { + // Supprime tous les blocs de styles existants + content = content.replace(/[\s\S]*?<\/style>\s*/g, '') + + // Ajoute un seul bloc de styles au début + const styleBlock = ` + + + +` + + // Ajoute le style après le commentaire de non-édition + if (content.includes('', + `${styleBlock}` + ) + } + + return content +} + +function fixArrayTypes(content) { + // Corrige les types de tableaux avec backslashes + return content.replace(/(\w+)\\\[\\]/g, '$1[]') +} + +function convertMarkdownLinks(content) { + // Convertit les liens markdown en HTML + return content.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => { + let newUrl = url + if (url.endsWith('.md')) { + newUrl = url.replace(/\.md$/, '.html') + } + return `${text}` + }) +} + +function enhanceDescriptions(content, fileName) { + // Extrait le nom du type depuis le nom du fichier + let typeName = null + + // Cherche le nom du type dans TYPE_DESCRIPTIONS + for (const type of Object.keys(TYPE_DESCRIPTIONS)) { + if (fileName.includes(type.toLowerCase())) { + typeName = type + break + } + } + + if (!typeName || !TYPE_DESCRIPTIONS[typeName]) { + return content + } + + console.log(` Enhancing ${typeName}`) + + // Ajoute la description principale de l'interface + const mainDescPattern = new RegExp(`## ${typeName} interface\\s*\\n\\n`, 'i') + const typeInfo = TYPE_DESCRIPTIONS[typeName] + + if (typeInfo.main) { + content = content.replace(mainDescPattern, (match) => `${match}${typeInfo.main}\n\n`) + } + + // Améliore les descriptions des propriétés + if (typeInfo.properties) { + // Pour chaque propriété connue + for (const [propName, propDesc] of Object.entries(typeInfo.properties)) { + // Pattern plus simple pour trouver la propriété dans le tableau + const propPattern = new RegExp( + `${propName}\\??\\s*\\s*\\s*([^<]+)\\s*\\s*(?:\\(Optional\\))?\\s*\s*(?:\(Optional\))?\s*<\/td>$/, `${desc}
/g, '
') + + fs.writeFileSync(file, content, 'utf8') +} + +function runMain() { + const docsDir = path.join(__dirname, '..', 'docs') + const docFiles = globSync(`${docsDir}/*.md`) + + console.log(`Found ${docFiles.length} documentation files`) + + for (const file of docFiles) { + try { + processDocFile(file) + } catch (error) { + console.error(`Error processing ${file}:`, error.message) + } + } + + console.log('Documentation fix complete!') +} + +if (require.main === module) { + runMain() +} From a6c301ac7bb1d957c0b47802a28371f5b8af202b Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Wed, 11 Jun 2025 15:28:24 +0200 Subject: [PATCH 17/21] index --- docs/browser-logs.datadoglogs.md | 40 +-- docs/browser-logs.handlertype.md | 40 +-- docs/browser-logs.logger._constructor_.md | 44 +--- docs/browser-logs.logger.alert.md | 42 +--- docs/browser-logs.logger.clearcontext.md | 40 +-- docs/browser-logs.logger.critical.md | 42 +--- docs/browser-logs.logger.debug.md | 42 +--- docs/browser-logs.logger.emerg.md | 42 +--- docs/browser-logs.logger.error.md | 42 +--- docs/browser-logs.logger.getcontext.md | 40 +-- docs/browser-logs.logger.gethandler.md | 42 +--- docs/browser-logs.logger.getlevel.md | 40 +-- docs/browser-logs.logger.info.md | 42 +--- docs/browser-logs.logger.log.md | 42 +--- docs/browser-logs.logger.logimplementation.md | 42 +--- docs/browser-logs.logger.md | 42 +--- docs/browser-logs.logger.notice.md | 42 +--- docs/browser-logs.logger.ok.md | 42 +--- ...owser-logs.logger.removecontextproperty.md | 42 +--- docs/browser-logs.logger.setcontext.md | 42 +--- .../browser-logs.logger.setcontextproperty.md | 42 +--- docs/browser-logs.logger.sethandler.md | 44 +--- docs/browser-logs.logger.setlevel.md | 42 +--- docs/browser-logs.logger.warn.md | 42 +--- ...rowser-logs.loggerconfiguration.context.md | 40 +-- ...rowser-logs.loggerconfiguration.handler.md | 40 +-- .../browser-logs.loggerconfiguration.level.md | 40 +-- docs/browser-logs.loggerconfiguration.md | 44 +--- docs/browser-logs.logsevent.application_id.md | 40 +-- docs/browser-logs.logsevent.date.md | 40 +-- docs/browser-logs.logsevent.error.md | 40 +-- docs/browser-logs.logsevent.http.md | 40 +-- docs/browser-logs.logsevent.logger.md | 40 +-- docs/browser-logs.logsevent.md | 48 +--- docs/browser-logs.logsevent.message.md | 40 +-- docs/browser-logs.logsevent.origin.md | 40 +-- docs/browser-logs.logsevent.service.md | 40 +-- docs/browser-logs.logsevent.session.md | 40 +-- docs/browser-logs.logsevent.session_id.md | 40 +-- docs/browser-logs.logsevent.status.md | 40 +-- docs/browser-logs.logsevent.view.md | 40 +-- docs/browser-logs.logseventdomaincontext.md | 40 +-- docs/browser-logs.logsglobal.clearaccount.md | 40 +-- ...wser-logs.logsglobal.clearglobalcontext.md | 40 +-- docs/browser-logs.logsglobal.clearuser.md | 40 +-- docs/browser-logs.logsglobal.createlogger.md | 40 +-- docs/browser-logs.logsglobal.getaccount.md | 40 +-- ...rowser-logs.logsglobal.getglobalcontext.md | 40 +-- ...er-logs.logsglobal.getinitconfiguration.md | 40 +-- ...wser-logs.logsglobal.getinternalcontext.md | 40 +-- docs/browser-logs.logsglobal.getlogger.md | 40 +-- docs/browser-logs.logsglobal.getuser.md | 40 +-- docs/browser-logs.logsglobal.init.md | 40 +-- docs/browser-logs.logsglobal.logger.md | 40 +-- docs/browser-logs.logsglobal.md | 50 +--- ...r-logs.logsglobal.removeaccountproperty.md | 40 +-- ....logsglobal.removeglobalcontextproperty.md | 40 +-- ...wser-logs.logsglobal.removeuserproperty.md | 40 +-- docs/browser-logs.logsglobal.setaccount.md | 40 +-- ...wser-logs.logsglobal.setaccountproperty.md | 40 +-- ...rowser-logs.logsglobal.setglobalcontext.md | 40 +-- ...ogs.logsglobal.setglobalcontextproperty.md | 40 +-- ...wser-logs.logsglobal.settrackingconsent.md | 40 +-- docs/browser-logs.logsglobal.setuser.md | 42 +--- docs/browser-logs.logsglobal.setuser_1.md | 42 +--- ...browser-logs.logsglobal.setuserproperty.md | 40 +-- ...r-logs.logsinitconfiguration.beforesend.md | 40 +-- ...ogsinitconfiguration.forwardconsolelogs.md | 40 +-- ...gsinitconfiguration.forwarderrorstologs.md | 40 +-- ...gs.logsinitconfiguration.forwardreports.md | 40 +-- docs/browser-logs.logsinitconfiguration.md | 50 +--- ...logs.logsinitconfiguration.usepciintake.md | 40 +-- docs/browser-logs.logsmessage.context.md | 40 +-- docs/browser-logs.logsmessage.md | 42 +--- docs/browser-logs.logsmessage.message.md | 40 +-- docs/browser-logs.logsmessage.status.md | 40 +-- docs/browser-logs.md | 48 +--- docs/browser-logs.statustype.md | 40 +-- docs/browser-rum-react.addreacterror.md | 42 +--- ...r-rum-react.errorboundary._constructor_.md | 42 +--- ...m-react.errorboundary.componentdidcatch.md | 42 +--- ....errorboundary.getderivedstatefromerror.md | 42 +--- docs/browser-rum-react.errorboundary.md | 46 +--- .../browser-rum-react.errorboundary.render.md | 40 +-- ...wser-rum-react.errorboundary.reseterror.md | 40 +-- docs/browser-rum-react.md | 46 +--- docs/browser-rum-react.reactplugin.md | 42 +--- ...um-react.unstable_reactcomponenttracker.md | 40 +-- docs/browser-rum-slim.datadogrum.md | 40 +-- docs/browser-rum-slim.md | 42 +--- docs/browser-rum.commonproperties._dd.md | 40 +-- docs/browser-rum.commonproperties.account.md | 40 +-- ...rowser-rum.commonproperties.application.md | 40 +-- docs/browser-rum.commonproperties.build_id.md | 40 +-- ...wser-rum.commonproperties.build_version.md | 40 +-- docs/browser-rum.commonproperties.ci_test.md | 40 +-- ...owser-rum.commonproperties.connectivity.md | 40 +-- docs/browser-rum.commonproperties.context.md | 40 +-- docs/browser-rum.commonproperties.date.md | 40 +-- docs/browser-rum.commonproperties.device.md | 40 +-- docs/browser-rum.commonproperties.display.md | 40 +-- docs/browser-rum.commonproperties.md | 52 +--- docs/browser-rum.commonproperties.os.md | 40 +-- docs/browser-rum.commonproperties.service.md | 40 +-- docs/browser-rum.commonproperties.session.md | 40 +-- docs/browser-rum.commonproperties.source.md | 40 +-- ...browser-rum.commonproperties.synthetics.md | 40 +-- docs/browser-rum.commonproperties.usr.md | 40 +-- docs/browser-rum.commonproperties.version.md | 40 +-- docs/browser-rum.commonproperties.view.md | 40 +-- docs/browser-rum.datadogrum.md | 40 +-- docs/browser-rum.md | 46 +--- docs/browser-rum.rumactionevent.md | 40 +-- ...-rum.rumactioneventdomaincontext.events.md | 40 +-- ...mactioneventdomaincontext.handlingstack.md | 40 +-- ...browser-rum.rumactioneventdomaincontext.md | 56 ++--- docs/browser-rum.rumerrorevent.md | 40 +-- ...er-rum.rumerroreventdomaincontext.error.md | 40 +-- ...umerroreventdomaincontext.handlingstack.md | 40 +-- .../browser-rum.rumerroreventdomaincontext.md | 54 +--- docs/browser-rum.rumevent.md | 40 +-- docs/browser-rum.rumeventdomaincontext.md | 40 +-- ...umfetchresourceeventdomaincontext.error.md | 40 +-- ...esourceeventdomaincontext.handlingstack.md | 40 +-- ...tchresourceeventdomaincontext.isaborted.md | 40 +-- ...-rum.rumfetchresourceeventdomaincontext.md | 87 +++---- ...urceeventdomaincontext.performanceentry.md | 40 +-- ...hresourceeventdomaincontext.requestinit.md | 40 +-- ...resourceeventdomaincontext.requestinput.md | 40 +-- ...etchresourceeventdomaincontext.response.md | 40 +-- docs/browser-rum.rumglobal.addaction.md | 40 +-- .../browser-rum.rumglobal.adddurationvital.md | 40 +-- docs/browser-rum.rumglobal.adderror.md | 40 +-- ...-rum.rumglobal.addfeatureflagevaluation.md | 40 +-- docs/browser-rum.rumglobal.addtiming.md | 40 +-- docs/browser-rum.rumglobal.clearaccount.md | 40 +-- ...rowser-rum.rumglobal.clearglobalcontext.md | 40 +-- docs/browser-rum.rumglobal.clearuser.md | 40 +-- docs/browser-rum.rumglobal.getaccount.md | 40 +-- .../browser-rum.rumglobal.getglobalcontext.md | 40 +-- ...wser-rum.rumglobal.getinitconfiguration.md | 40 +-- ...rowser-rum.rumglobal.getinternalcontext.md | 40 +-- ...wser-rum.rumglobal.getsessionreplaylink.md | 40 +-- docs/browser-rum.rumglobal.getuser.md | 40 +-- docs/browser-rum.rumglobal.getviewcontext.md | 40 +-- docs/browser-rum.rumglobal.init.md | 40 +-- docs/browser-rum.rumglobal.md | 52 +--- ...ser-rum.rumglobal.removeaccountproperty.md | 40 +-- ...m.rumglobal.removeglobalcontextproperty.md | 40 +-- ...rowser-rum.rumglobal.removeuserproperty.md | 40 +-- docs/browser-rum.rumglobal.setaccount.md | 40 +-- ...rowser-rum.rumglobal.setaccountproperty.md | 40 +-- .../browser-rum.rumglobal.setglobalcontext.md | 40 +-- ...-rum.rumglobal.setglobalcontextproperty.md | 40 +-- ...rowser-rum.rumglobal.settrackingconsent.md | 40 +-- docs/browser-rum.rumglobal.setuser.md | 42 +--- docs/browser-rum.rumglobal.setuser_1.md | 42 +--- docs/browser-rum.rumglobal.setuserproperty.md | 40 +-- docs/browser-rum.rumglobal.setviewcontext.md | 40 +-- ...er-rum.rumglobal.setviewcontextproperty.md | 40 +-- docs/browser-rum.rumglobal.setviewname.md | 40 +-- ...rowser-rum.rumglobal.startdurationvital.md | 40 +-- ...m.rumglobal.startsessionreplayrecording.md | 40 +-- docs/browser-rum.rumglobal.startview.md | 40 +-- ...browser-rum.rumglobal.stopdurationvital.md | 40 +-- docs/browser-rum.rumglobal.stopsession.md | 40 +-- ...um.rumglobal.stopsessionreplayrecording.md | 40 +-- ...uminitconfiguration.actionnameattribute.md | 40 +-- ...ruminitconfiguration.allowedtracingurls.md | 40 +-- ...-rum.ruminitconfiguration.applicationid.md | 40 +-- ...ser-rum.ruminitconfiguration.beforesend.md | 40 +-- ...nitconfiguration.compressintakerequests.md | 40 +-- ...uminitconfiguration.defaultprivacylevel.md | 40 +-- ...onfiguration.enableprivacyforactionname.md | 40 +-- ...minitconfiguration.excludedactivityurls.md | 40 +-- docs/browser-rum.ruminitconfiguration.md | 80 ++---- ...rowser-rum.ruminitconfiguration.plugins.md | 40 +-- ...uminitconfiguration.profilingsamplerate.md | 40 +-- ...initconfiguration.propagatetracebaggage.md | 40 +-- ...initconfiguration.remoteconfigurationid.md | 40 +-- ...itconfiguration.sessionreplaysamplerate.md | 40 +-- ...ion.startsessionreplayrecordingmanually.md | 40 +-- ...wser-rum.ruminitconfiguration.subdomain.md | 40 +-- ...initconfiguration.tracecontextinjection.md | 40 +-- ...um.ruminitconfiguration.tracesamplerate.md | 40 +-- ...onfiguration.trackfeatureflagsforevents.md | 40 +-- ...rum.ruminitconfiguration.tracklongtasks.md | 40 +-- ...rum.ruminitconfiguration.trackresources.md | 40 +-- ...initconfiguration.trackuserinteractions.md | 40 +-- ...ruminitconfiguration.trackviewsmanually.md | 40 +-- ...wser-rum.ruminitconfiguration.workerurl.md | 40 +-- docs/browser-rum.rumlongtaskevent.md | 40 +-- ...owser-rum.rumlongtaskeventdomaincontext.md | 47 +--- ...taskeventdomaincontext.performanceentry.md | 40 +-- ...-rum.rumotherresourceeventdomaincontext.md | 47 +--- ...urceeventdomaincontext.performanceentry.md | 40 +-- docs/browser-rum.rumresourceevent.md | 40 +-- docs/browser-rum.rumviewevent.md | 40 +-- ...-rum.rumvieweventdomaincontext.location.md | 40 +-- docs/browser-rum.rumvieweventdomaincontext.md | 47 +--- docs/browser-rum.rumvitalevent.md | 40 +-- ...esourceeventdomaincontext.handlingstack.md | 40 +-- ...xhrresourceeventdomaincontext.isaborted.md | 40 +-- ...er-rum.rumxhrresourceeventdomaincontext.md | 66 ++--- ...urceeventdomaincontext.performanceentry.md | 40 +-- ...um.rumxhrresourceeventdomaincontext.xhr.md | 40 +-- docs/index.html | 236 ++++++++++++++++++ docs/index.md | 42 +--- scripts/fix-api-docs-final.js | 177 +------------ 209 files changed, 851 insertions(+), 8154 deletions(-) create mode 100644 docs/index.html diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index 449b5a6944..e8080c46a6 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > datadogLogs ## datadogLogs variable diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index c7488124a7..4c647614b6 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > HandlerType ## HandlerType variable diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 91e076a123..d8a7b799d8 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -50,7 +14,7 @@ constructor(handleLogStrategy: (logsMessage: LogsMessage, logger: Logger, handli ## Parameters -
+
Parameter @@ -103,7 +67,7 @@ handlerType -HandlerType \| HandlerType\[\] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 9d4abceb16..48011cc323 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > alert ## Logger.alert() method @@ -48,7 +12,7 @@ alert(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 19bc431214..a61699e2ae 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 476094ef46..0b16b394ca 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > critical ## Logger.critical() method @@ -48,7 +12,7 @@ critical(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 6af6a21b60..52ef50524e 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > debug ## Logger.debug() method @@ -48,7 +12,7 @@ debug(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index 1ae3e8b8ad..ee6a6c3abe 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method @@ -48,7 +12,7 @@ emerg(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index e7067829c1..b16b6e1f49 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > error ## Logger.error() method @@ -48,7 +12,7 @@ error(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index fda7634d60..847897dc6a 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 0e743077fa..94c1842bad 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method @@ -47,5 +11,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType \| HandlerType\[\] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 39f9894dcb..116d582953 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index 1915a02654..c68fc09ce5 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > info ## Logger.info() method @@ -48,7 +12,7 @@ info(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 809b389cd3..9534e2dbaa 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -48,7 +12,7 @@ log(message: string, messageContext?: object, status?: StatusType, error?: Error ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 05091c178e..d4d15f44f7 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -48,7 +12,7 @@ logImplementation(message: string, messageContext?: object, status?: StatusType, ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 1fa59aaa34..537cfee72a 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger ## Logger interface @@ -48,7 +12,7 @@ export interface Logger ## Methods -
+
Method diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index ff1c988761..f9836a7c30 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > notice ## Logger.notice() method @@ -48,7 +12,7 @@ notice(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 76ce03e582..eb4ab969a7 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > ok ## Logger.ok() method @@ -48,7 +12,7 @@ ok(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index 8994ba23bf..a1e0ebd782 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method @@ -48,7 +12,7 @@ removeContextProperty(key: string): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 1f421087b2..10c3e47398 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method @@ -48,7 +12,7 @@ setContext(context: object): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index adcd6ef6bf..37ce71e0b9 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method @@ -48,7 +12,7 @@ setContextProperty(key: string, value: any): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index de02e669ec..de34c7f37c 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -48,7 +12,7 @@ setHandler(handler: HandlerType | HandlerType[]): void; ## Parameters -
+
Parameter @@ -71,7 +35,7 @@ handler -HandlerType \| HandlerType\[\] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index a8d4ce3f63..0367f97bf3 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -48,7 +12,7 @@ setLevel(level: StatusType): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 40bd389fe5..2dd15971ba 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > Logger > warn ## Logger.warn() method @@ -48,7 +12,7 @@ warn(message: string, messageContext?: object, error?: Error): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index 358ec66305..da351e1643 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index b9fef7eb77..906fea4454 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index dd09903237..0f64773a54 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 5e4760a501..e8e9abfc32 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface @@ -48,7 +12,7 @@ export interface LoggerConfiguration ## Properties -
+
Property @@ -98,7 +62,7 @@ object -HandlerType \| HandlerType\[\] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 3453428f87..55763153a4 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > application\_id ## LogsEvent.application\_id property diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index 54d6e881c8..ec9e4e24fb 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 203374ec86..462b2e1f6c 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 9c2dcd95ea..3206ecd365 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 70eba066ba..87d2079448 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 55e64ada9e..668e251307 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent ## LogsEvent interface @@ -48,7 +12,7 @@ export interface LogsEvent ## Properties -
+
Property @@ -136,7 +100,7 @@ Start of the log in ms from epoch -{ method: 'POST' \| 'GET' \| 'HEAD' \| 'PUT' \| 'DELETE' \| 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } +{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } @@ -193,7 +157,7 @@ The log message -'network' \| 'source' \| 'console' \| 'logger' \| 'agent' \| 'report' +'network' | 'source' | 'console' | 'logger' | 'agent' | 'report' @@ -269,7 +233,7 @@ string -'ok' \| 'debug' \| 'info' \| 'notice' \| 'warn' \| 'error' \| 'critical' \| 'alert' \| 'emerg' +'ok' | 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emerg' diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 5415baba45..0e688c568e 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 42512e7e63..1b4dbf42f8 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index 313a8d8873..251a28d0bd 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 09fa7db670..179cbc5713 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 4c548dbcf7..76891367dc 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > session\_id ## LogsEvent.session\_id property diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 3762c76de3..898f1fe479 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index cf82788694..3ac0abb479 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 45782e72cc..867014bb3b 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index f6a34fd0de..9df5f06c88 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index ee4d5268f7..5c5e536b07 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 6f64bbedd9..8adcc276b4 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 733133d68a..2503071fe4 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index baf5bbffac..43d16fefcf 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index c568bfd5c9..d10bbe30d9 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index 4ef782ae9c..a1a53cc138 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index a31edc9804..c22bd2af3e 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 55b58e2e64..1cb3fb0ae6 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 184a80a979..0cb46a9696 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 09749621bf..65bcd0c20f 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index e702bbe233..c5a9be9bfe 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index a6af572d73..9a96dc432c 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface @@ -49,7 +13,7 @@ export interface LogsPublicApi extends PublicApi ## Properties -
+
Property @@ -202,7 +166,7 @@ See \LogsInitConfiguration \| undefined +() => LogsInitConfiguration | undefined @@ -221,7 +185,7 @@ Get the init configuration -(startTime?: number) => InternalContext \| undefined +(startTime?: number) => InternalContext | undefined @@ -242,7 +206,7 @@ See \Logger \| undefined +(name: string) => Logger | undefined @@ -489,7 +453,7 @@ Set or update the user property, stored in `@usr.` ## Methods -
+
Method diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index 8d80afc63e..2321d5b50e 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index ba91648d9d..d64200108f 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index c4364913a4..47942669d5 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index cf258b3969..d4273bc766 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 1d806d9fc6..0ff6da5fd5 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index cc37fa135f..f07063e025 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 9c873bb6a7..9e475d236d 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 1eb3cc4e22..b59ca39ee6 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index ddec36253a..76ad33f57a 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method @@ -54,7 +18,7 @@ setUser(newUser: User & { ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 0dd9d78283..9570bc14e2 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method @@ -55,7 +19,7 @@ setUser(newUser: User): void; ## Parameters -
+
Parameter diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index dc603e5283..1aa3195263 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index 9ce5c12d35..d0b1eb8d6b 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index b5b75ff273..cdd472a5e8 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index 8d2d513425..f1920aa7f3 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index 827fbe9ade..fd149e19fb 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 6e5ee21d2a..81b82f6ddd 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface @@ -49,7 +13,7 @@ export interface LogsInitConfiguration extends InitConfiguration ## Properties -
+
Property @@ -80,7 +44,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) \| undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined @@ -99,7 +63,7 @@ Description -ConsoleApiName[] \| 'all' \| undefined +ConsoleApiName[] | 'all' | undefined @@ -118,7 +82,7 @@ ConsoleApiName[] \| 'all' \| undefined -boolean \| undefined +boolean | undefined @@ -137,7 +101,7 @@ boolean \| undefined -RawReportType[] \| 'all' \| undefined +RawReportType[] | 'all' | undefined diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 6fcfe58601..24859ac38e 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 0674fd5a99..537ccc7a78 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 18533a70f8..107876469a 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -48,7 +12,7 @@ export interface LogsMessage ## Properties -
+`) + currentRow = [] + } + fixedLines.push(lines[i]) + inTable = false + continue + } + + if (inTable) { + if ( + line === '' || + line === '' || + line === '' || + line === '' || + line === '' + ) { + continue + } + + if (line.startsWith('') || line.includes('') || line.includes('')) { + if (currentRow.length > 0) { + fixedLines.push(`${currentRow.join(' ')}`) + currentRow = [] + } + fixedLines.push(lines[i]) + } else if (line.startsWith('`) + } + + return fixedLines.join('\n') +} + +function cleanupSpacing(content) { + content = content.replace(/ {2,}/g, ' ') + + content = content.replace(/\n{3,}/g, '\n\n') + + return content +} + +function fixEscapedTags(content) { + content = content.replace(/\\') + + return content +} + +function fixBackslashes(content) { + content = content.replace(/\\_/g, '_') + content = content.replace(/\\#/g, '#') + + content = content.replace(/\\\[/g, '[') + content = content.replace(/\\\]/g, ']') + + return content +} + +function processDocFile(file) { let content = fs.readFileSync(file, 'utf8') content = fixTypeBackslashes(content) content = fixArrayTypes(content) content = fixOptionalFormatting(content) content = convertMarkdownLinks(content) + content = fixHtmlEntities(content) + content = removeEmptyHtmlComments(content) + content = fixEscapedTags(content) + content = fixBackslashes(content) + content = fixHtmlTables(content) + content = cleanupSpacing(content) fs.writeFileSync(file, content, 'utf8') } diff --git a/scripts/fix-doc-links.js b/scripts/fix-doc-links.js deleted file mode 100644 index aba8a3e7d5..0000000000 --- a/scripts/fix-doc-links.js +++ /dev/null @@ -1,38 +0,0 @@ -const fs = require('fs') -const path = require('path') -const { globSync } = require('glob') - -// Replace markdown links [text](url) with HTML text -function convertLinks(markdown) { - return markdown.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => { - let newUrl = url - if (url.endsWith('.md')) { - newUrl = url.replace(/\.md$/, '.html') - } - return `${text}` - }) -} - -// Fix markdown formatting issues -function fixFormatting(markdown) { - // Remove underscores around (Optional) - return markdown.replace(/_\(Optional\)_/g, '(Optional)') -} - -function runMain() { - const docsDir = path.join(__dirname, '..', 'docs') - const files = globSync(`${docsDir}/**/*.md`, { nodir: true }) - files.forEach((file) => { - const content = fs.readFileSync(file, 'utf8') - let transformed = convertLinks(content) - transformed = fixFormatting(transformed) - if (content !== transformed) { - fs.writeFileSync(file, transformed, 'utf8') - } - }) - console.log(`Processed ${files.length} markdown files, converted markdown links to HTML tags.`) -} - -if (require.main === module) { - runMain() -} From e319a70810e6be9ef3ab1efb4659a5c21b8672d7 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Thu, 12 Jun 2025 15:38:16 +0200 Subject: [PATCH 19/21] change --- docs/browser-logs.logger._constructor_.md | 6 ++ docs/browser-logs.logger.alert.md | 4 ++ docs/browser-logs.logger.critical.md | 4 ++ docs/browser-logs.logger.debug.md | 4 ++ docs/browser-logs.logger.emerg.md | 4 ++ docs/browser-logs.logger.error.md | 4 ++ docs/browser-logs.logger.info.md | 4 ++ docs/browser-logs.logger.log.md | 5 ++ docs/browser-logs.logger.logimplementation.md | 6 ++ docs/browser-logs.logger.md | 10 ++++ docs/browser-logs.logger.notice.md | 4 ++ docs/browser-logs.logger.ok.md | 4 ++ ...owser-logs.logger.removecontextproperty.md | 2 + docs/browser-logs.logger.setcontext.md | 2 + .../browser-logs.logger.setcontextproperty.md | 3 + docs/browser-logs.logger.sethandler.md | 2 + docs/browser-logs.logger.setlevel.md | 2 + docs/browser-logs.logger.warn.md | 4 ++ docs/browser-logs.loggerconfiguration.md | 4 ++ docs/browser-logs.logsevent.md | 13 ++++ docs/browser-logs.logsglobal.md | 25 ++++++++ docs/browser-logs.logsglobal.setuser.md | 2 + docs/browser-logs.logsglobal.setuser_1.md | 2 + docs/browser-logs.logsinitconfiguration.md | 6 ++ docs/browser-logs.logsmessage.md | 4 ++ docs/browser-logs.md | 17 ++++++ docs/browser-rum-react.addreacterror.md | 3 + ...r-rum-react.errorboundary._constructor_.md | 2 + ...m-react.errorboundary.componentdidcatch.md | 3 + ....errorboundary.getderivedstatefromerror.md | 2 + docs/browser-rum-react.errorboundary.md | 8 +++ docs/browser-rum-react.md | 7 +++ docs/browser-rum-react.reactplugin.md | 2 + docs/browser-rum-slim.md | 2 + docs/browser-rum.commonproperties.md | 20 +++++++ docs/browser-rum.md | 22 +++++++ ...browser-rum.rumactioneventdomaincontext.md | 3 + .../browser-rum.rumerroreventdomaincontext.md | 3 + ...-rum.rumfetchresourceeventdomaincontext.md | 8 +++ docs/browser-rum.rumglobal.md | 38 ++++++++++++ docs/browser-rum.rumglobal.setuser.md | 2 + docs/browser-rum.rumglobal.setuser_1.md | 2 + docs/browser-rum.ruminitconfiguration.md | 24 ++++++++ ...owser-rum.rumlongtaskeventdomaincontext.md | 2 + ...-rum.rumotherresourceeventdomaincontext.md | 2 + docs/browser-rum.rumvieweventdomaincontext.md | 2 + ...er-rum.rumxhrresourceeventdomaincontext.md | 5 ++ docs/index.md | 5 ++ scripts/fix-api-docs-final.js | 59 +------------------ 49 files changed, 315 insertions(+), 58 deletions(-) diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index 0498251fd5..c1d8528bb8 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -29,6 +29,7 @@ Type Description +
Property diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index 99a121d30b..ba97f70fb7 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 9937ce97db..3217ac3816 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 3f75c947dc..cbafd19deb 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs ## browser-logs package @@ -44,7 +8,7 @@ Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. ## Classes -
+
Class @@ -68,7 +32,7 @@ Description ## Interfaces -
+
Interface @@ -137,7 +101,7 @@ Description ## Variables -
+
Variable @@ -181,7 +145,7 @@ The global Logs instance. Use this to call Logs methods. ## Type Aliases -
+
Type Alias diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 313f556f41..4d9dade523 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-logs > StatusType ## StatusType variable diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 3b364377ca..e00eafc47e 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > addReactError ## addReactError() function @@ -48,7 +12,7 @@ export declare function addReactError(error: Error, info: ErrorInfo): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 2d45d5d026..8ccd318cde 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) @@ -50,7 +14,7 @@ constructor(props: Props); ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 1f27f87a88..b14b0fb664 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method @@ -48,7 +12,7 @@ componentDidCatch(error: Error, errorInfo: ErrorInfo): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index c26c6503fb..5b987d5bdc 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method @@ -48,7 +12,7 @@ static getDerivedStateFromError(error: Error): State; ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index b3932488a7..0a6b26b377 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class @@ -49,7 +13,7 @@ export declare class ErrorBoundary extends React.Component ## Constructors -
+
Constructor @@ -83,7 +47,7 @@ Constructs a new instance of the `ErrorBoundary` class ## Properties -
+
Property @@ -125,7 +89,7 @@ Description ## Methods -
+
Method diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 123e22a7ad..7c6ac00636 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index b1add9bc62..48532c6c9f 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 689cac64c4..8228bf87f4 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react ## browser-rum-react package @@ -44,7 +8,7 @@ Datadog Browser RUM React Integration - Additional components and hooks for Reac ## Classes -
+
Class @@ -68,7 +32,7 @@ Description ## Functions -
+
Function @@ -101,7 +65,7 @@ Description ## Variables -
+
Variable diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 910c56b8a7..94c4d7e535 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function @@ -60,7 +24,7 @@ export declare function reactPlugin(configuration?: ReactPluginConfiguration): { ## Parameters -
+
Parameter diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 1a01ba4b54..595b895ff8 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker ## UNSTABLE\_ReactComponentTracker variable diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index b7e1f8eea1..917da31e02 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index 77695720ff..ca909b306e 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum-slim ## browser-rum-slim package @@ -44,7 +8,7 @@ Datadog Browser RUM SDK - Slim version without Session Replay and Real User Prof ## Variables -
+
Variable diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 175cd34afd..ad1cb08af6 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > \_dd ## CommonProperties.\_dd property diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index f4160108b6..45368c8e6e 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index 77e57f6e85..cd13d05e30 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index 07f69281e6..b86a419740 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > build\_id ## CommonProperties.build\_id property diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 723ff97bf7..9633cbb6ea 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > build\_version ## CommonProperties.build\_version property diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 4895939ac0..49573e6d83 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > ci\_test ## CommonProperties.ci\_test property diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 33e4d79c6a..487f61ebe0 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index a7cbcb4cec..e565438b7b 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index 5ea60a4ba9..bdb152047d 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index d4b7d79f9d..c1a3c6a1e0 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 735c06e950..861e290d0e 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index bb80113251..d4a91ff03b 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -50,7 +14,7 @@ export interface CommonProperties ## Properties -
+
Property @@ -83,7 +47,7 @@ Description -{ readonly format\_version: 2; session?: { plan?: 1 \| 2; readonly session\_precondition?: 'user\_app\_launch' \| 'inactivity\_timeout' \| 'max\_duration' \| 'background\_launch' \| 'prewarm' \| 'from\_non\_interactive\_session' \| 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } +{ readonly format\_version: 2; session?: { plan?: 1 | 2; readonly session\_precondition?: 'user\_app\_launch' | 'inactivity\_timeout' | 'max\_duration' | 'background\_launch' | 'prewarm' | 'from\_non\_interactive\_session' | 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } @@ -207,7 +171,7 @@ string -{ readonly status: 'connected' \| 'not\_connected' \| 'maybe'; readonly interfaces?: ('bluetooth' \| 'cellular' \| 'ethernet' \| 'wifi' \| 'wimax' \| 'mixed' \| 'other' \| 'unknown' \| 'none')\[\]; readonly effective\_type?: 'slow-2g' \| '2g' \| '3g' \| '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } +{ readonly status: 'connected' | 'not\_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')\[\]; readonly effective\_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } @@ -266,7 +230,7 @@ Start of the event in ms from epoch -{ readonly type: 'mobile' \| 'desktop' \| 'tablet' \| 'tv' \| 'gaming\_console' \| 'bot' \| 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } +{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming\_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } @@ -344,7 +308,7 @@ string -{ readonly id: string; readonly type: 'user' \| 'synthetics' \| 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } +{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } @@ -365,7 +329,7 @@ Session properties -'android' \| 'ios' \| 'browser' \| 'flutter' \| 'react-native' \| 'roku' \| 'unity' \| 'kotlin-multiplatform' +'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform' diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 47e1ca987e..536aa92efd 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index 6c06408108..75bd81afa2 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index 58c57bf9cc..d546e76ce3 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index ec7941adac..c3de043c5d 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index c7592ed516..2fafb2b1a1 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 5b4b81496a..7b6b5f4cd4 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 9cf50c8113..9854d3ef1c 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index 0de52ea4e9..b2a07261e5 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 4b6e44d59e..2b39faf4bc 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index a51a96739d..743101b513 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum ## browser-rum package @@ -44,7 +8,7 @@ Datadog Browser RUM SDK - Full version with Session Replay and Real User Profili ## Interfaces -
+
Interface @@ -151,7 +115,7 @@ Schema of common properties of RUM events ## Variables -
+
Variable @@ -177,7 +141,7 @@ The global RUM instance. Use this to call RUM methods. ## Type Aliases -
+
Type Alias diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index a922f3078f..5df82dc308 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumActionEvent ## RumActionEvent type diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index e2e8e797ad..6698f63bae 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 8a60fbcb11..3a381da3c1 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 684801837b..439b71f394 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumActionEventDomainContext ## Properties -
+ + +
Property @@ -82,7 +46,12 @@ Description Event[] -DOM events that triggered this action. (Optional)
+ +(Optional) + + +
handlingStack? @@ -96,5 +65,10 @@ Event[] string -Stack trace of where the action was handled by the SDK. (Optional)
+ +(Optional) + + +
diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index a9636f3dd2..d539728f58 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index be1f6e9da6..833d7b2a30 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 768b4d2fb7..fe21529635 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index cab07ea45d..aa70a3ef61 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumErrorEventDomainContext ## Properties -
+ + +
Property @@ -82,7 +46,10 @@ Description unknown -The original error object that was captured.
+ + +
handlingStack? @@ -96,5 +63,10 @@ unknown string -Stack trace of where the error was handled by the SDK. (Optional)
+ +(Optional) + + +
diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 6df3dcabb4..2e3d079ae0 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumEvent ## RumEvent type diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 7bc118b3b5..7e9b0b07ea 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 6374532839..384bf37e94 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index 2013739634..e8c761d8d7 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index fe7bd593ab..1245b6a516 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 3f4c39581c..c93b2f9144 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumFetchResourceEventDomainContext ## Properties -
+ + + + + + + +
Property @@ -82,7 +46,12 @@ Description Error -Error that occurred during the fetch call. (Optional)
+ +(Optional) + + +
handlingStack? @@ -96,7 +65,12 @@ Error string -Stack trace of where the resource was handled by the SDK. (Optional)
+ +(Optional) + + +
isAborted @@ -110,7 +84,10 @@ string boolean -Whether the fetch call was aborted.
+ + +
performanceEntry? @@ -124,7 +101,12 @@ boolean PerformanceEntry -Browser performance entry for this resource. (Optional)
+ +(Optional) + + +
requestInit? @@ -138,7 +120,12 @@ PerformanceEntry RequestInit -Init object passed to the fetch call. (Optional)
+ +(Optional) + + +
requestInput @@ -152,7 +139,10 @@ RequestInit RequestInfo -Input parameter passed to the fetch call.
+ + +
response? @@ -166,5 +156,10 @@ RequestInfo Response -Response object returned by the fetch call. (Optional)
+ +(Optional) + + +
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index 3ded6e60d2..dd65de0e81 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 0467466e9b..49ccfc94fe 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 91e1897f02..66999ec3d0 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index c31cf4030f..50db70b5a5 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 1bfd7ce95f..1d2b039ff5 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index a53bc1c1c1..fc23fa7b0f 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index ec33d14d43..d560b0591b 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index f1d10b5d7e..706ce9c41f 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 2400df43fa..3fcd32fd26 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 1889036a5e..07b37b26d5 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index a763251d3b..c4c687ba47 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 2ea6233546..7e42ce3c9a 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index 6afd404920..dba65370b3 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 5cc8faf710..6ca297788e 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 07e6c09b27..207a9ba9b4 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index af454a35cf..9377e29955 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 4b90b80d1e..523e21415a 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index 122e59a8ef..f443dcd8d0 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 39808a46e4..7fc407f915 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 5d7a7a1bd5..1142877612 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index cca833d0d6..7105ac5e3d 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal ## RumGlobal interface @@ -49,7 +13,7 @@ export interface RumPublicApi extends PublicApi ## Properties -
+
Property @@ -276,7 +240,7 @@ See \RumInitConfiguration \| undefined +() => RumInitConfiguration | undefined @@ -295,7 +259,7 @@ Get the init configuration -(startTime?: number) => InternalContext \| undefined +(startTime?: number) => InternalContext | undefined @@ -314,7 +278,7 @@ Get the init configuration -() => string \| undefined +() => string | undefined @@ -693,7 +657,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -(nameOrRef: string \| DurationVitalReference, options?: { context?: object; description?: string; }) => void +(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void @@ -746,7 +710,7 @@ See \
+
Method diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index 2c3a1db1f4..e8f1c73c0b 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index b8cecb67d9..b57a72c511 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index df65c90921..190cc5cf6d 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 28ce965030..a559156d79 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 6aab22366c..6d41e04cb2 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 0bc85d4394..08d98484b9 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index e83d03271f..542c3c639b 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index d5d48b36f6..41efadfec9 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index 667825daf5..a086a3e0f5 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method @@ -54,7 +18,7 @@ setUser(newUser: User & { ## Parameters -
+
Parameter diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 4049486fe7..972a0ae9f2 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method @@ -55,7 +19,7 @@ setUser(newUser: User): void; ## Parameters -
+
Parameter diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index aa8361c378..1165900244 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index d1abd2395b..95f2670ab2 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 6c7fc4e446..19adf5c441 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index c1651b39ac..5077efb0d9 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index e4b2657d95..58a2ff805c 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 5c810cbd56..8cb1159886 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index 8362acf615..efddb37e3a 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 19d035a551..40272a366e 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index c1f6725131..776655c5cf 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index 8a5d80d1f3..fac27e9aa0 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 24d0776c41..1e48a2c7ef 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 902c96f39e..7804d4d183 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index 1630d35e28..b93cb36c87 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 8551f0f6b1..40e6814128 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 82aa85f11b..3413d6cb14 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index 6ac527658a..d82ab6acac 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index ac0e816435..71a0cbe060 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index d98769ed01..af9c9bf573 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index f9533280c4..fe1b53e070 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface @@ -49,7 +13,7 @@ export interface RumInitConfiguration extends InitConfiguration ## Properties -
+
Property @@ -80,7 +44,7 @@ Description -string \| undefined +string | undefined @@ -99,7 +63,7 @@ string \| undefined -Array<MatchOption \| TracingOption> \| undefined +Array<MatchOption | TracingOption> | undefined @@ -137,7 +101,7 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) \| undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined @@ -158,7 +122,7 @@ See Home > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index d486933709..c08a3537d5 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 9339b96952..42f57c809a 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 201fd4c12a..925f00267a 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 6b3e70f9a2..0057df27ea 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 83c47a1ccc..427130229c 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index 3233dcbb51..ed3d388410 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index 0ab85a0c05..b5593bdb99 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index e4c8e7214c..f509245641 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index a9cb2c3a7a..11f8345f45 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 07b36ec1aa..8b2b7a0f5f 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index a8590de9d9..9c05a1120b 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index 6a7b734d81..198c9f2565 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index 0d9cb8b436..d028a6d8ac 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index 48d51d6d8d..fdb93f3581 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index ca5786ed10..4bec40e6c7 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index b1519d9ee4..47e7b1500f 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumLongTaskEventDomainContext ## Properties -
+ +
Property @@ -82,5 +46,8 @@ Description PerformanceEntry -Browser performance entry for this long task.
+ + +
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index d35217a915..71f23621a5 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index fbd80ab475..316fd6bedf 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumOtherResourceEventDomainContext ## Properties -
+ +
Property @@ -82,5 +46,8 @@ Description PerformanceEntry -Browser performance entry for this resource.
+ + +
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 46157836e6..6bc0840e08 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 29b3f23e19..20eb3f5607 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 39484b059f..14076df1df 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumViewEvent ## RumViewEvent type diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index cbeeb703d4..084978dfb8 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 703b2b07ea..f2d51a2686 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumViewEventDomainContext ## Properties -
+ +
Property @@ -82,5 +46,8 @@ Description Readonly<Location> -The browser location object at the time the view was created.
+ + +
diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 219cd703f1..95c1c41d20 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 67bf2dd9ec..c3c3e7c215 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 19441d8838..1da2a404dc 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 49fed177bc..23ec8cab4f 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface @@ -48,7 +12,7 @@ export interface RumXhrResourceEventDomainContext ## Properties -
+ + + + +
Property @@ -82,7 +46,12 @@ Description string -Stack trace of where the resource was handled by the SDK. (Optional)
+ +(Optional) + + +
isAborted @@ -96,7 +65,10 @@ string boolean -Whether the XHR request was aborted.
+ + +
performanceEntry? @@ -110,7 +82,12 @@ boolean PerformanceEntry -Browser performance entry for this resource. (Optional)
+ +(Optional) + + +
xhr @@ -124,5 +101,8 @@ PerformanceEntry XMLHttpRequest -The XMLHttpRequest object that made the request.
+ + +
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index d0b245545c..23288a5767 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 989f00bd05..7a02ed5a6c 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,41 +1,5 @@ - - - - - + + Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000000..3d8ca9520f --- /dev/null +++ b/docs/index.html @@ -0,0 +1,236 @@ + + + + + + Datadog Browser SDKs - API Documentation + + + +
+
+

Datadog Browser SDKs

+

API Reference Documentation

+
+
+ +
+
+
+

Welcome to Datadog Browser SDKs Documentation

+

+ This documentation provides a comprehensive API reference for all Datadog Browser SDKs. + Choose a package below to explore its API: +

+
    +
  • RUM (Real User Monitoring) - Monitor and analyze the real-time performance and user experience of your web application
    • +
  • Logs - Collect and analyze browser logs in real-time
    • +
  • Session Replay - Record and replay user sessions to understand user behavior
    • +
+
+ +
+
+
+

@datadog/browser-rum

+

+ Full RUM SDK with Session Replay and Real User Profiling capabilities. + Monitor your web application's performance and user experience. +

+
+ View API Documentation +
+
+ +
+

@datadog/browser-rum-slim

+

+ Lightweight version of the RUM SDK without Session Replay. + Ideal for performance-sensitive applications. +

+
+ View API Documentation +
+
+ +
+

@datadog/browser-logs

+

+ Browser logs collection SDK. + Collect, process, and analyze logs from your web applications. +

+
+ View API Documentation +
+
+ +
+

@datadog/browser-rum-react

+

+ React-specific integrations for the RUM SDK. + Includes React error boundaries and component tracking. +

+
+ View API Documentation +
+
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 1000736c36..752a2b7655 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,48 +1,12 @@ - - - - - + + Home ## API Reference ## Packages -
+`, - 'i' - ) - - content = content.replace(propPattern, (match, _type) => { - const isOptional = match.includes('?') || match.includes('Optional') - const desc = isOptional ? `${propDesc} (Optional)` : propDesc - return match.replace(/`) - }) - } - } - - return content -} - function processDocFile(file) { console.log(`Processing: ${file}`) let content = fs.readFileSync(file, 'utf8') - const fileName = path.basename(file) - // Applique toutes les transformations - content = cleanupStyles(content) + content = fixTypeBackslashes(content) content = fixArrayTypes(content) + content = fixOptionalFormatting(content) content = convertMarkdownLinks(content) - content = enhanceDescriptions(content, fileName) - - // Améliore les tableaux - content = content.replace(/
Package diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js index 2aa448f419..482c725054 100644 --- a/scripts/fix-api-docs-final.js +++ b/scripts/fix-api-docs-final.js @@ -2,124 +2,19 @@ const fs = require('fs') const path = require('path') const { globSync } = require('glob') -const TYPE_DESCRIPTIONS = { - RumActionEventDomainContext: { - main: 'Additional information available when the SDK dispatches a RUM **Action** event.', - properties: { - events: 'DOM events that triggered this action.', - handlingStack: 'Stack trace of where the action was handled by the SDK.', - }, - }, - RumViewEventDomainContext: { - main: 'Additional information available when the SDK dispatches a RUM **View** event.', - properties: { - location: 'The browser location object at the time the view was created.', - }, - }, - RumFetchResourceEventDomainContext: { - main: 'Additional information available when the SDK dispatches a **Fetch** resource event.', - properties: { - requestInit: 'Init object passed to the fetch call.', - requestInput: 'Input parameter passed to the fetch call.', - response: 'Response object returned by the fetch call.', - error: 'Error that occurred during the fetch call.', - performanceEntry: 'Browser performance entry for this resource.', - isAborted: 'Whether the fetch call was aborted.', - handlingStack: 'Stack trace of where the resource was handled by the SDK.', - }, - }, - RumXhrResourceEventDomainContext: { - main: 'Additional information available when the SDK dispatches an **XHR** resource event.', - properties: { - xhr: 'The XMLHttpRequest object that made the request.', - performanceEntry: 'Browser performance entry for this resource.', - isAborted: 'Whether the XHR request was aborted.', - handlingStack: 'Stack trace of where the resource was handled by the SDK.', - }, - }, - RumOtherResourceEventDomainContext: { - main: 'Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR.', - properties: { - performanceEntry: 'Browser performance entry for this resource.', - }, - }, - RumErrorEventDomainContext: { - main: 'Additional information available when the SDK dispatches an **Error** event.', - properties: { - error: 'The original error object that was captured.', - handlingStack: 'Stack trace of where the error was handled by the SDK.', - }, - }, - RumLongTaskEventDomainContext: { - main: 'Additional information available when the SDK dispatches a **Long Task** event.', - properties: { - performanceEntry: 'Browser performance entry for this long task.', - }, - }, -} - -function cleanupStyles(content) { - // Supprime tous les blocs de styles existants - content = content.replace(/[\s\S]*?<\/style>\s*/g, '') - - // Ajoute un seul bloc de styles au début - const styleBlock = ` - - - -` - - // Ajoute le style après le commentaire de non-édition - if (content.includes('', - `${styleBlock}` - ) - } - - return content +function fixTypeBackslashes(content) { + return content.replace(/\\\|/g, '|') } function fixArrayTypes(content) { - // Corrige les types de tableaux avec backslashes return content.replace(/(\w+)\\\[\\]/g, '$1[]') } +function fixOptionalFormatting(content) { + return content.replace(/_\(Optional\)_/g, '(Optional)') +} + function convertMarkdownLinks(content) { - // Convertit les liens markdown en HTML return content.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => { let newUrl = url if (url.endsWith('.md')) { @@ -129,67 +24,15 @@ function convertMarkdownLinks(content) { }) } -function enhanceDescriptions(content, fileName) { - // Extrait le nom du type depuis le nom du fichier - let typeName = null - - // Cherche le nom du type dans TYPE_DESCRIPTIONS - for (const type of Object.keys(TYPE_DESCRIPTIONS)) { - if (fileName.includes(type.toLowerCase())) { - typeName = type - break - } - } - - if (!typeName || !TYPE_DESCRIPTIONS[typeName]) { - return content - } - - console.log(` Enhancing ${typeName}`) - - // Ajoute la description principale de l'interface - const mainDescPattern = new RegExp(`## ${typeName} interface\\s*\\n\\n`, 'i') - const typeInfo = TYPE_DESCRIPTIONS[typeName] - - if (typeInfo.main) { - content = content.replace(mainDescPattern, (match) => `${match}${typeInfo.main}\n\n`) - } - - // Améliore les descriptions des propriétés - if (typeInfo.properties) { - // Pour chaque propriété connue - for (const [propName, propDesc] of Object.entries(typeInfo.properties)) { - // Pattern plus simple pour trouver la propriété dans le tableau - const propPattern = new RegExp( - `${propName}\\??\\s*\\s*\\s*([^<]+)\\s*\\s*(?:\\(Optional\\))?\\s*\s*(?:\(Optional\))?\s*<\/td>$/, `${desc}
/g, '
') fs.writeFileSync(file, content, 'utf8') } @@ -198,8 +41,6 @@ function runMain() { const docsDir = path.join(__dirname, '..', 'docs') const docFiles = globSync(`${docsDir}/*.md`) - console.log(`Found ${docFiles.length} documentation files`) - for (const file of docFiles) { try { processDocFile(file) @@ -207,8 +48,6 @@ function runMain() { console.error(`Error processing ${file}:`, error.message) } } - - console.log('Documentation fix complete!') } if (require.main === module) { From f5ad96537d50a6a404f2e3e0d2d12ec21e792b69 Mon Sep 17 00:00:00 2001 From: "roman.gaignault" Date: Thu, 12 Jun 2025 15:26:43 +0200 Subject: [PATCH 18/21] change --- docs/browser-logs.datadoglogs.md | 2 +- docs/browser-logs.handlertype.md | 8 +- docs/browser-logs.logger._constructor_.md | 12 +- docs/browser-logs.logger.alert.md | 6 +- docs/browser-logs.logger.clearcontext.md | 2 +- docs/browser-logs.logger.critical.md | 6 +- docs/browser-logs.logger.debug.md | 6 +- docs/browser-logs.logger.emerg.md | 6 +- docs/browser-logs.logger.error.md | 6 +- docs/browser-logs.logger.getcontext.md | 2 +- docs/browser-logs.logger.gethandler.md | 4 +- docs/browser-logs.logger.getlevel.md | 2 +- docs/browser-logs.logger.info.md | 6 +- docs/browser-logs.logger.log.md | 7 +- docs/browser-logs.logger.logimplementation.md | 8 +- docs/browser-logs.logger.md | 12 +- docs/browser-logs.logger.notice.md | 6 +- docs/browser-logs.logger.ok.md | 6 +- ...owser-logs.logger.removecontextproperty.md | 4 +- docs/browser-logs.logger.setcontext.md | 4 +- .../browser-logs.logger.setcontextproperty.md | 5 +- docs/browser-logs.logger.sethandler.md | 6 +- docs/browser-logs.logger.setlevel.md | 4 +- docs/browser-logs.logger.warn.md | 6 +- ...rowser-logs.loggerconfiguration.context.md | 2 +- ...rowser-logs.loggerconfiguration.handler.md | 2 +- .../browser-logs.loggerconfiguration.level.md | 2 +- docs/browser-logs.loggerconfiguration.md | 8 +- docs/browser-logs.logsevent.application_id.md | 4 +- docs/browser-logs.logsevent.date.md | 2 +- docs/browser-logs.logsevent.error.md | 26 +- docs/browser-logs.logsevent.http.md | 12 +- docs/browser-logs.logsevent.logger.md | 8 +- docs/browser-logs.logsevent.md | 29 +- docs/browser-logs.logsevent.message.md | 2 +- docs/browser-logs.logsevent.origin.md | 2 +- docs/browser-logs.logsevent.service.md | 2 +- docs/browser-logs.logsevent.session.md | 8 +- docs/browser-logs.logsevent.session_id.md | 4 +- docs/browser-logs.logsevent.status.md | 2 +- docs/browser-logs.logsevent.view.md | 12 +- docs/browser-logs.logseventdomaincontext.md | 2 +- docs/browser-logs.logsglobal.clearaccount.md | 2 +- ...wser-logs.logsglobal.clearglobalcontext.md | 4 +- docs/browser-logs.logsglobal.clearuser.md | 4 +- docs/browser-logs.logsglobal.createlogger.md | 6 +- docs/browser-logs.logsglobal.getaccount.md | 2 +- ...rowser-logs.logsglobal.getglobalcontext.md | 4 +- ...er-logs.logsglobal.getinitconfiguration.md | 2 +- ...wser-logs.logsglobal.getinternalcontext.md | 6 +- docs/browser-logs.logsglobal.getlogger.md | 4 +- docs/browser-logs.logsglobal.getuser.md | 4 +- docs/browser-logs.logsglobal.init.md | 2 +- docs/browser-logs.logsglobal.logger.md | 2 +- docs/browser-logs.logsglobal.md | 91 +++---- ...r-logs.logsglobal.removeaccountproperty.md | 2 +- ....logsglobal.removeglobalcontextproperty.md | 4 +- ...wser-logs.logsglobal.removeuserproperty.md | 4 +- docs/browser-logs.logsglobal.setaccount.md | 2 +- ...wser-logs.logsglobal.setaccountproperty.md | 2 +- ...rowser-logs.logsglobal.setglobalcontext.md | 2 +- ...ogs.logsglobal.setglobalcontextproperty.md | 2 +- ...wser-logs.logsglobal.settrackingconsent.md | 2 +- docs/browser-logs.logsglobal.setuser.md | 12 +- docs/browser-logs.logsglobal.setuser_1.md | 4 +- ...browser-logs.logsglobal.setuserproperty.md | 2 +- ...r-logs.logsinitconfiguration.beforesend.md | 2 +- ...ogsinitconfiguration.forwardconsolelogs.md | 2 +- ...gsinitconfiguration.forwarderrorstologs.md | 4 +- ...gs.logsinitconfiguration.forwardreports.md | 4 +- docs/browser-logs.logsinitconfiguration.md | 16 +- ...logs.logsinitconfiguration.usepciintake.md | 4 +- docs/browser-logs.logsmessage.context.md | 2 +- docs/browser-logs.logsmessage.md | 6 +- docs/browser-logs.logsmessage.message.md | 2 +- docs/browser-logs.logsmessage.status.md | 2 +- docs/browser-logs.md | 19 +- docs/browser-logs.statustype.md | 20 +- docs/browser-rum-react.addreacterror.md | 5 +- ...r-rum-react.errorboundary._constructor_.md | 4 +- ...m-react.errorboundary.componentdidcatch.md | 5 +- ....errorboundary.getderivedstatefromerror.md | 4 +- docs/browser-rum-react.errorboundary.md | 14 +- .../browser-rum-react.errorboundary.render.md | 2 +- ...wser-rum-react.errorboundary.reseterror.md | 2 +- docs/browser-rum-react.md | 11 +- docs/browser-rum-react.reactplugin.md | 26 +- ...um-react.unstable_reactcomponenttracker.md | 8 +- docs/browser-rum-slim.datadogrum.md | 2 +- docs/browser-rum-slim.md | 4 +- docs/browser-rum.commonproperties._dd.md | 32 +-- docs/browser-rum.commonproperties.account.md | 10 +- ...rowser-rum.commonproperties.application.md | 8 +- docs/browser-rum.commonproperties.build_id.md | 6 +- ...wser-rum.commonproperties.build_version.md | 4 +- docs/browser-rum.commonproperties.ci_test.md | 10 +- ...owser-rum.commonproperties.connectivity.md | 22 +- docs/browser-rum.commonproperties.context.md | 6 +- docs/browser-rum.commonproperties.date.md | 2 +- docs/browser-rum.commonproperties.device.md | 16 +- docs/browser-rum.commonproperties.display.md | 16 +- docs/browser-rum.commonproperties.md | 58 ++-- docs/browser-rum.commonproperties.os.md | 14 +- docs/browser-rum.commonproperties.service.md | 2 +- docs/browser-rum.commonproperties.session.md | 12 +- docs/browser-rum.commonproperties.source.md | 2 +- ...browser-rum.commonproperties.synthetics.md | 12 +- docs/browser-rum.commonproperties.usr.md | 14 +- docs/browser-rum.commonproperties.version.md | 2 +- docs/browser-rum.commonproperties.view.md | 14 +- docs/browser-rum.datadogrum.md | 2 +- docs/browser-rum.md | 44 ++- docs/browser-rum.rumactionevent.md | 110 ++++---- ...-rum.rumactioneventdomaincontext.events.md | 4 +- ...mactioneventdomaincontext.handlingstack.md | 4 +- ...browser-rum.rumactioneventdomaincontext.md | 11 +- docs/browser-rum.rumerrorevent.md | 158 +++++------ ...er-rum.rumerroreventdomaincontext.error.md | 4 +- ...umerroreventdomaincontext.handlingstack.md | 4 +- .../browser-rum.rumerroreventdomaincontext.md | 11 +- docs/browser-rum.rumevent.md | 4 +- docs/browser-rum.rumeventdomaincontext.md | 6 +- ...umfetchresourceeventdomaincontext.error.md | 4 +- ...esourceeventdomaincontext.handlingstack.md | 4 +- ...tchresourceeventdomaincontext.isaborted.md | 4 +- ...-rum.rumfetchresourceeventdomaincontext.md | 26 +- ...urceeventdomaincontext.performanceentry.md | 4 +- ...hresourceeventdomaincontext.requestinit.md | 4 +- ...resourceeventdomaincontext.requestinput.md | 4 +- ...etchresourceeventdomaincontext.response.md | 4 +- docs/browser-rum.rumglobal.addaction.md | 2 +- .../browser-rum.rumglobal.adddurationvital.md | 12 +- docs/browser-rum.rumglobal.adderror.md | 4 +- ...-rum.rumglobal.addfeatureflagevaluation.md | 2 +- docs/browser-rum.rumglobal.addtiming.md | 2 +- docs/browser-rum.rumglobal.clearaccount.md | 2 +- ...rowser-rum.rumglobal.clearglobalcontext.md | 4 +- docs/browser-rum.rumglobal.clearuser.md | 4 +- docs/browser-rum.rumglobal.getaccount.md | 2 +- .../browser-rum.rumglobal.getglobalcontext.md | 4 +- ...wser-rum.rumglobal.getinitconfiguration.md | 2 +- ...rowser-rum.rumglobal.getinternalcontext.md | 4 +- ...wser-rum.rumglobal.getsessionreplaylink.md | 4 +- docs/browser-rum.rumglobal.getuser.md | 4 +- docs/browser-rum.rumglobal.getviewcontext.md | 2 +- docs/browser-rum.rumglobal.init.md | 2 +- docs/browser-rum.rumglobal.md | 134 ++++----- ...ser-rum.rumglobal.removeaccountproperty.md | 2 +- ...m.rumglobal.removeglobalcontextproperty.md | 4 +- ...rowser-rum.rumglobal.removeuserproperty.md | 4 +- docs/browser-rum.rumglobal.setaccount.md | 2 +- ...rowser-rum.rumglobal.setaccountproperty.md | 2 +- .../browser-rum.rumglobal.setglobalcontext.md | 2 +- ...-rum.rumglobal.setglobalcontextproperty.md | 2 +- ...rowser-rum.rumglobal.settrackingconsent.md | 2 +- docs/browser-rum.rumglobal.setuser.md | 12 +- docs/browser-rum.rumglobal.setuser_1.md | 4 +- docs/browser-rum.rumglobal.setuserproperty.md | 2 +- docs/browser-rum.rumglobal.setviewcontext.md | 2 +- ...er-rum.rumglobal.setviewcontextproperty.md | 2 +- docs/browser-rum.rumglobal.setviewname.md | 2 +- ...rowser-rum.rumglobal.startdurationvital.md | 8 +- ...m.rumglobal.startsessionreplayrecording.md | 4 +- docs/browser-rum.rumglobal.startview.md | 10 +- ...browser-rum.rumglobal.stopdurationvital.md | 8 +- docs/browser-rum.rumglobal.stopsession.md | 2 +- ...um.rumglobal.stopsessionreplayrecording.md | 4 +- ...uminitconfiguration.actionnameattribute.md | 2 +- ...ruminitconfiguration.allowedtracingurls.md | 2 +- ...-rum.ruminitconfiguration.applicationid.md | 2 +- ...ser-rum.ruminitconfiguration.beforesend.md | 2 +- ...nitconfiguration.compressintakerequests.md | 2 +- ...uminitconfiguration.defaultprivacylevel.md | 4 +- ...onfiguration.enableprivacyforactionname.md | 2 +- ...minitconfiguration.excludedactivityurls.md | 2 +- docs/browser-rum.ruminitconfiguration.md | 48 +--- ...rowser-rum.ruminitconfiguration.plugins.md | 2 +- ...uminitconfiguration.profilingsamplerate.md | 4 +- ...initconfiguration.propagatetracebaggage.md | 4 +- ...initconfiguration.remoteconfigurationid.md | 2 +- ...itconfiguration.sessionreplaysamplerate.md | 4 +- ...ion.startsessionreplayrecordingmanually.md | 2 +- ...wser-rum.ruminitconfiguration.subdomain.md | 2 +- ...initconfiguration.tracecontextinjection.md | 4 +- ...um.ruminitconfiguration.tracesamplerate.md | 2 +- ...onfiguration.trackfeatureflagsforevents.md | 2 +- ...rum.ruminitconfiguration.tracklongtasks.md | 4 +- ...rum.ruminitconfiguration.trackresources.md | 4 +- ...initconfiguration.trackuserinteractions.md | 4 +- ...ruminitconfiguration.trackviewsmanually.md | 2 +- ...wser-rum.ruminitconfiguration.workerurl.md | 2 +- docs/browser-rum.rumlongtaskevent.md | 66 ++--- ...owser-rum.rumlongtaskeventdomaincontext.md | 8 +- ...taskeventdomaincontext.performanceentry.md | 4 +- ...-rum.rumotherresourceeventdomaincontext.md | 8 +- ...urceeventdomaincontext.performanceentry.md | 4 +- docs/browser-rum.rumresourceevent.md | 148 +++++----- docs/browser-rum.rumviewevent.md | 256 +++++++++--------- ...-rum.rumvieweventdomaincontext.location.md | 4 +- docs/browser-rum.rumvieweventdomaincontext.md | 10 +- docs/browser-rum.rumvitalevent.md | 42 +-- ...esourceeventdomaincontext.handlingstack.md | 4 +- ...xhrresourceeventdomaincontext.isaborted.md | 4 +- ...er-rum.rumxhrresourceeventdomaincontext.md | 17 +- ...urceeventdomaincontext.performanceentry.md | 4 +- ...um.rumxhrresourceeventdomaincontext.xhr.md | 4 +- docs/index.md | 5 - etc/browser-rum.api.json | 96 +++---- packages/rum-core/package.json | 2 +- scripts/fix-api-docs-final.js | 109 +++++++- scripts/fix-doc-links.js | 38 --- 211 files changed, 1171 insertions(+), 1326 deletions(-) delete mode 100644 scripts/fix-doc-links.js diff --git a/docs/browser-logs.datadoglogs.md b/docs/browser-logs.datadoglogs.md index e8080c46a6..ef093d8344 100644 --- a/docs/browser-logs.datadoglogs.md +++ b/docs/browser-logs.datadoglogs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > datadogLogs +Home > @datadog/browser-logs > datadogLogs ## datadogLogs variable diff --git a/docs/browser-logs.handlertype.md b/docs/browser-logs.handlertype.md index 4c647614b6..cbad0ad967 100644 --- a/docs/browser-logs.handlertype.md +++ b/docs/browser-logs.handlertype.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > HandlerType +Home > @datadog/browser-logs > HandlerType ## HandlerType variable @@ -8,8 +8,8 @@ ```typescript HandlerType: { - readonly console: "console"; - readonly http: "http"; - readonly silent: "silent"; + readonly console: "console"; + readonly http: "http"; + readonly silent: "silent"; } ``` diff --git a/docs/browser-logs.logger._constructor_.md b/docs/browser-logs.logger._constructor_.md index d8a7b799d8..0498251fd5 100644 --- a/docs/browser-logs.logger._constructor_.md +++ b/docs/browser-logs.logger._constructor_.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > (constructor) +Home > @datadog/browser-logs > Logger > (constructor) ## Logger.(constructor) @@ -29,7 +29,6 @@ Type Description -
handleLogStrategy @@ -37,13 +36,12 @@ handleLogStrategy -(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void -
name @@ -59,7 +57,6 @@ string (Optional) -
handlerType @@ -67,7 +64,7 @@ handlerType -HandlerType | HandlerType\[\] +HandlerType | HandlerType[] @@ -75,7 +72,6 @@ handlerType (Optional) -
level @@ -91,7 +87,6 @@ level (Optional) -
loggerContext @@ -107,5 +102,4 @@ object (Optional) -
diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 48011cc323..1738748460 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > alert +Home > @datadog/browser-logs > Logger > alert ## Logger.alert() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index a61699e2ae..287f697b81 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > clearContext +Home > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 0b16b394ca..0a345065b5 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > critical +Home > @datadog/browser-logs > Logger > critical ## Logger.critical() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 52ef50524e..d1c6a18266 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > debug +Home > @datadog/browser-logs > Logger > debug ## Logger.debug() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index ee6a6c3abe..b3f91c3250 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > emerg +Home > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index b16b6e1f49..9ecc88377b 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > error +Home > @datadog/browser-logs > Logger > error ## Logger.error() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 847897dc6a..07b7b7a06f 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getContext +Home > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 94c1842bad..44e325a0c0 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getHandler +Home > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method @@ -11,5 +11,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType | HandlerType\[\] +HandlerType | HandlerType[] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 116d582953..42232d6d2f 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > getLevel +Home > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index c68fc09ce5..a68533fcac 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > info +Home > @datadog/browser-logs > Logger > info ## Logger.info() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 9534e2dbaa..292d3813ac 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > log +Home > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
status @@ -73,7 +70,6 @@ status (Optional) -
error @@ -89,7 +85,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index d4d15f44f7..4b2f3d247a 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > logImplementation +Home > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
status @@ -73,7 +70,6 @@ status (Optional) -
error @@ -89,7 +85,6 @@ Error (Optional) -
handlingStack @@ -105,7 +100,6 @@ string (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 537cfee72a..7d474d2775 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger +Home > @datadog/browser-logs > Logger ## Logger interface @@ -22,7 +22,6 @@ Method Description -
alert(message, messageContext, error) @@ -31,7 +30,6 @@ Description -
critical(message, messageContext, error) @@ -40,7 +38,6 @@ Description -
debug(message, messageContext, error) @@ -49,7 +46,6 @@ Description -
emerg(message, messageContext, error) @@ -58,7 +54,6 @@ Description -
error(message, messageContext, error) @@ -67,7 +62,6 @@ Description -
info(message, messageContext, error) @@ -76,7 +70,6 @@ Description -
notice(message, messageContext, error) @@ -85,7 +78,6 @@ Description -
ok(message, messageContext, error) @@ -94,7 +86,6 @@ Description -
warn(message, messageContext, error) @@ -103,5 +94,4 @@ Description -
diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index f9836a7c30..26bc184c09 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > notice +Home > @datadog/browser-logs > Logger > notice ## Logger.notice() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index eb4ab969a7..0abfbcaf86 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > ok +Home > @datadog/browser-logs > Logger > ok ## Logger.ok() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index a1e0ebd782..590442588d 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > removeContextProperty +Home > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method @@ -27,7 +27,6 @@ Type Description -
key @@ -41,7 +40,6 @@ string -
**Returns:** diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 10c3e47398..b04a74a5a3 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setContext +Home > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method @@ -27,7 +27,6 @@ Type Description -
context @@ -41,7 +40,6 @@ object -
**Returns:** diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 37ce71e0b9..31283671bc 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setContextProperty +Home > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method @@ -27,7 +27,6 @@ Type Description -
key @@ -41,7 +40,6 @@ string -
value @@ -55,7 +53,6 @@ any -
**Returns:** diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index de34c7f37c..f6ea429ebf 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setHandler +Home > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -27,7 +27,6 @@ Type Description -
handler @@ -35,13 +34,12 @@ handler -HandlerType | HandlerType\[\] +HandlerType | HandlerType[] -
**Returns:** diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 0367f97bf3..8d515f7960 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > setLevel +Home > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -27,7 +27,6 @@ Type Description -
level @@ -41,7 +40,6 @@ level -
**Returns:** diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 2dd15971ba..f315d2bcc7 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > Logger > warn +Home > @datadog/browser-logs > Logger > warn ## Logger.warn() method @@ -27,7 +27,6 @@ Type Description -
message @@ -41,7 +40,6 @@ string -
messageContext @@ -57,7 +55,6 @@ object (Optional) -
error @@ -73,7 +70,6 @@ Error (Optional) -
**Returns:** diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index da351e1643..cde7c70422 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > context +Home > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index 906fea4454..f8008047ea 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > handler +Home > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 0f64773a54..870e7bcde3 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration > level +Home > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index e8e9abfc32..516087325c 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LoggerConfiguration +Home > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface @@ -32,7 +32,6 @@ Type Description -
context? @@ -51,7 +50,6 @@ object (Optional) -
handler? @@ -62,7 +60,7 @@ object -HandlerType | HandlerType\[\] +HandlerType | HandlerType[] @@ -70,7 +68,6 @@ object (Optional) -
level? @@ -89,5 +86,4 @@ object (Optional) -
diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 55763153a4..1354ea6752 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,8 +1,8 @@ -Home > @datadog/browser-logs > LogsEvent > application\_id +Home > @datadog/browser-logs > LogsEvent > application_id -## LogsEvent.application\_id property +## LogsEvent.application_id property UUID of the application diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index ec9e4e24fb..4d1e3ad47a 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > date +Home > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index 462b2e1f6c..ea1380ec1e 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > error +Home > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property @@ -10,16 +10,16 @@ Error properties ```typescript error?: { - kind?: string; - stack?: string; - fingerprint?: string; - message?: string; - causes?: Array<{ - message: string; - source: string; - type?: string; - stack?: string; - }>; - [k: string]: unknown; - }; + kind?: string; + stack?: string; + fingerprint?: string; + message?: string; + causes?: Array<{ + message: string; + source: string; + type?: string; + stack?: string; + }>; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 3206ecd365..7ebe67e608 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > http +Home > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property @@ -10,9 +10,9 @@ Resource properties of the error ```typescript http?: { - method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; - status_code: number; - url: string; - [k: string]: unknown; - }; + method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; + status_code: number; + url: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 87d2079448..104956466b 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > logger +Home > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property @@ -10,7 +10,7 @@ Logger properties ```typescript logger?: { - name: string; - [k: string]: unknown; - }; + name: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 668e251307..7d35776aa4 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent +Home > @datadog/browser-logs > LogsEvent ## LogsEvent interface @@ -32,10 +32,9 @@ Type Description -
-application\_id? +application_id? @@ -51,7 +50,6 @@ string (Optional) UUID of the application -
date @@ -70,7 +68,6 @@ number Start of the log in ms from epoch -
error? @@ -81,7 +78,7 @@ Start of the log in ms from epoch -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; [k: string]: unknown; } @@ -89,7 +86,6 @@ Start of the log in ms from epoch (Optional) Error properties -
http? @@ -100,7 +96,7 @@ Start of the log in ms from epoch -{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status\_code: number; url: string; \[k: string\]: unknown; } +{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status_code: number; url: string; [k: string]: unknown; } @@ -108,7 +104,6 @@ Start of the log in ms from epoch (Optional) Resource properties of the error -
logger? @@ -119,7 +114,7 @@ Start of the log in ms from epoch -{ name: string; \[k: string\]: unknown; } +{ name: string; [k: string]: unknown; } @@ -127,7 +122,6 @@ Start of the log in ms from epoch (Optional) Logger properties -
message @@ -146,7 +140,6 @@ string The log message -
origin @@ -165,7 +158,6 @@ The log message Origin of the log -
service? @@ -184,10 +176,9 @@ string (Optional) The service name -
-session\_id? +session_id? @@ -203,7 +194,6 @@ string (Optional) UUID of the session (deprecated in favor of session.id) -
session? @@ -214,7 +204,7 @@ string -{ id?: string; \[k: string\]: unknown; } +{ id?: string; [k: string]: unknown; } @@ -222,7 +212,6 @@ string (Optional) Session properties -
status @@ -241,7 +230,6 @@ string The log status -
view @@ -252,7 +240,7 @@ The log status -{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } +{ referrer?: string; url: string; id?: string; [k: string]: unknown; } @@ -260,5 +248,4 @@ The log status View properties -
diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index 0e688c568e..f6ee5ede03 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > message +Home > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 1b4dbf42f8..93444e5ddf 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > origin +Home > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index 251a28d0bd..f2cc1b7b07 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > service +Home > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 179cbc5713..0d4d900162 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > session +Home > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property @@ -10,7 +10,7 @@ Session properties ```typescript session?: { - id?: string; - [k: string]: unknown; - }; + id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 76891367dc..8fd965830f 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,8 +1,8 @@ -Home > @datadog/browser-logs > LogsEvent > session\_id +Home > @datadog/browser-logs > LogsEvent > session_id -## LogsEvent.session\_id property +## LogsEvent.session_id property UUID of the session (deprecated in favor of session.id) diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 898f1fe479..7fd4e630f2 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > status +Home > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 3ac0abb479..027fa26a4c 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEvent > view +Home > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property @@ -10,9 +10,9 @@ View properties ```typescript view: { - referrer?: string; - url: string; - id?: string; - [k: string]: unknown; - }; + referrer?: string; + url: string; + id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 867014bb3b..98a463405c 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsEventDomainContext +Home > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index 9df5f06c88..060db1903e 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > clearAccount +Home > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index 5c5e536b07..c3ba2df793 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext +Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property Clear the global context -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index 8adcc276b4..c5db42d8a7 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > clearUser +Home > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property Clear all user information -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index 2503071fe4..ab9cf826d3 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > createLogger +Home > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 43d16fefcf..968f787d83 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getAccount +Home > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index d10bbe30d9..624405042c 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > getGlobalContext +Home > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property Get the global Context -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index a1a53cc138..f8c8f4764a 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration +Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index c22bd2af3e..ec690c74f8 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > getInternalContext +Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context -See \Access internal context\ for further information. +See Access internal context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index 1cb3fb0ae6..de423b6ec5 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > getLogger +Home > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property Get a logger -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index 0cb46a9696..db13e72d69 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > getUser +Home > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property Get user information -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 65bcd0c20f..5d8b5bcc31 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > init +Home > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index c5a9be9bfe..2d57d00341 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > logger +Home > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 9a96dc432c..1c83b01859 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal +Home > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface @@ -33,7 +33,6 @@ Type Description -
clearAccount @@ -44,7 +43,7 @@ Description -() => void +() => void @@ -52,7 +51,6 @@ Description Clear all account information -
clearGlobalContext @@ -63,17 +61,16 @@ Clear all account information -() => void +() => void Clear the global context -See \Overwrite context\ for further information. +See Overwrite context for further information. -
clearUser @@ -84,17 +81,16 @@ See \User context\ for further information. +See User context for further information. -
createLogger @@ -105,17 +101,16 @@ See \LoggerConfiguration) => Logger +(name: string, conf?: LoggerConfiguration) => Logger -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. -
getAccount @@ -126,7 +121,7 @@ See \
getGlobalContext @@ -145,17 +139,16 @@ Get account information -() => Context +() => Context Get the global Context -See \Overwrite context\ for further information. +See Overwrite context for further information. -
getInitConfiguration @@ -166,7 +159,7 @@ See \LogsInitConfiguration | undefined +() => LogsInitConfiguration | undefined @@ -174,7 +167,6 @@ See \getInternalContext @@ -185,17 +177,16 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext | undefined -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context -See \Access internal context\ for further information. +See Access internal context for further information. -
getLogger @@ -206,17 +197,16 @@ See \Logger | undefined +(name: string) => Logger | undefined Get a logger -See \Define multiple loggers\ for further information. +See Define multiple loggers for further information. -
getUser @@ -227,17 +217,16 @@ See \User context\ for further information. +See User context for further information. -
init @@ -248,7 +237,7 @@ See \LogsInitConfiguration) => void +(initConfiguration: LogsInitConfiguration) => void @@ -256,7 +245,6 @@ See \logger @@ -273,7 +261,6 @@ Init the Logs browser SDK. -
removeAccountProperty @@ -284,7 +271,7 @@ Init the Logs browser SDK. -(key: string) => void +(key: string) => void @@ -292,7 +279,6 @@ Init the Logs browser SDK. Remove an account property -
removeGlobalContextProperty @@ -303,17 +289,16 @@ Remove an account property -(key: any) => void +(key: any) => void Remove a global context property -See \Overwrite context\ for further information. +See Overwrite context for further information. -
removeUserProperty @@ -324,17 +309,16 @@ See \User context\ for further information. +See User context for further information. -
setAccount @@ -345,7 +329,7 @@ See \
setAccountProperty @@ -364,7 +347,7 @@ Set account information to all events, stored in `@account` -(key: string, property: any) => void +(key: string, property: any) => void @@ -372,7 +355,6 @@ Set account information to all events, stored in `@account` Set or update the account property, stored in `@account.` -
setGlobalContext @@ -383,7 +365,7 @@ Set or update the account property, stored in `@account.` -(context: any) => void +(context: any) => void @@ -391,7 +373,6 @@ Set or update the account property, stored in `@account.` Set the global context information to all logs, stored in `@context` -
setGlobalContextProperty @@ -402,7 +383,7 @@ Set the global context information to all logs, stored in `@context` -(key: any, value: any) => void +(key: any, value: any) => void @@ -410,7 +391,6 @@ Set the global context information to all logs, stored in `@context` Set or update a global context property, stored in `@context.` -
setTrackingConsent @@ -421,7 +401,7 @@ Set or update a global context property, stored in `@context.` -(trackingConsent: TrackingConsent) => void +(trackingConsent: TrackingConsent) => void @@ -429,7 +409,6 @@ Set or update a global context property, stored in `@context.` Set the tracking consent of the current user. -
setUserProperty @@ -440,7 +419,7 @@ Set the tracking consent of the current user. -(key: any, property: any) => void +(key: any, property: any) => void @@ -448,7 +427,6 @@ Set the tracking consent of the current user. Set or update the user property, stored in `@usr.` -
## Methods @@ -463,7 +441,6 @@ Method Description -
setUser(newUser) @@ -473,10 +450,9 @@ Description Set user information to all events, stored in `@usr` -See \User context\ for further information. +See User context for further information. -
setUser(newUser) @@ -487,5 +463,4 @@ See \Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty +Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index d64200108f..9449a76730 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property Remove a global context property -See \Overwrite context\ for further information. +See Overwrite context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 47942669d5..959cf118ee 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-logs > LogsGlobal > removeUserProperty +Home > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property Remove a user property -See \User context\ for further information. +See User context for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index d4273bc766..a795ee6206 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setAccount +Home > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index 0ff6da5fd5..b3af24e5e6 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setAccountProperty +Home > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index f07063e025..70756de993 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setGlobalContext +Home > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 9e475d236d..6f932a486a 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index b59ca39ee6..5beb4d993e 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent +Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 76ad33f57a..9e738b5c80 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,19 +1,19 @@ -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method Set user information to all events, stored in `@usr` -See \User context\ for further information. +See User context for further information. **Signature:** ```typescript setUser(newUser: User & { - id: string; - }): void; + id: string; + }): void; ``` ## Parameters @@ -33,7 +33,6 @@ Type Description -
newUser @@ -41,13 +40,12 @@ newUser -User & { id: string; } +User & { id: string; } -
**Returns:** diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 9570bc14e2..7997d3141e 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method @@ -34,7 +34,6 @@ Type Description -
newUser @@ -48,7 +47,6 @@ User -
**Returns:** diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index 1aa3195263..db689f0b77 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsGlobal > setUserProperty +Home > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index d0b1eb8d6b..ca9ee23e48 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend +Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index cdd472a5e8..7208874b17 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index f1920aa7f3..aae928941d 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property -Forward console.error logs, uncaught exceptions and network errors to Datadog. true +Forward console.error logs, uncaught exceptions and network errors to Datadog. true **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index fd149e19fb..33f42825c2 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports +Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property -Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 81b82f6ddd..746c18132f 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsInitConfiguration +Home > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface @@ -33,7 +33,6 @@ Type Description -
beforeSend? @@ -44,7 +43,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined @@ -52,7 +51,6 @@ Description (Optional) Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs -
forwardConsoleLogs? @@ -71,7 +69,6 @@ ConsoleApiName[] | 'all' | undefined (Optional) Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. -
forwardErrorsToLogs? @@ -87,10 +84,9 @@ boolean | undefined -(Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true +(Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true -
forwardReports? @@ -106,10 +102,9 @@ RawReportType[] | 'all' | undefined -(Optional) Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +(Optional) Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. -
usePciIntake? @@ -125,8 +120,7 @@ boolean -(Optional) Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false +(Optional) Use PCI-compliant intake. See PCI DSS Compliance for further information. false -
diff --git a/docs/browser-logs.logsinitconfiguration.usepciintake.md b/docs/browser-logs.logsinitconfiguration.usepciintake.md index 24859ac38e..1f309bfbaa 100644 --- a/docs/browser-logs.logsinitconfiguration.usepciintake.md +++ b/docs/browser-logs.logsinitconfiguration.usepciintake.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake +Home > @datadog/browser-logs > LogsInitConfiguration > usePciIntake ## LogsInitConfiguration.usePciIntake property -Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false +Use PCI-compliant intake. See PCI DSS Compliance for further information. false **Signature:** diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index 537ccc7a78..b3cb258ec9 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > context +Home > @datadog/browser-logs > LogsMessage > context ## LogsMessage.context property diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 107876469a..c307801f1f 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage +Home > @datadog/browser-logs > LogsMessage ## LogsMessage interface @@ -32,7 +32,6 @@ Type Description -
context? @@ -51,7 +50,6 @@ Context (Optional) -
message @@ -68,7 +66,6 @@ string -
status @@ -85,5 +82,4 @@ string -
diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index ba97f70fb7..84712e6c45 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > message +Home > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 3217ac3816..7fa75e5968 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > LogsMessage > status +Home > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index cbafd19deb..3dab700e7d 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs +Home > @datadog/browser-logs ## browser-logs package @@ -18,7 +18,6 @@ Class Description -
Logger @@ -27,7 +26,6 @@ Description -
## Interfaces @@ -42,7 +40,6 @@ Interface Description -
Logger @@ -51,7 +48,6 @@ Description -
LoggerConfiguration @@ -60,7 +56,6 @@ Description -
LogsEvent @@ -69,7 +64,6 @@ Description -
LogsGlobal @@ -78,7 +72,6 @@ Description -
LogsInitConfiguration @@ -87,7 +80,6 @@ Description -
LogsMessage @@ -96,7 +88,6 @@ Description -
## Variables @@ -111,7 +102,6 @@ Variable Description -
datadogLogs @@ -122,7 +112,6 @@ Description The global Logs instance. Use this to call Logs methods. -
HandlerType @@ -131,7 +120,6 @@ The global Logs instance. Use this to call Logs methods. -
StatusType @@ -140,7 +128,6 @@ The global Logs instance. Use this to call Logs methods. -
## Type Aliases @@ -155,7 +142,6 @@ Type Alias Description -
HandlerType @@ -164,7 +150,6 @@ Description -
LogsEventDomainContext @@ -173,7 +158,6 @@ Description -
StatusType @@ -182,5 +166,4 @@ Description -
diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index 4d9dade523..d6be8530b4 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-logs > StatusType +Home > @datadog/browser-logs > StatusType ## StatusType variable @@ -8,14 +8,14 @@ ```typescript StatusType: { - readonly ok: "ok"; - readonly debug: "debug"; - readonly info: "info"; - readonly notice: "notice"; - readonly warn: "warn"; - readonly error: "error"; - readonly critical: "critical"; - readonly alert: "alert"; - readonly emerg: "emerg"; + readonly ok: "ok"; + readonly debug: "debug"; + readonly info: "info"; + readonly notice: "notice"; + readonly warn: "warn"; + readonly error: "error"; + readonly critical: "critical"; + readonly alert: "alert"; + readonly emerg: "emerg"; } ``` diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index e00eafc47e..818fd646ff 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > addReactError +Home > @datadog/browser-rum-react > addReactError ## addReactError() function @@ -27,7 +27,6 @@ Type Description -
error @@ -41,7 +40,6 @@ Error -
info @@ -55,7 +53,6 @@ ErrorInfo -
**Returns:** diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index 8ccd318cde..d4be773223 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) +Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) @@ -29,7 +29,6 @@ Type Description -
props @@ -43,5 +42,4 @@ Props -
diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index b14b0fb664..25abdf7abf 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch +Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method @@ -27,7 +27,6 @@ Type Description -
error @@ -41,7 +40,6 @@ Error -
errorInfo @@ -55,7 +53,6 @@ ErrorInfo -
**Returns:** diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 5b987d5bdc..1c2e4c6520 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError +Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method @@ -27,7 +27,6 @@ Type Description -
error @@ -41,7 +40,6 @@ Error -
**Returns:** diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 0a6b26b377..238fa65042 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary +Home > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class @@ -9,7 +9,7 @@ ```typescript export declare class ErrorBoundary extends React.Component ``` -**Extends:** React.Component<Props, State> +**Extends:** React.Component ## Constructors @@ -28,7 +28,6 @@ Modifiers Description -
(constructor)(props) @@ -42,7 +41,6 @@ Description Constructs a new instance of the `ErrorBoundary` class -
## Properties @@ -67,7 +65,6 @@ Type Description -
resetError @@ -78,13 +75,12 @@ Description -() => void +() => void -
## Methods @@ -104,7 +100,6 @@ Modifiers Description -
componentDidCatch(error, errorInfo) @@ -116,7 +111,6 @@ Description -
getDerivedStateFromError(error) @@ -130,7 +124,6 @@ Description -
render() @@ -142,5 +135,4 @@ Description -
diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 7c6ac00636..346c338588 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > render +Home > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 48532c6c9f..28cb6a6eae 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > ErrorBoundary > resetError +Home > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 8228bf87f4..ef2a1c8afd 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react +Home > @datadog/browser-rum-react ## browser-rum-react package @@ -18,7 +18,6 @@ Class Description -
ErrorBoundary @@ -27,7 +26,6 @@ Description -
## Functions @@ -42,7 +40,6 @@ Function Description -
addReactError(error, info) @@ -51,7 +48,6 @@ Description -
reactPlugin(configuration) @@ -60,7 +56,6 @@ Description -
## Variables @@ -75,14 +70,12 @@ Variable Description -
-UNSTABLE\_ReactComponentTracker +UNSTABLE_ReactComponentTracker -
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 94c4d7e535..d3f9e304d6 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-react > reactPlugin +Home > @datadog/browser-rum-react > reactPlugin ## reactPlugin() function @@ -8,17 +8,17 @@ ```typescript export declare function reactPlugin(configuration?: ReactPluginConfiguration): { - name: string; - onInit({ publicApi, initConfiguration }: { - initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; - publicApi: RumPublicApi; - }): void; - onRumStart({ strategy }: { - strategy: Strategy; - }): void; - getConfigurationTelemetry(): { - router: boolean; - }; + name: string; + onInit({ publicApi, initConfiguration }: { + initConfiguration: import("@datadog/browser-rum-core").RumInitConfiguration; + publicApi: RumPublicApi; + }): void; + onRumStart({ strategy }: { + strategy: Strategy; + }): void; + getConfigurationTelemetry(): { + router: boolean; + }; }; ``` @@ -39,7 +39,6 @@ Type Description -
configuration @@ -55,7 +54,6 @@ ReactPluginConfiguration (Optional) -
**Returns:** diff --git a/docs/browser-rum-react.unstable_reactcomponenttracker.md b/docs/browser-rum-react.unstable_reactcomponenttracker.md index 595b895ff8..080a753230 100644 --- a/docs/browser-rum-react.unstable_reactcomponenttracker.md +++ b/docs/browser-rum-react.unstable_reactcomponenttracker.md @@ -1,14 +1,14 @@ -Home > @datadog/browser-rum-react > UNSTABLE\_ReactComponentTracker +Home > @datadog/browser-rum-react > UNSTABLE_ReactComponentTracker -## UNSTABLE\_ReactComponentTracker variable +## UNSTABLE_ReactComponentTracker variable **Signature:** ```typescript UNSTABLE_ReactComponentTracker: ({ name: componentName, children, }: { - name: string; - children?: React.ReactNode; + name: string; + children?: React.ReactNode; }) => React.JSX.Element ``` diff --git a/docs/browser-rum-slim.datadogrum.md b/docs/browser-rum-slim.datadogrum.md index 917da31e02..dc358aea7b 100644 --- a/docs/browser-rum-slim.datadogrum.md +++ b/docs/browser-rum-slim.datadogrum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-slim > datadogRum +Home > @datadog/browser-rum-slim > datadogRum ## datadogRum variable diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index ca909b306e..1632946a84 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum-slim +Home > @datadog/browser-rum-slim ## browser-rum-slim package @@ -18,7 +18,6 @@ Variable Description -
datadogRum @@ -29,5 +28,4 @@ Description The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods. -
diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index ad1cb08af6..770da23217 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,8 +1,8 @@ -Home > @datadog/browser-rum > CommonProperties > \_dd +Home > @datadog/browser-rum > CommonProperties > _dd -## CommonProperties.\_dd property +## CommonProperties._dd property Internal properties @@ -10,18 +10,18 @@ Internal properties ```typescript readonly _dd: { - readonly format_version: 2; - session?: { - plan?: 1 | 2; - readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; - [k: string]: unknown; - }; - readonly configuration?: { - readonly session_sample_rate: number; - readonly session_replay_sample_rate?: number; - [k: string]: unknown; - }; - readonly browser_sdk_version?: string; - [k: string]: unknown; - }; + readonly format_version: 2; + session?: { + plan?: 1 | 2; + readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; + [k: string]: unknown; + }; + readonly configuration?: { + readonly session_sample_rate: number; + readonly session_replay_sample_rate?: number; + [k: string]: unknown; + }; + readonly browser_sdk_version?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 45368c8e6e..3288173716 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > account +Home > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property @@ -10,8 +10,8 @@ Account properties ```typescript readonly account?: { - readonly id: string; - readonly name?: string; - [k: string]: unknown; - }; + readonly id: string; + readonly name?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index cd13d05e30..eb5eef9ea0 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > application +Home > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property @@ -10,7 +10,7 @@ Application properties ```typescript readonly application: { - readonly id: string; - [k: string]: unknown; - }; + readonly id: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index b86a419740..a228bec43a 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > CommonProperties > build\_id +Home > @datadog/browser-rum > CommonProperties > build_id -## CommonProperties.build\_id property +## CommonProperties.build_id property -Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. +Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. **Signature:** diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 9633cbb6ea..2229436437 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,8 +1,8 @@ -Home > @datadog/browser-rum > CommonProperties > build\_version +Home > @datadog/browser-rum > CommonProperties > build_version -## CommonProperties.build\_version property +## CommonProperties.build_version property The build version for this application diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 49573e6d83..4214fb0bf1 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,8 +1,8 @@ -Home > @datadog/browser-rum > CommonProperties > ci\_test +Home > @datadog/browser-rum > CommonProperties > ci_test -## CommonProperties.ci\_test property +## CommonProperties.ci_test property CI Visibility properties @@ -10,7 +10,7 @@ CI Visibility properties ```typescript readonly ci_test?: { - readonly test_execution_id: string; - [k: string]: unknown; - }; + readonly test_execution_id: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 487f61ebe0..506f74e0ad 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > connectivity +Home > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property @@ -10,14 +10,14 @@ Device connectivity properties ```typescript connectivity?: { - readonly status: 'connected' | 'not_connected' | 'maybe'; - readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; - readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; - readonly cellular?: { - readonly technology?: string; - readonly carrier_name?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; + readonly status: 'connected' | 'not_connected' | 'maybe'; + readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; + readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; + readonly cellular?: { + readonly technology?: string; + readonly carrier_name?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index e565438b7b..f169e538e6 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > context +Home > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property @@ -10,6 +10,6 @@ User provided context ```typescript context?: { - [k: string]: unknown; - }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index bdb152047d..bf6a83a7b4 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > date +Home > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index c1a3c6a1e0..d5cde8df9e 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > device +Home > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property @@ -10,11 +10,11 @@ Device properties ```typescript device?: { - readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; - readonly name?: string; - readonly model?: string; - readonly brand?: string; - readonly architecture?: string; - [k: string]: unknown; - }; + readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; + readonly name?: string; + readonly model?: string; + readonly brand?: string; + readonly architecture?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index 861e290d0e..a2b6685296 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > display +Home > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property @@ -10,11 +10,11 @@ Display properties ```typescript display?: { - readonly viewport?: { - readonly width: number; - readonly height: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; + readonly viewport?: { + readonly width: number; + readonly height: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index d4a91ff03b..950384773e 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties +Home > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -34,10 +34,9 @@ Type Description -
-\_dd +_dd @@ -47,7 +46,7 @@ Description -{ readonly format\_version: 2; session?: { plan?: 1 | 2; readonly session\_precondition?: 'user\_app\_launch' | 'inactivity\_timeout' | 'max\_duration' | 'background\_launch' | 'prewarm' | 'from\_non\_interactive\_session' | 'explicit\_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session\_sample\_rate: number; readonly session\_replay\_sample\_rate?: number; \[k: string\]: unknown; }; readonly browser\_sdk\_version?: string; \[k: string\]: unknown; } +{ readonly format_version: 2; session?: { plan?: 1 | 2; readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; [k: string]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; [k: string]: unknown; }; readonly browser_sdk_version?: string; [k: string]: unknown; } @@ -55,7 +54,6 @@ Description Internal properties -
account? @@ -68,7 +66,7 @@ Internal properties -{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } +{ readonly id: string; readonly name?: string; [k: string]: unknown; } @@ -76,7 +74,6 @@ Internal properties (Optional) Account properties -
application @@ -89,7 +86,7 @@ Internal properties -{ readonly id: string; \[k: string\]: unknown; } +{ readonly id: string; [k: string]: unknown; } @@ -97,10 +94,9 @@ Internal properties Application properties -
-build\_id? +build_id? @@ -115,13 +111,12 @@ string -(Optional) Generated unique ID of the application build. Unlike version or build\_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. +(Optional) Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. -
-build\_version? +build_version? @@ -139,10 +134,9 @@ string (Optional) The build version for this application -
-ci\_test? +ci_test? @@ -152,7 +146,7 @@ string -{ readonly test\_execution\_id: string; \[k: string\]: unknown; } +{ readonly test_execution_id: string; [k: string]: unknown; } @@ -160,7 +154,6 @@ string (Optional) CI Visibility properties -
connectivity? @@ -171,7 +164,7 @@ string -{ readonly status: 'connected' | 'not\_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')\[\]; readonly effective\_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier\_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } +{ readonly status: 'connected' | 'not_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; [k: string]: unknown; }; [k: string]: unknown; } @@ -179,7 +172,6 @@ string (Optional) Device connectivity properties -
context? @@ -190,7 +182,7 @@ string -{ \[k: string\]: unknown; } +{ [k: string]: unknown; } @@ -198,7 +190,6 @@ string (Optional) User provided context -
date @@ -219,7 +210,6 @@ number Start of the event in ms from epoch -
device? @@ -230,7 +220,7 @@ Start of the event in ms from epoch -{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming\_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } +{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; [k: string]: unknown; } @@ -238,7 +228,6 @@ Start of the event in ms from epoch (Optional) Device properties -
display? @@ -249,7 +238,7 @@ Start of the event in ms from epoch -{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } +{ readonly viewport?: { readonly width: number; readonly height: number; [k: string]: unknown; }; [k: string]: unknown; } @@ -257,7 +246,6 @@ Start of the event in ms from epoch (Optional) Display properties -
os? @@ -268,7 +256,7 @@ Start of the event in ms from epoch -{ readonly name: string; readonly version: string; readonly build?: string; readonly version\_major: string; \[k: string\]: unknown; } +{ readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; [k: string]: unknown; } @@ -276,7 +264,6 @@ Start of the event in ms from epoch (Optional) Operating system properties -
service? @@ -295,7 +282,6 @@ string (Optional) The service name for this application -
session @@ -308,7 +294,7 @@ string -{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci\_test'; readonly has\_replay?: boolean; \[k: string\]: unknown; } +{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci_test'; readonly has_replay?: boolean; [k: string]: unknown; } @@ -316,7 +302,6 @@ string Session properties -
source? @@ -337,7 +322,6 @@ Session properties (Optional) The source of this event -
synthetics? @@ -350,7 +334,7 @@ Session properties -{ readonly test\_id: string; readonly result\_id: string; readonly injected?: boolean; \[k: string\]: unknown; } +{ readonly test_id: string; readonly result_id: string; readonly injected?: boolean; [k: string]: unknown; } @@ -358,7 +342,6 @@ Session properties (Optional) Synthetics properties -
usr? @@ -371,7 +354,7 @@ Session properties -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous\_id?: string; \[k: string\]: unknown; } +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; [k: string]: unknown; } @@ -379,7 +362,6 @@ Session properties (Optional) User properties -
version? @@ -398,7 +380,6 @@ string (Optional) The version for this application -
view @@ -411,7 +392,7 @@ string -{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } +{ readonly id: string; referrer?: string; url: string; name?: string; [k: string]: unknown; } @@ -419,5 +400,4 @@ string View properties -
diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 536aa92efd..30dacd5044 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > os +Home > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property @@ -10,10 +10,10 @@ Operating system properties ```typescript os?: { - readonly name: string; - readonly version: string; - readonly build?: string; - readonly version_major: string; - [k: string]: unknown; - }; + readonly name: string; + readonly version: string; + readonly build?: string; + readonly version_major: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index 75bd81afa2..defdf44bf6 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > service +Home > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index d546e76ce3..d157bac935 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > session +Home > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property @@ -10,9 +10,9 @@ Session properties ```typescript readonly session: { - readonly id: string; - readonly type: 'user' | 'synthetics' | 'ci_test'; - readonly has_replay?: boolean; - [k: string]: unknown; - }; + readonly id: string; + readonly type: 'user' | 'synthetics' | 'ci_test'; + readonly has_replay?: boolean; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index c3de043c5d..b18802e93b 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > source +Home > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 2fafb2b1a1..134e3085ec 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > synthetics +Home > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property @@ -10,9 +10,9 @@ Synthetics properties ```typescript readonly synthetics?: { - readonly test_id: string; - readonly result_id: string; - readonly injected?: boolean; - [k: string]: unknown; - }; + readonly test_id: string; + readonly result_id: string; + readonly injected?: boolean; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 7b6b5f4cd4..32a86d51ba 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > usr +Home > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property @@ -10,10 +10,10 @@ User properties ```typescript readonly usr?: { - readonly id?: string; - readonly name?: string; - readonly email?: string; - readonly anonymous_id?: string; - [k: string]: unknown; - }; + readonly id?: string; + readonly name?: string; + readonly email?: string; + readonly anonymous_id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 9854d3ef1c..69621890d1 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > version +Home > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index b2a07261e5..6c2575f075 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > CommonProperties > view +Home > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property @@ -10,10 +10,10 @@ View properties ```typescript readonly view: { - readonly id: string; - referrer?: string; - url: string; - name?: string; - [k: string]: unknown; - }; + readonly id: string; + referrer?: string; + url: string; + name?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index 2b39faf4bc..b427e89cc3 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > datadogRum +Home > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 743101b513..8ed1fcb980 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum +Home > @datadog/browser-rum ## browser-rum package @@ -18,7 +18,6 @@ Interface Description -
CommonProperties @@ -29,7 +28,6 @@ Description Schema of common properties of RUM events -
RumActionEventDomainContext @@ -37,8 +35,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches a RUM \*\*Action\*\* event. + -
RumErrorEventDomainContext @@ -46,8 +45,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches an \*\*Error\*\* event. + -
RumFetchResourceEventDomainContext @@ -55,8 +55,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches a \*\*Fetch\*\* resource event. + -
RumGlobal @@ -64,8 +65,9 @@ Schema of common properties of RUM events +The RUM Browser SDK global object that provides all the public methods. + -
RumInitConfiguration @@ -73,8 +75,9 @@ Schema of common properties of RUM events +Configuration options to pass to the `init()` method when initializing the RUM SDK. + -
RumLongTaskEventDomainContext @@ -82,8 +85,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches a \*\*Long Task\*\* event. + -
RumOtherResourceEventDomainContext @@ -91,8 +95,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches a \*\*Resource\*\* event that is neither fetch nor XHR. + -
RumViewEventDomainContext @@ -100,8 +105,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches a RUM \*\*View\*\* event. + -
RumXhrResourceEventDomainContext @@ -109,8 +115,9 @@ Schema of common properties of RUM events +Additional information available when the SDK dispatches an \*\*XHR\*\* resource event. + -
## Variables @@ -125,7 +132,6 @@ Variable Description -
datadogRum @@ -136,7 +142,6 @@ Description The global RUM instance. Use this to call RUM methods. -
## Type Aliases @@ -151,7 +156,6 @@ Type Alias Description -
RumActionEvent @@ -162,7 +166,6 @@ Description Schema of all properties of an Action event -
RumErrorEvent @@ -173,7 +176,6 @@ Schema of all properties of an Action event Schema of all properties of an Error event -
RumEvent @@ -184,7 +186,6 @@ Schema of all properties of an Error event Schema of all properties of a RUM event -
RumEventDomainContext @@ -192,8 +193,9 @@ Schema of all properties of a RUM event +Additional context data that varies based on the type of RUM event being dispatched. + -
RumLongTaskEvent @@ -204,7 +206,6 @@ Schema of all properties of a RUM event Schema of all properties of a Long Task event -
RumResourceEvent @@ -215,7 +216,6 @@ Schema of all properties of a Long Task event Schema of all properties of a Resource event -
RumViewEvent @@ -226,7 +226,6 @@ Schema of all properties of a Resource event Schema of all properties of a View event -
RumVitalEvent @@ -237,5 +236,4 @@ Schema of all properties of a View event Schema of all properties of a Vital event -
diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index 5df82dc308..a6f69c6bcf 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumActionEvent +Home > @datadog/browser-rum > RumActionEvent ## RumActionEvent type @@ -10,60 +10,60 @@ Schema of all properties of an Action event ```typescript export type RumActionEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'action'; - readonly action: { - readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; - readonly id?: string; - readonly loading_time?: number; - readonly target?: { - name: string; - [k: string]: unknown; - }; - readonly frustration?: { - readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; - [k: string]: unknown; - }; - readonly error?: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly resource?: { - readonly count: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - _dd?: { - readonly action?: { - readonly position?: { - readonly x: number; - readonly y: number; - [k: string]: unknown; - }; - target?: { - readonly selector?: string; - readonly width?: number; - readonly height?: number; - [k: string]: unknown; - }; - name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'action'; + readonly action: { + readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; + readonly id?: string; + readonly loading_time?: number; + readonly target?: { + name: string; + [k: string]: unknown; + }; + readonly frustration?: { + readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; + [k: string]: unknown; + }; + readonly error?: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly resource?: { + readonly count: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + _dd?: { + readonly action?: { + readonly position?: { + readonly x: number; + readonly y: number; + [k: string]: unknown; + }; + target?: { + readonly selector?: string; + readonly width?: number; + readonly height?: number; + [k: string]: unknown; + }; + name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 6698f63bae..9a77e661c4 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext > events +Home > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property +DOM events that triggered this action. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 3a381da3c1..7963f4c0d7 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property +Stack trace of where the action was handled by the SDK. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 439b71f394..3305cd25d9 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumActionEventDomainContext +Home > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface +Additional information available when the SDK dispatches a RUM \*\*Action\*\* event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
events? @@ -48,10 +49,9 @@ Event[] -(Optional) +(Optional) DOM events that triggered this action. -
handlingStack? @@ -67,8 +67,7 @@ string -(Optional) +(Optional) Stack trace of where the action was handled by the SDK. -
diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index d539728f58..371dd7c7e2 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumErrorEvent +Home > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type @@ -10,84 +10,84 @@ Schema of all properties of an Error event ```typescript export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'error'; - readonly error: { - readonly id?: string; - message: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - stack?: string; - causes?: { - message: string; - readonly type?: string; - stack?: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - [k: string]: unknown; - }[]; - readonly is_crash?: boolean; - fingerprint?: string; - readonly type?: string; - readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; - readonly handling?: 'handled' | 'unhandled'; - readonly handling_stack?: string; - readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; - readonly resource?: { - readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - readonly status_code: number; - url: string; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - threads?: { - readonly name: string; - readonly crashed: boolean; - readonly stack: string; - readonly state?: string; - [k: string]: unknown; - }[]; - readonly binary_images?: { - readonly uuid: string; - readonly name: string; - readonly is_system: boolean; - readonly load_address?: string; - readonly max_address?: string; - readonly arch?: string; - [k: string]: unknown; - }[]; - readonly was_truncated?: boolean; - readonly meta?: { - readonly code_type?: string; - readonly parent_process?: string; - readonly incident_identifier?: string; - readonly process?: string; - readonly exception_type?: string; - readonly exception_codes?: string; - readonly path?: string; - [k: string]: unknown; - }; - readonly csp?: { - readonly disposition?: 'enforce' | 'report'; - [k: string]: unknown; - }; - readonly time_since_app_start?: number; - [k: string]: unknown; - }; - readonly freeze?: { - readonly duration: number; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'error'; + readonly error: { + readonly id?: string; + message: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + stack?: string; + causes?: { + message: string; + readonly type?: string; + stack?: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + [k: string]: unknown; + }[]; + readonly is_crash?: boolean; + fingerprint?: string; + readonly type?: string; + readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; + readonly handling?: 'handled' | 'unhandled'; + readonly handling_stack?: string; + readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; + readonly resource?: { + readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + readonly status_code: number; + url: string; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + threads?: { + readonly name: string; + readonly crashed: boolean; + readonly stack: string; + readonly state?: string; + [k: string]: unknown; + }[]; + readonly binary_images?: { + readonly uuid: string; + readonly name: string; + readonly is_system: boolean; + readonly load_address?: string; + readonly max_address?: string; + readonly arch?: string; + [k: string]: unknown; + }[]; + readonly was_truncated?: boolean; + readonly meta?: { + readonly code_type?: string; + readonly parent_process?: string; + readonly incident_identifier?: string; + readonly process?: string; + readonly exception_type?: string; + readonly exception_codes?: string; + readonly path?: string; + [k: string]: unknown; + }; + readonly csp?: { + readonly disposition?: 'enforce' | 'report'; + [k: string]: unknown; + }; + readonly time_since_app_start?: number; + [k: string]: unknown; + }; + readonly freeze?: { + readonly duration: number; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index 833d7b2a30..b6893512cc 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext > error +Home > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property +The original error object that was captured. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index fe21529635..0e27ff6e17 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property +Stack trace of where the error was handled by the SDK. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index aa70a3ef61..7c8eae6863 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumErrorEventDomainContext +Home > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface +Additional information available when the SDK dispatches an \*\*Error\*\* event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
error @@ -48,8 +49,9 @@ unknown +The original error object that was captured. + -
handlingStack? @@ -65,8 +67,7 @@ string -(Optional) +(Optional) Stack trace of where the error was handled by the SDK. -
diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 2e3d079ae0..15d672d968 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumEvent +Home > @datadog/browser-rum > RumEvent ## RumEvent type @@ -11,5 +11,5 @@ Schema of all properties of a RUM event ```typescript export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; ``` -**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent +**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 7e9b0b07ea..4d7ad6b101 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,13 +1,15 @@ -Home > @datadog/browser-rum > RumEventDomainContext +Home > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type +Additional context data that varies based on the type of RUM event being dispatched. + **Signature:** ```typescript export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; ``` -**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext +**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 384bf37e94..097cac7751 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property +Error that occurred during the fetch call. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index e8c761d8d7..83fbb50c72 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property +Stack trace of where the resource was handled by the SDK. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 1245b6a516..14793c512d 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property +Whether the fetch call was aborted. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index c93b2f9144..946fabcce8 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface +Additional information available when the SDK dispatches a \*\*Fetch\*\* resource event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
error? @@ -48,10 +49,9 @@ Error -(Optional) +(Optional) Error that occurred during the fetch call. -
handlingStack? @@ -67,10 +67,9 @@ string -(Optional) +(Optional) Stack trace of where the resource was handled by the SDK. -
isAborted @@ -86,8 +85,9 @@ boolean +Whether the fetch call was aborted. + -
performanceEntry? @@ -103,10 +103,9 @@ PerformanceEntry -(Optional) +(Optional) Browser performance entry for this resource. -
requestInit? @@ -122,10 +121,9 @@ RequestInit -(Optional) +(Optional) Init object passed to the fetch call. -
requestInput @@ -141,8 +139,9 @@ RequestInfo +Input parameter passed to the fetch call. + -
response? @@ -158,8 +157,7 @@ Response -(Optional) +(Optional) Response object returned by the fetch call. -
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index dd65de0e81..c50666f58d 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property +Browser performance entry for this resource. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index 49ccfc94fe..c885071c47 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property +Init object passed to the fetch call. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index 66999ec3d0..b847e75b1f 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property +Input parameter passed to the fetch call. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 50db70b5a5..276ef2d3ca 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property +Response object returned by the fetch call. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 1d2b039ff5..906682c862 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addAction +Home > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index fc23fa7b0f..2615b75d88 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addDurationVital +Home > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property @@ -10,9 +10,9 @@ Add a custom duration vital ```typescript addDurationVital: (name: string, options: { - startTime: number; - duration: number; - context?: object; - description?: string; - }) => void; + startTime: number; + duration: number; + context?: object; + description?: string; + }) => void; ``` diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index d560b0591b..7a52a90c05 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumGlobal > addError +Home > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property -Add a custom error, stored in `@error`. +Add a custom error, stored in `@error`. **Signature:** diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 706ce9c41f..6500c0cb05 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation +Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 3fcd32fd26..540b61d72a 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > addTiming +Home > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 07b37b26d5..442c5c4c4e 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > clearAccount +Home > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index c4c687ba47..0a359415ba 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > clearGlobalContext +Home > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property Clear the global context -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index 7e42ce3c9a..a36ebcb3aa 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > clearUser +Home > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property Clear all user information -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index dba65370b3..9207d3f4d7 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getAccount +Home > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 6ca297788e..0c10cdaa6b 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > getGlobalContext +Home > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property Get the global Context -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index 207a9ba9b4..afe51d2e54 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getInitConfiguration +Home > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 9377e29955..5dcd08d42f 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumGlobal > getInternalContext +Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context **Signature:** diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 523e21415a..54c783f0e3 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink +Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property Get the Session Replay Link. -See \Connect Session Replay To Your Third-Party Tools\ for further information. +See Connect Session Replay To Your Third-Party Tools for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index f443dcd8d0..2d8ab5ae00 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > getUser +Home > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property Get user information -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index 7fc407f915..a39be299f6 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > getViewContext +Home > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 1142877612..468eee8769 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > init +Home > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index 7105ac5e3d..22d416aa0c 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumGlobal +Home > @datadog/browser-rum > RumGlobal ## RumGlobal interface +The RUM Browser SDK global object that provides all the public methods. + **Signature:** ```typescript @@ -33,7 +35,6 @@ Type Description -
addAction @@ -44,7 +45,7 @@ Description -(name: string, context?: object) => void +(name: string, context?: object) => void @@ -52,7 +53,6 @@ Description Add a custom action, stored in `@action` -
addDurationVital @@ -63,7 +63,7 @@ Add a custom action, stored in `@action` -(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void +(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void @@ -71,7 +71,6 @@ Add a custom action, stored in `@action` Add a custom duration vital -
addError @@ -82,15 +81,14 @@ Add a custom duration vital -(error: unknown, context?: object) => void +(error: unknown, context?: object) => void -Add a custom error, stored in `@error`. +Add a custom error, stored in `@error`. -
addFeatureFlagEvaluation @@ -101,7 +99,7 @@ Add a custom error, stored in `@error`. -(key: string, value: any) => void +(key: string, value: any) => void @@ -109,7 +107,6 @@ Add a custom error, stored in `@error`. Add a feature flag evaluation, stored in `@feature_flags.` -
addTiming @@ -120,7 +117,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` -(name: string, time?: number) => void +(name: string, time?: number) => void @@ -128,7 +125,6 @@ Add a feature flag evaluation, stored in `@feature_flags.` Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` -
clearAccount @@ -139,7 +135,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. -() => void +() => void @@ -147,7 +143,6 @@ Add a custom timing relative to the start of the current view, stored in `@view. Clear all account information -
clearGlobalContext @@ -158,17 +153,16 @@ Clear all account information -() => void +() => void Clear the global context -See \Global context\ for further information. +See Global context for further information. -
clearUser @@ -179,17 +173,16 @@ See \User session\ for further information. +See User session for further information. -
getAccount @@ -200,7 +193,7 @@ See \
getGlobalContext @@ -219,17 +211,16 @@ Get account information -() => Context +() => Context Get the global Context -See \Global context\ for further information. +See Global context for further information. -
getInitConfiguration @@ -240,7 +231,7 @@ See \RumInitConfiguration | undefined +() => RumInitConfiguration | undefined @@ -248,7 +239,6 @@ See \getInternalContext @@ -259,15 +249,14 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext | undefined -\[Internal API\] Get the internal SDK context +[Internal API] Get the internal SDK context -
getSessionReplayLink @@ -278,17 +267,16 @@ Get the init configuration -() => string | undefined +() => string | undefined Get the Session Replay Link. -See \Connect Session Replay To Your Third-Party Tools\ for further information. +See Connect Session Replay To Your Third-Party Tools for further information. -
getUser @@ -299,17 +287,16 @@ See \User session\ for further information. +See User session for further information. -
getViewContext @@ -320,7 +307,7 @@ See \
init @@ -339,7 +325,7 @@ Get View Context. -(initConfiguration: RumInitConfiguration) => void +(initConfiguration: RumInitConfiguration) => void @@ -347,7 +333,6 @@ Get View Context. Init the RUM browser SDK. -
removeAccountProperty @@ -358,7 +343,7 @@ Init the RUM browser SDK. -(key: string) => void +(key: string) => void @@ -366,7 +351,6 @@ Init the RUM browser SDK. Remove an account property -
removeGlobalContextProperty @@ -377,17 +361,16 @@ Remove an account property -(key: any) => void +(key: any) => void Remove a global context property -See \Global context\ for further information. +See Global context for further information. -
removeUserProperty @@ -398,17 +381,16 @@ See \User session\ for further information. +See User session for further information. -
setAccount @@ -419,7 +401,7 @@ See \
setAccountProperty @@ -438,7 +419,7 @@ Set account information to all events, stored in `@account` -(key: string, property: any) => void +(key: string, property: any) => void @@ -446,7 +427,6 @@ Set account information to all events, stored in `@account` Set or update the account property, stored in `@account.` -
setGlobalContext @@ -457,7 +437,7 @@ Set or update the account property, stored in `@account.` -(context: any) => void +(context: any) => void @@ -465,7 +445,6 @@ Set or update the account property, stored in `@account.` Set the global context information to all events, stored in `@context` -
setGlobalContextProperty @@ -476,7 +455,7 @@ Set the global context information to all events, stored in `@context` -(key: any, value: any) => void +(key: any, value: any) => void @@ -484,7 +463,6 @@ Set the global context information to all events, stored in `@context` Set or update a global context property, stored in `@context.` -
setTrackingConsent @@ -495,7 +473,7 @@ Set or update a global context property, stored in `@context.` -(trackingConsent: TrackingConsent) => void +(trackingConsent: TrackingConsent) => void @@ -503,7 +481,6 @@ Set or update a global context property, stored in `@context.` Set the tracking consent of the current user. -
setUserProperty @@ -514,7 +491,7 @@ Set the tracking consent of the current user. -(key: any, property: any) => void +(key: any, property: any) => void @@ -522,7 +499,6 @@ Set the tracking consent of the current user. Set or update the user property, stored in `@usr.` -
setViewContext @@ -533,7 +509,7 @@ Set or update the user property, stored in `@usr.` -(context: Context) => void +(context: Context) => void @@ -543,7 +519,6 @@ Set View Context. Enable to manually set the context of the current view. -
setViewContextProperty @@ -554,7 +529,7 @@ Enable to manually set the context of the current view. -(key: string, value: any) => void +(key: string, value: any) => void @@ -564,7 +539,6 @@ Set View Context Property. Enable to manually set a property of the context of the current view. -
setViewName @@ -575,7 +549,7 @@ Enable to manually set a property of the context of the current view. -(name: string) => void +(name: string) => void @@ -585,7 +559,6 @@ Set View Name. Enable to manually change the name of the current view. -
startDurationVital @@ -596,7 +569,7 @@ Enable to manually change the name of the current view. -(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference +(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference @@ -606,7 +579,6 @@ Start a custom duration vital. If you plan to have multiple durations for the same vital, you should use the reference returned by this method. -
startSessionReplayRecording @@ -617,17 +589,16 @@ If you plan to have multiple durations for the same vital, you should use the re -(options?: StartRecordingOptions) => void +(options?: StartRecordingOptions) => void Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. -
startView @@ -643,10 +614,9 @@ See \stopDurationVital @@ -657,7 +627,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void +(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void @@ -665,7 +635,6 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t Stop a custom duration vital -
stopSession @@ -676,7 +645,7 @@ Stop a custom duration vital -() => void +() => void @@ -684,7 +653,6 @@ Stop a custom duration vital Stop the session. A new session will start at the next user interaction with the page. -
stopSessionReplayRecording @@ -695,17 +663,16 @@ Stop the session. A new session will start at the next user interaction with the -() => void +() => void Stop Session Replay recording. -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. -
## Methods @@ -720,7 +687,6 @@ Method Description -
setUser(newUser) @@ -730,10 +696,9 @@ Description Set user information to all events, stored in `@usr` -See \User session\ for further information. +See User session for further information. -
setUser(newUser) @@ -744,5 +709,4 @@ See \Home > @datadog/browser-rum > RumGlobal > removeAccountProperty +Home > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index b57a72c511..70a6cc418d 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property Remove a global context property -See \Global context\ for further information. +See Global context for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index 190cc5cf6d..b49f944b0a 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > removeUserProperty +Home > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property Remove a user property -See \User session\ for further information. +See User session for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index a559156d79..282ddeffb7 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setAccount +Home > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 6d41e04cb2..9c6cdaa4b6 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setAccountProperty +Home > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 08d98484b9..037b8fb12d 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setGlobalContext +Home > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 542c3c639b..63132b3c24 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index 41efadfec9..a6438b3028 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setTrackingConsent +Home > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index a086a3e0f5..b4b4e483ff 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,19 +1,19 @@ -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method Set user information to all events, stored in `@usr` -See \User session\ for further information. +See User session for further information. **Signature:** ```typescript setUser(newUser: User & { - id: string; - }): void; + id: string; + }): void; ``` ## Parameters @@ -33,7 +33,6 @@ Type Description -
newUser @@ -41,13 +40,12 @@ newUser -User & { id: string; } +User & { id: string; } -
**Returns:** diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 972a0ae9f2..731ada6a66 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method @@ -34,7 +34,6 @@ Type Description -
newUser @@ -48,7 +47,6 @@ User -
**Returns:** diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 1165900244..53c490fc62 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setUserProperty +Home > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 95f2670ab2..85afdb7c2c 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewContext +Home > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index 19adf5c441..a320a525a6 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewContextProperty +Home > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 5077efb0d9..2fb7ffec9b 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > setViewName +Home > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 58a2ff805c..8cfd1f3788 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > startDurationVital +Home > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property @@ -12,7 +12,7 @@ If you plan to have multiple durations for the same vital, you should use the re ```typescript startDurationVital: (name: string, options?: { - context?: object; - description?: string; - }) => DurationVitalReference; + context?: object; + description?: string; + }) => DurationVitalReference; ``` diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 8cb1159886..81bc8f1613 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index efddb37e3a..b4be83846a 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,16 +1,16 @@ -Home > @datadog/browser-rum > RumGlobal > startView +Home > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property -Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing. +Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you've defined them in your SPA application routing. **Signature:** ```typescript startView: { - (name?: string): void; - (options: ViewOptions): void; - }; + (name?: string): void; + (options: ViewOptions): void; + }; ``` diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index 40272a366e..de6c4d82ff 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > stopDurationVital +Home > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property @@ -10,7 +10,7 @@ Stop a custom duration vital ```typescript stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { - context?: object; - description?: string; - }) => void; + context?: object; + description?: string; + }) => void; ``` diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index 776655c5cf..b0d56aae9c 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumGlobal > stopSession +Home > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index fac27e9aa0..8ca302e154 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,12 +1,12 @@ -Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property Stop Session Replay recording. -See \Browser Session Replay\ for further information. +See Browser Session Replay for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 1e48a2c7ef..3427bb3d4b 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute +Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 7804d4d183..6edf17216e 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls +Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index b93cb36c87..c24305b9f1 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > applicationId +Home > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 40e6814128..091f921c57 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > beforeSend +Home > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 3413d6cb14..9d99f6048a 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests +Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index d82ab6acac..df1456fe6e 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel +Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property -Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index 71a0cbe060..bfccd771d6 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName +Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index af9c9bf573..e1273d2789 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls +Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index fe1b53e070..6f4bc98536 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumInitConfiguration +Home > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface +Configuration options to pass to the `init()` method when initializing the RUM SDK. + **Signature:** ```typescript @@ -33,7 +35,6 @@ Type Description -
actionNameAttribute? @@ -52,7 +53,6 @@ string | undefined (Optional) Specify your own attribute to use to name actions. See Declare a name for click actions for further information. -
allowedTracingUrls? @@ -63,7 +63,7 @@ string | undefined -Array<MatchOption | TracingOption> | undefined +Array | undefined @@ -71,7 +71,6 @@ Array<MatchOption | TracingOption> | undefined (Optional) A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. -
applicationId @@ -90,7 +89,6 @@ string The RUM application ID. -
beforeSend? @@ -101,7 +99,7 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined @@ -111,7 +109,6 @@ The RUM application ID. See Enrich And Control Browser RUM Data With beforeSend for further information. -
compressIntakeRequests? @@ -130,7 +127,6 @@ boolean | undefined (Optional) Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. -
defaultPrivacyLevel? @@ -146,10 +142,9 @@ DefaultPrivacyLevel | undefined -(Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +(Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. -
enablePrivacyForActionName? @@ -168,7 +163,6 @@ boolean | undefined (Optional) Enables privacy control for action names. -
excludedActivityUrls? @@ -187,7 +181,6 @@ MatchOption[] | undefined (Optional) A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. -
plugins? @@ -206,7 +199,6 @@ RumPlugin[] | undefined (Optional) List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. -
profilingSampleRate? @@ -222,10 +214,9 @@ number | undefined -(Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +(Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 -
propagateTraceBaggage? @@ -241,10 +232,9 @@ boolean | undefined -(Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false +(Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false -
remoteConfigurationId? @@ -263,7 +253,6 @@ string | undefined (Optional) Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. -
sessionReplaySampleRate? @@ -279,10 +268,9 @@ number | undefined -(Optional) The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +(Optional) The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. -
startSessionReplayRecordingManually? @@ -301,7 +289,6 @@ boolean | undefined (Optional) If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. -
subdomain? @@ -320,7 +307,6 @@ string (Optional) If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. -
traceContextInjection? @@ -336,10 +322,9 @@ TraceContextInjection | undefined -(Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +(Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. -
traceSampleRate? @@ -358,7 +343,6 @@ number | undefined (Optional) The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. -
trackFeatureFlagsForEvents? @@ -377,7 +361,6 @@ FeatureFlagsForEvents[] (Optional) Enables collection of features flags in chosen events. -
trackLongTasks? @@ -393,10 +376,9 @@ boolean | undefined -(Optional) Enables collection of long task events. true +(Optional) Enables collection of long task events. true -
trackResources? @@ -412,10 +394,9 @@ boolean | undefined -(Optional) Enables collection of resource events. true +(Optional) Enables collection of resource events. true -
trackUserInteractions? @@ -431,10 +412,9 @@ boolean | undefined -(Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true +(Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true -
trackViewsManually? @@ -453,7 +433,6 @@ boolean | undefined (Optional) Allows you to control RUM views creation. See Override default RUM view names for further information. -
workerUrl? @@ -472,5 +451,4 @@ string (Optional) URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. -
diff --git a/docs/browser-rum.ruminitconfiguration.plugins.md b/docs/browser-rum.ruminitconfiguration.plugins.md index 1e521d1a29..9eef7688ca 100644 --- a/docs/browser-rum.ruminitconfiguration.plugins.md +++ b/docs/browser-rum.ruminitconfiguration.plugins.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > plugins +Home > @datadog/browser-rum > RumInitConfiguration > plugins ## RumInitConfiguration.plugins property diff --git a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md index c08a3537d5..4387987ca1 100644 --- a/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.profilingsamplerate.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > profilingSampleRate ## RumInitConfiguration.profilingSampleRate property -Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md index 42f57c809a..726e6a232a 100644 --- a/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md +++ b/docs/browser-rum.ruminitconfiguration.propagatetracebaggage.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage +Home > @datadog/browser-rum > RumInitConfiguration > propagateTraceBaggage ## RumInitConfiguration.propagateTraceBaggage property -Whether to propagate user and account IDs in the baggage header of trace requests. false +Whether to propagate user and account IDs in the baggage header of trace requests. false **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md index 925f00267a..dfd05d19be 100644 --- a/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md +++ b/docs/browser-rum.ruminitconfiguration.remoteconfigurationid.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId +Home > @datadog/browser-rum > RumInitConfiguration > remoteConfigurationId ## RumInitConfiguration.remoteConfigurationId property diff --git a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md index 0057df27ea..e21045d625 100644 --- a/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.sessionreplaysamplerate.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate +Home > @datadog/browser-rum > RumInitConfiguration > sessionReplaySampleRate ## RumInitConfiguration.sessionReplaySampleRate property -The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md index 427130229c..be9a682fe4 100644 --- a/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md +++ b/docs/browser-rum.ruminitconfiguration.startsessionreplayrecordingmanually.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually +Home > @datadog/browser-rum > RumInitConfiguration > startSessionReplayRecordingManually ## RumInitConfiguration.startSessionReplayRecordingManually property diff --git a/docs/browser-rum.ruminitconfiguration.subdomain.md b/docs/browser-rum.ruminitconfiguration.subdomain.md index ed3d388410..8d460d94d8 100644 --- a/docs/browser-rum.ruminitconfiguration.subdomain.md +++ b/docs/browser-rum.ruminitconfiguration.subdomain.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > subdomain +Home > @datadog/browser-rum > RumInitConfiguration > subdomain ## RumInitConfiguration.subdomain property diff --git a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md index b5593bdb99..0ab150c0e6 100644 --- a/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md +++ b/docs/browser-rum.ruminitconfiguration.tracecontextinjection.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection +Home > @datadog/browser-rum > RumInitConfiguration > traceContextInjection ## RumInitConfiguration.traceContextInjection property -If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md index f509245641..aaad5ff369 100644 --- a/docs/browser-rum.ruminitconfiguration.tracesamplerate.md +++ b/docs/browser-rum.ruminitconfiguration.tracesamplerate.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate +Home > @datadog/browser-rum > RumInitConfiguration > traceSampleRate ## RumInitConfiguration.traceSampleRate property diff --git a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md index 11f8345f45..6eeacadda5 100644 --- a/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md +++ b/docs/browser-rum.ruminitconfiguration.trackfeatureflagsforevents.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents +Home > @datadog/browser-rum > RumInitConfiguration > trackFeatureFlagsForEvents ## RumInitConfiguration.trackFeatureFlagsForEvents property diff --git a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md index 8b2b7a0f5f..a2a157e639 100644 --- a/docs/browser-rum.ruminitconfiguration.tracklongtasks.md +++ b/docs/browser-rum.ruminitconfiguration.tracklongtasks.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks +Home > @datadog/browser-rum > RumInitConfiguration > trackLongTasks ## RumInitConfiguration.trackLongTasks property -Enables collection of long task events. true +Enables collection of long task events. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackresources.md b/docs/browser-rum.ruminitconfiguration.trackresources.md index 9c05a1120b..0bef3c1d99 100644 --- a/docs/browser-rum.ruminitconfiguration.trackresources.md +++ b/docs/browser-rum.ruminitconfiguration.trackresources.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackResources +Home > @datadog/browser-rum > RumInitConfiguration > trackResources ## RumInitConfiguration.trackResources property -Enables collection of resource events. true +Enables collection of resource events. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md index 198c9f2565..cd03846cb0 100644 --- a/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md +++ b/docs/browser-rum.ruminitconfiguration.trackuserinteractions.md @@ -1,10 +1,10 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions +Home > @datadog/browser-rum > RumInitConfiguration > trackUserInteractions ## RumInitConfiguration.trackUserInteractions property -Enables automatic collection of users actions. See Tracking User Actions for further information. true +Enables automatic collection of users actions. See Tracking User Actions for further information. true **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md index d028a6d8ac..a74d32f90e 100644 --- a/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md +++ b/docs/browser-rum.ruminitconfiguration.trackviewsmanually.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually +Home > @datadog/browser-rum > RumInitConfiguration > trackViewsManually ## RumInitConfiguration.trackViewsManually property diff --git a/docs/browser-rum.ruminitconfiguration.workerurl.md b/docs/browser-rum.ruminitconfiguration.workerurl.md index fdb93f3581..018db81b83 100644 --- a/docs/browser-rum.ruminitconfiguration.workerurl.md +++ b/docs/browser-rum.ruminitconfiguration.workerurl.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumInitConfiguration > workerUrl +Home > @datadog/browser-rum > RumInitConfiguration > workerUrl ## RumInitConfiguration.workerUrl property diff --git a/docs/browser-rum.rumlongtaskevent.md b/docs/browser-rum.rumlongtaskevent.md index 4bec40e6c7..ff58b3c6d6 100644 --- a/docs/browser-rum.rumlongtaskevent.md +++ b/docs/browser-rum.rumlongtaskevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumLongTaskEvent +Home > @datadog/browser-rum > RumLongTaskEvent ## RumLongTaskEvent type @@ -10,38 +10,38 @@ Schema of all properties of a Long Task event ```typescript export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'long_task'; - readonly long_task: { - readonly id?: string; - readonly start_time?: number; - readonly entry_type?: 'long-task' | 'long-animation-frame'; - readonly duration: number; - readonly blocking_duration?: number; - readonly render_start?: number; - readonly style_and_layout_start?: number; - readonly first_ui_event_timestamp?: number; - readonly is_frozen_frame?: boolean; - readonly scripts?: { - readonly duration?: number; - readonly pause_duration?: number; - readonly forced_style_and_layout_duration?: number; - readonly start_time?: number; - readonly execution_start?: number; - source_url?: string; - readonly source_function_name?: string; - readonly source_char_position?: number; - invoker?: string; - readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; - readonly window_attribution?: string; - [k: string]: unknown; - }[]; - [k: string]: unknown; - }; - readonly _dd?: { - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'long_task'; + readonly long_task: { + readonly id?: string; + readonly start_time?: number; + readonly entry_type?: 'long-task' | 'long-animation-frame'; + readonly duration: number; + readonly blocking_duration?: number; + readonly render_start?: number; + readonly style_and_layout_start?: number; + readonly first_ui_event_timestamp?: number; + readonly is_frozen_frame?: boolean; + readonly scripts?: { + readonly duration?: number; + readonly pause_duration?: number; + readonly forced_style_and_layout_duration?: number; + readonly start_time?: number; + readonly execution_start?: number; + source_url?: string; + readonly source_function_name?: string; + readonly source_char_position?: number; + invoker?: string; + readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script'; + readonly window_attribution?: string; + [k: string]: unknown; + }[]; + [k: string]: unknown; + }; + readonly _dd?: { + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 47e7b1500f..7c09ee9a68 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumLongTaskEventDomainContext +Home > @datadog/browser-rum > RumLongTaskEventDomainContext ## RumLongTaskEventDomainContext interface +Additional information available when the SDK dispatches a \*\*Long Task\*\* event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
performanceEntry @@ -48,6 +49,7 @@ PerformanceEntry +Browser performance entry for this long task. + -
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index 71f23621a5..fe9607ae38 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property +Browser performance entry for this long task. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 316fd6bedf..a84b2c7313 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface +Additional information available when the SDK dispatches a \*\*Resource\*\* event that is neither fetch nor XHR. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
performanceEntry @@ -48,6 +49,7 @@ PerformanceEntry +Browser performance entry for this resource. + -
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 6bc0840e08..2722850cd7 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property +Browser performance entry for this resource. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index 20eb3f5607..e20b147b5b 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumResourceEvent +Home > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type @@ -10,79 +10,79 @@ Schema of all properties of a Resource event ```typescript export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'resource'; - readonly resource: { - readonly id?: string; - readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; - readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - url: string; - readonly status_code?: number; - readonly duration?: number; - readonly size?: number; - readonly encoded_body_size?: number; - readonly decoded_body_size?: number; - readonly transfer_size?: number; - readonly render_blocking_status?: 'blocking' | 'non-blocking'; - readonly worker?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly redirect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly dns?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly connect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly ssl?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly first_byte?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly download?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly protocol?: string; - readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - readonly graphql?: { - readonly operationType: 'query' | 'mutation' | 'subscription'; - readonly operationName?: string; - payload?: string; - variables?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly span_id?: string; - readonly trace_id?: string; - readonly rule_psr?: number; - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'resource'; + readonly resource: { + readonly id?: string; + readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; + readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + url: string; + readonly status_code?: number; + readonly duration?: number; + readonly size?: number; + readonly encoded_body_size?: number; + readonly decoded_body_size?: number; + readonly transfer_size?: number; + readonly render_blocking_status?: 'blocking' | 'non-blocking'; + readonly worker?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly redirect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly dns?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly connect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly ssl?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly first_byte?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly download?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly protocol?: string; + readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + readonly graphql?: { + readonly operationType: 'query' | 'mutation' | 'subscription'; + readonly operationName?: string; + payload?: string; + variables?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly span_id?: string; + readonly trace_id?: string; + readonly rule_psr?: number; + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index 14076df1df..c987fd0d9e 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumViewEvent +Home > @datadog/browser-rum > RumViewEvent ## RumViewEvent type @@ -10,133 +10,133 @@ Schema of all properties of a View event ```typescript export type RumViewEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'view'; - readonly view: { - readonly loading_time?: number; - readonly network_settled_time?: number; - readonly interaction_to_next_view_time?: number; - readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; - readonly time_spent: number; - readonly first_contentful_paint?: number; - readonly largest_contentful_paint?: number; - readonly largest_contentful_paint_target_selector?: string; - readonly first_input_delay?: number; - readonly first_input_time?: number; - readonly first_input_target_selector?: string; - readonly interaction_to_next_paint?: number; - readonly interaction_to_next_paint_time?: number; - readonly interaction_to_next_paint_target_selector?: string; - readonly cumulative_layout_shift?: number; - readonly cumulative_layout_shift_time?: number; - readonly cumulative_layout_shift_target_selector?: string; - readonly dom_complete?: number; - readonly dom_content_loaded?: number; - readonly dom_interactive?: number; - readonly load_event?: number; - readonly first_byte?: number; - readonly custom_timings?: { - [k: string]: number; - }; - readonly is_active?: boolean; - readonly is_slow_rendered?: boolean; - readonly action: { - readonly count: number; - [k: string]: unknown; - }; - readonly error: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly frozen_frame?: { - readonly count: number; - [k: string]: unknown; - }; - readonly slow_frames?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly resource: { - readonly count: number; - [k: string]: unknown; - }; - readonly frustration?: { - readonly count: number; - [k: string]: unknown; - }; - readonly in_foreground_periods?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly memory_average?: number; - readonly memory_max?: number; - readonly cpu_ticks_count?: number; - readonly cpu_ticks_per_second?: number; - readonly refresh_rate_average?: number; - readonly refresh_rate_min?: number; - readonly slow_frames_rate?: number; - readonly freeze_rate?: number; - flutter_build_time?: RumPerfMetric; - flutter_raster_time?: RumPerfMetric; - js_refresh_rate?: RumPerfMetric; - performance?: ViewPerformanceData; - [k: string]: unknown; - }; - readonly session?: { - readonly is_active?: boolean; - readonly sampled_for_replay?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - readonly privacy?: { - readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; - [k: string]: unknown; - }; - readonly _dd: { - readonly document_version: number; - readonly page_states?: { - readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; - readonly start: number; - [k: string]: unknown; - }[]; - replay_stats?: { - records_count?: number; - segments_count?: number; - segments_total_raw_size?: number; - [k: string]: unknown; - }; - readonly cls?: { - readonly device_pixel_ratio?: number; - [k: string]: unknown; - }; - readonly configuration?: { - readonly start_session_replay_recording_manually?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly display?: { - readonly scroll?: { - readonly max_depth: number; - readonly max_depth_scroll_top: number; - readonly max_scroll_height: number; - readonly max_scroll_height_time: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'view'; + readonly view: { + readonly loading_time?: number; + readonly network_settled_time?: number; + readonly interaction_to_next_view_time?: number; + readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; + readonly time_spent: number; + readonly first_contentful_paint?: number; + readonly largest_contentful_paint?: number; + readonly largest_contentful_paint_target_selector?: string; + readonly first_input_delay?: number; + readonly first_input_time?: number; + readonly first_input_target_selector?: string; + readonly interaction_to_next_paint?: number; + readonly interaction_to_next_paint_time?: number; + readonly interaction_to_next_paint_target_selector?: string; + readonly cumulative_layout_shift?: number; + readonly cumulative_layout_shift_time?: number; + readonly cumulative_layout_shift_target_selector?: string; + readonly dom_complete?: number; + readonly dom_content_loaded?: number; + readonly dom_interactive?: number; + readonly load_event?: number; + readonly first_byte?: number; + readonly custom_timings?: { + [k: string]: number; + }; + readonly is_active?: boolean; + readonly is_slow_rendered?: boolean; + readonly action: { + readonly count: number; + [k: string]: unknown; + }; + readonly error: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly frozen_frame?: { + readonly count: number; + [k: string]: unknown; + }; + readonly slow_frames?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly resource: { + readonly count: number; + [k: string]: unknown; + }; + readonly frustration?: { + readonly count: number; + [k: string]: unknown; + }; + readonly in_foreground_periods?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly memory_average?: number; + readonly memory_max?: number; + readonly cpu_ticks_count?: number; + readonly cpu_ticks_per_second?: number; + readonly refresh_rate_average?: number; + readonly refresh_rate_min?: number; + readonly slow_frames_rate?: number; + readonly freeze_rate?: number; + flutter_build_time?: RumPerfMetric; + flutter_raster_time?: RumPerfMetric; + js_refresh_rate?: RumPerfMetric; + performance?: ViewPerformanceData; + [k: string]: unknown; + }; + readonly session?: { + readonly is_active?: boolean; + readonly sampled_for_replay?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + readonly privacy?: { + readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; + [k: string]: unknown; + }; + readonly _dd: { + readonly document_version: number; + readonly page_states?: { + readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; + readonly start: number; + [k: string]: unknown; + }[]; + replay_stats?: { + records_count?: number; + segments_count?: number; + segments_total_raw_size?: number; + [k: string]: unknown; + }; + readonly cls?: { + readonly device_pixel_ratio?: number; + [k: string]: unknown; + }; + readonly configuration?: { + readonly start_session_replay_recording_manually?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly display?: { + readonly scroll?: { + readonly max_depth: number; + readonly max_depth_scroll_top: number; + readonly max_scroll_height: number; + readonly max_scroll_height_time: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 084978dfb8..7a799fcd87 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumViewEventDomainContext > location +Home > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property +The browser location object at the time the view was created. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index f2d51a2686..9a39af6570 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumViewEventDomainContext +Home > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface +Additional information available when the SDK dispatches a RUM \*\*View\*\* event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
location @@ -43,11 +44,12 @@ Description -Readonly<Location> +Readonly +The browser location object at the time the view was created. + -
diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index 95c1c41d20..af5e5ead83 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,6 +1,6 @@ -Home > @datadog/browser-rum > RumVitalEvent +Home > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type @@ -10,26 +10,26 @@ Schema of all properties of a Vital event ```typescript export type RumVitalEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'vital'; - readonly vital: { - readonly type: 'duration'; - readonly id: string; - readonly name?: string; - readonly description?: string; - readonly duration?: number; - readonly custom?: { - [k: string]: number; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly vital?: { - readonly computed_value?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'vital'; + readonly vital: { + readonly type: 'duration'; + readonly id: string; + readonly name?: string; + readonly description?: string; + readonly duration?: number; + readonly custom?: { + [k: string]: number; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly vital?: { + readonly computed_value?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` **References:** CommonProperties diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index c3c3e7c215..281d2dfa70 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property +Stack trace of where the resource was handled by the SDK. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 1da2a404dc..530e163f13 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property +Whether the XHR request was aborted. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 23ec8cab4f..72c52eba01 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface +Additional information available when the SDK dispatches an \*\*XHR\*\* resource event. + **Signature:** ```typescript @@ -32,7 +34,6 @@ Type Description -
handlingStack? @@ -48,10 +49,9 @@ string -(Optional) +(Optional) Stack trace of where the resource was handled by the SDK. -
isAborted @@ -67,8 +67,9 @@ boolean +Whether the XHR request was aborted. + -
performanceEntry? @@ -84,10 +85,9 @@ PerformanceEntry -(Optional) +(Optional) Browser performance entry for this resource. -
xhr @@ -103,6 +103,7 @@ XMLHttpRequest +The XMLHttpRequest object that made the request. + -
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index 23288a5767..ad493c8d8c 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property +Browser performance entry for this resource. + **Signature:** ```typescript diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 7a02ed5a6c..924188c86b 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,9 +1,11 @@ -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property +The XMLHttpRequest object that made the request. + **Signature:** ```typescript diff --git a/docs/index.md b/docs/index.md index 752a2b7655..675c0c5108 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,6 @@ Package Description -
@datadog/browser-logs @@ -27,7 +26,6 @@ Description Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Provides comprehensive logging capabilities with automatic error tracking and custom log collection. -
@datadog/browser-rum @@ -38,7 +36,6 @@ Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience. -
@datadog/browser-rum-react @@ -49,7 +46,6 @@ Datadog Browser RUM SDK - Full version with Session Replay and Real User Profili Datadog Browser RUM React Integration - Additional components and hooks for React applications. Provides React-specific features like Error Boundaries and component performance tracking. -
@datadog/browser-rum-slim @@ -60,5 +56,4 @@ Datadog Browser RUM React Integration - Additional components and hooks for Reac Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. Lightweight alternative for basic RUM monitoring with reduced bundle size. -
diff --git a/etc/browser-rum.api.json b/etc/browser-rum.api.json index 0d46c4179e..377856ad0f 100644 --- a/etc/browser-rum.api.json +++ b/etc/browser-rum.api.json @@ -182,7 +182,7 @@ "text": "export interface CommonProperties " } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "CommonProperties", "preserveMemberOrder": false, @@ -803,7 +803,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumActionEvent", "typeTokenRange": { @@ -814,14 +814,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches a RUM **Action** event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumActionEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumActionEventDomainContext", "preserveMemberOrder": false, @@ -829,7 +829,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#events:member", - "docComment": "", + "docComment": "/**\n * DOM events that triggered this action.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -861,7 +861,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumActionEventDomainContext#handlingStack:member", - "docComment": "", + "docComment": "/**\n * Stack trace of where the action was handled by the SDK.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -929,7 +929,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumErrorEvent", "typeTokenRange": { @@ -940,14 +940,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches an **Error** event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumErrorEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumErrorEventDomainContext", "preserveMemberOrder": false, @@ -955,7 +955,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#error:member", - "docComment": "", + "docComment": "/**\n * The original error object that was captured.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -982,7 +982,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumErrorEventDomainContext#handlingStack:member", - "docComment": "", + "docComment": "/**\n * Stack trace of where the error was handled by the SDK.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1073,7 +1073,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumEvent", "typeTokenRange": { @@ -1084,7 +1084,7 @@ { "kind": "TypeAlias", "canonicalReference": "@datadog/browser-rum!RumEventDomainContext:type", - "docComment": "", + "docComment": "/**\n * Additional context data that varies based on the type of RUM event being dispatched.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1231,7 +1231,7 @@ { "kind": "Reference", "text": "RumVitalEventDomainContext", - "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:interface" + "canonicalReference": "@datadog/browser-rum!RumVitalEventDomainContext:type" }, { "kind": "Content", @@ -1242,7 +1242,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumEventDomainContext", "typeParameters": [ @@ -1266,14 +1266,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches a **Fetch** resource event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumFetchResourceEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumFetchResourceEventDomainContext", "preserveMemberOrder": false, @@ -1281,7 +1281,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#error:member", - "docComment": "", + "docComment": "/**\n * Error that occurred during the fetch call.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1309,7 +1309,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#handlingStack:member", - "docComment": "", + "docComment": "/**\n * Stack trace of where the resource was handled by the SDK.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1336,7 +1336,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#isAborted:member", - "docComment": "", + "docComment": "/**\n * Whether the fetch call was aborted.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1363,7 +1363,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#performanceEntry:member", - "docComment": "", + "docComment": "/**\n * Browser performance entry for this resource.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1391,7 +1391,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInit:member", - "docComment": "", + "docComment": "/**\n * Init object passed to the fetch call.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1419,7 +1419,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#requestInput:member", - "docComment": "", + "docComment": "/**\n * Input parameter passed to the fetch call.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1447,7 +1447,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumFetchResourceEventDomainContext#response:member", - "docComment": "", + "docComment": "/**\n * Response object returned by the fetch call.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1478,7 +1478,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumGlobal:interface", - "docComment": "", + "docComment": "/**\n * The RUM Browser SDK global object that provides all the public methods.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1494,7 +1494,7 @@ "text": " " } ], - "fileUrlPath": "packages/rum-core/cjs/boot/rumPublicApi.d.ts", + "fileUrlPath": "packages/rum-core/esm/boot/rumPublicApi.d.ts", "releaseTag": "Public", "name": "RumGlobal", "preserveMemberOrder": false, @@ -2496,7 +2496,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumGlobal#startView:member", - "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you’ve defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", + "docComment": "/**\n * Start a view manually. Enable to manual start a view, use `trackViewsManually: true` init parameter and call `startView()` to create RUM views and be aligned with how you've defined them in your SPA application routing.\n *\n * @param - options.name name of the view\n *\n * @param - options.service service of the view\n *\n * @param - options.version version of the view\n *\n * See [Override default RUM view names](https://docs.datadoghq.com/real_user_monitoring/browser/advanced_configuration/#override-default-rum-view-names) for further information.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2630,7 +2630,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumInitConfiguration:interface", - "docComment": "", + "docComment": "/**\n * Configuration options to pass to the `init()` method when initializing the RUM SDK.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2646,7 +2646,7 @@ "text": " " } ], - "fileUrlPath": "packages/rum-core/cjs/domain/configuration/configuration.d.ts", + "fileUrlPath": "packages/rum-core/esm/domain/configuration/configuration.d.ts", "releaseTag": "Public", "name": "RumInitConfiguration", "preserveMemberOrder": false, @@ -3387,7 +3387,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumLongTaskEvent", "typeTokenRange": { @@ -3398,14 +3398,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches a **Long Task** event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumLongTaskEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumLongTaskEventDomainContext", "preserveMemberOrder": false, @@ -3413,7 +3413,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumLongTaskEventDomainContext#performanceEntry:member", - "docComment": "", + "docComment": "/**\n * Browser performance entry for this long task.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3444,14 +3444,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches a **Resource** event that is neither fetch nor XHR.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumOtherResourceEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumOtherResourceEventDomainContext", "preserveMemberOrder": false, @@ -3459,7 +3459,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumOtherResourceEventDomainContext#performanceEntry:member", - "docComment": "", + "docComment": "/**\n * Browser performance entry for this resource.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3528,7 +3528,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumResourceEvent", "typeTokenRange": { @@ -3604,7 +3604,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumViewEvent", "typeTokenRange": { @@ -3615,14 +3615,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches a RUM **View** event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumViewEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumViewEventDomainContext", "preserveMemberOrder": false, @@ -3630,7 +3630,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumViewEventDomainContext#location:member", - "docComment": "", + "docComment": "/**\n * The browser location object at the time the view was created.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3703,7 +3703,7 @@ "text": ";" } ], - "fileUrlPath": "packages/rum-core/cjs/rumEvent.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/rumEvent.types.d.ts", "releaseTag": "Public", "name": "RumVitalEvent", "typeTokenRange": { @@ -3714,14 +3714,14 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext:interface", - "docComment": "", + "docComment": "/**\n * Additional information available when the SDK dispatches an **XHR** resource event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RumXhrResourceEventDomainContext " } ], - "fileUrlPath": "packages/rum-core/cjs/domainContext.types.d.ts", + "fileUrlPath": "packages/rum-core/esm/domainContext.types.d.ts", "releaseTag": "Public", "name": "RumXhrResourceEventDomainContext", "preserveMemberOrder": false, @@ -3729,7 +3729,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#handlingStack:member", - "docComment": "", + "docComment": "/**\n * Stack trace of where the resource was handled by the SDK.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3756,7 +3756,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#isAborted:member", - "docComment": "", + "docComment": "/**\n * Whether the XHR request was aborted.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3783,7 +3783,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#performanceEntry:member", - "docComment": "", + "docComment": "/**\n * Browser performance entry for this resource.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3811,7 +3811,7 @@ { "kind": "PropertySignature", "canonicalReference": "@datadog/browser-rum!RumXhrResourceEventDomainContext#xhr:member", - "docComment": "", + "docComment": "/**\n * The XMLHttpRequest object that made the request.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/packages/rum-core/package.json b/packages/rum-core/package.json index 5d3fb4b0ea..72467b3466 100644 --- a/packages/rum-core/package.json +++ b/packages/rum-core/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "main": "cjs/index.js", "module": "esm/index.js", - "types": "cjs/index.d.ts", + "types": "esm/index.d.ts", "scripts": { "pack": "yarn pack", "build": "run-p build:cjs build:esm", diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js index 482c725054..028ae689b4 100644 --- a/scripts/fix-api-docs-final.js +++ b/scripts/fix-api-docs-final.js @@ -24,15 +24,120 @@ function convertMarkdownLinks(content) { }) } -function processDocFile(file) { - console.log(`Processing: ${file}`) +function fixHtmlEntities(content) { + content = content.replace(/>/g, '>') + content = content.replace(/</g, '<') + content = content.replace(/&/g, '&') + content = content.replace(/"/g, '"') + + content = content.replace(/=>/g, '=>') + + return content +} + +function removeEmptyHtmlComments(content) { + return content.replace(//g, '') +} + +function fixHtmlTables(content) { + const lines = content.split('\n') + const fixedLines = [] + let inTable = false + let currentRow = [] + + for (let i = 0; i < lines.length; i++) { + const line = lines[i].trim() + + if (line.includes('')) { + inTable = true + fixedLines.push(lines[i]) + continue + } + + if (line === '
' || line === '
') { + if (currentRow.length > 0) { + fixedLines.push(`${currentRow.join(' ')}
') || line.startsWith('')) { + currentRow.push(lines[i]) + } else if (currentRow.length > 0) { + currentRow[currentRow.length - 1] += ` ${lines[i]}` + } else { + fixedLines.push(lines[i]) + } + } else { + fixedLines.push(lines[i]) + } + } + if (currentRow.length > 0) { + fixedLines.push(`${currentRow.join(' ')}
handleLogStrategy @@ -42,6 +43,7 @@ handleLogStrategy +
name @@ -57,6 +59,7 @@ string (Optional) +
handlerType @@ -72,6 +75,7 @@ handlerType (Optional) +
level @@ -87,6 +91,7 @@ level (Optional) +
loggerContext @@ -102,4 +107,5 @@ object (Optional) +
diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 1738748460..a0539e0a4c 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index 0a345065b5..a186625918 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index d1c6a18266..45f99c39ed 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index b3f91c3250..dd9400ed1a 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 9ecc88377b..77f28262f4 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index a68533fcac..87d6fb3506 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 292d3813ac..5dadf3e1b7 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
status @@ -70,6 +73,7 @@ status (Optional) +
error @@ -85,6 +89,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 4b2f3d247a..1cf20d1c60 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
status @@ -70,6 +73,7 @@ status (Optional) +
error @@ -85,6 +89,7 @@ Error (Optional) +
handlingStack @@ -100,6 +105,7 @@ string (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 7d474d2775..04a0bc6313 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -22,6 +22,7 @@ Method Description +
alert(message, messageContext, error) @@ -30,6 +31,7 @@ Description +
critical(message, messageContext, error) @@ -38,6 +40,7 @@ Description +
debug(message, messageContext, error) @@ -46,6 +49,7 @@ Description +
emerg(message, messageContext, error) @@ -54,6 +58,7 @@ Description +
error(message, messageContext, error) @@ -62,6 +67,7 @@ Description +
info(message, messageContext, error) @@ -70,6 +76,7 @@ Description +
notice(message, messageContext, error) @@ -78,6 +85,7 @@ Description +
ok(message, messageContext, error) @@ -86,6 +94,7 @@ Description +
warn(message, messageContext, error) @@ -94,4 +103,5 @@ Description +
diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index 26bc184c09..c51aa6ae28 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 0abfbcaf86..27c7df460e 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index 590442588d..db579777ca 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -27,6 +27,7 @@ Type Description +
key @@ -40,6 +41,7 @@ string +
**Returns:** diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index b04a74a5a3..385291d674 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -27,6 +27,7 @@ Type Description +
context @@ -40,6 +41,7 @@ object +
**Returns:** diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 31283671bc..1234ebb9e6 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -27,6 +27,7 @@ Type Description +
key @@ -40,6 +41,7 @@ string +
value @@ -53,6 +55,7 @@ any +
**Returns:** diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index f6ea429ebf..ae49c92c36 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -27,6 +27,7 @@ Type Description +
handler @@ -40,6 +41,7 @@ handler +
**Returns:** diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 8d515f7960..496538f248 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -27,6 +27,7 @@ Type Description +
level @@ -40,6 +41,7 @@ level +
**Returns:** diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index f315d2bcc7..8627f5f35c 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -27,6 +27,7 @@ Type Description +
message @@ -40,6 +41,7 @@ string +
messageContext @@ -55,6 +57,7 @@ object (Optional) +
error @@ -70,6 +73,7 @@ Error (Optional) +
**Returns:** diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index 516087325c..fea34505e9 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -32,6 +32,7 @@ Type Description +
context? @@ -50,6 +51,7 @@ object (Optional) +
handler? @@ -68,6 +70,7 @@ object (Optional) +
level? @@ -86,4 +89,5 @@ object (Optional) +
diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index 7d35776aa4..bc1704f0fb 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -32,6 +32,7 @@ Type Description +
application_id? @@ -50,6 +51,7 @@ string (Optional) UUID of the application +
date @@ -68,6 +70,7 @@ number Start of the log in ms from epoch +
error? @@ -86,6 +89,7 @@ Start of the log in ms from epoch (Optional) Error properties +
http? @@ -104,6 +108,7 @@ Start of the log in ms from epoch (Optional) Resource properties of the error +
logger? @@ -122,6 +127,7 @@ Start of the log in ms from epoch (Optional) Logger properties +
message @@ -140,6 +146,7 @@ string The log message +
origin @@ -158,6 +165,7 @@ The log message Origin of the log +
service? @@ -176,6 +184,7 @@ string (Optional) The service name +
session_id? @@ -194,6 +203,7 @@ string (Optional) UUID of the session (deprecated in favor of session.id) +
session? @@ -212,6 +222,7 @@ string (Optional) Session properties +
status @@ -230,6 +241,7 @@ string The log status +
view @@ -248,4 +260,5 @@ The log status View properties +
diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index 1c83b01859..a029027b86 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -33,6 +33,7 @@ Type Description +
clearAccount @@ -51,6 +52,7 @@ Description Clear all account information +
clearGlobalContext @@ -71,6 +73,7 @@ Clear the global context See Overwrite context for further information. +
clearUser @@ -91,6 +94,7 @@ Clear all user information See User context for further information. +
createLogger @@ -111,6 +115,7 @@ The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but thi See Define multiple loggers for further information. +
getAccount @@ -129,6 +134,7 @@ See getGlobalContext @@ -149,6 +155,7 @@ Get the global Context See Overwrite context for further information. +
getInitConfiguration @@ -167,6 +174,7 @@ See getInternalContext @@ -187,6 +195,7 @@ Get the init configuration See Access internal context for further information. +
getLogger @@ -207,6 +216,7 @@ Get a logger See Define multiple loggers for further information. +
getUser @@ -227,6 +237,7 @@ Get user information See User context for further information. +
init @@ -245,6 +256,7 @@ See logger @@ -261,6 +273,7 @@ Init the Logs browser SDK. +
removeAccountProperty @@ -279,6 +292,7 @@ Init the Logs browser SDK. Remove an account property +
removeGlobalContextProperty @@ -299,6 +313,7 @@ Remove a global context property See Overwrite context for further information. +
removeUserProperty @@ -319,6 +334,7 @@ Remove a user property See User context for further information. +
setAccount @@ -337,6 +353,7 @@ See setAccountProperty @@ -355,6 +372,7 @@ Set account information to all events, stored in `@account` Set or update the account property, stored in `@account.` +
setGlobalContext @@ -373,6 +391,7 @@ Set or update the account property, stored in `@account.` Set the global context information to all logs, stored in `@context` +
setGlobalContextProperty @@ -391,6 +410,7 @@ Set the global context information to all logs, stored in `@context` Set or update a global context property, stored in `@context.` +
setTrackingConsent @@ -409,6 +429,7 @@ Set or update a global context property, stored in `@context.` Set the tracking consent of the current user. +
setUserProperty @@ -427,6 +448,7 @@ Set the tracking consent of the current user. Set or update the user property, stored in `@usr.` +
## Methods @@ -441,6 +463,7 @@ Method Description +
setUser(newUser) @@ -453,6 +476,7 @@ Set user information to all events, stored in `@usr` See User context for further information. +
setUser(newUser) @@ -463,4 +487,5 @@ See beforeSend? @@ -51,6 +52,7 @@ Description (Optional) Access to every logs collected by the Logs SDK before they are sent to Datadog. It allows: - Enrich your logs with additional context attributes - Modify your logs to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected logs +
forwardConsoleLogs? @@ -69,6 +71,7 @@ ConsoleApiName[] | 'all' | undefined (Optional) Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. +
forwardErrorsToLogs? @@ -87,6 +90,7 @@ boolean | undefined (Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true +
forwardReports? @@ -105,6 +109,7 @@ RawReportType[] | 'all' | undefined (Optional) Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +
usePciIntake? @@ -123,4 +128,5 @@ boolean (Optional) Use PCI-compliant intake. See PCI DSS Compliance for further information. false +
diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index c307801f1f..12be7ea49c 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -32,6 +32,7 @@ Type Description +
context? @@ -50,6 +51,7 @@ Context (Optional) +
message @@ -66,6 +68,7 @@ string +
status @@ -82,4 +85,5 @@ string +
diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 3dab700e7d..600f7bc6c8 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -18,6 +18,7 @@ Class Description +
Logger @@ -26,6 +27,7 @@ Description +
## Interfaces @@ -40,6 +42,7 @@ Interface Description +
Logger @@ -48,6 +51,7 @@ Description +
LoggerConfiguration @@ -56,6 +60,7 @@ Description +
LogsEvent @@ -64,6 +69,7 @@ Description +
LogsGlobal @@ -72,6 +78,7 @@ Description +
LogsInitConfiguration @@ -80,6 +87,7 @@ Description +
LogsMessage @@ -88,6 +96,7 @@ Description +
## Variables @@ -102,6 +111,7 @@ Variable Description +
datadogLogs @@ -112,6 +122,7 @@ Description The global Logs instance. Use this to call Logs methods. +
HandlerType @@ -120,6 +131,7 @@ The global Logs instance. Use this to call Logs methods. +
StatusType @@ -128,6 +140,7 @@ The global Logs instance. Use this to call Logs methods. +
## Type Aliases @@ -142,6 +155,7 @@ Type Alias Description +
HandlerType @@ -150,6 +164,7 @@ Description +
LogsEventDomainContext @@ -158,6 +173,7 @@ Description +
StatusType @@ -166,4 +182,5 @@ Description +
diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 818fd646ff..9724d1afb7 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -27,6 +27,7 @@ Type Description +
error @@ -40,6 +41,7 @@ Error +
info @@ -53,6 +55,7 @@ ErrorInfo +
**Returns:** diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index d4be773223..d6860a9f2f 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -29,6 +29,7 @@ Type Description +
props @@ -42,4 +43,5 @@ Props +
diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 25abdf7abf..48870cd09e 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -27,6 +27,7 @@ Type Description +
error @@ -40,6 +41,7 @@ Error +
errorInfo @@ -53,6 +55,7 @@ ErrorInfo +
**Returns:** diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index 1c2e4c6520..b3b66ec01e 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -27,6 +27,7 @@ Type Description +
error @@ -40,6 +41,7 @@ Error +
**Returns:** diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 238fa65042..46e0493db4 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -28,6 +28,7 @@ Modifiers Description +
(constructor)(props) @@ -41,6 +42,7 @@ Description Constructs a new instance of the `ErrorBoundary` class +
## Properties @@ -65,6 +67,7 @@ Type Description +
resetError @@ -81,6 +84,7 @@ Description +
## Methods @@ -100,6 +104,7 @@ Modifiers Description +
componentDidCatch(error, errorInfo) @@ -111,6 +116,7 @@ Description +
getDerivedStateFromError(error) @@ -124,6 +130,7 @@ Description +
render() @@ -135,4 +142,5 @@ Description +
diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index ef2a1c8afd..c7241ab43a 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -18,6 +18,7 @@ Class Description +
ErrorBoundary @@ -26,6 +27,7 @@ Description +
## Functions @@ -40,6 +42,7 @@ Function Description +
addReactError(error, info) @@ -48,6 +51,7 @@ Description +
reactPlugin(configuration) @@ -56,6 +60,7 @@ Description +
## Variables @@ -70,6 +75,7 @@ Variable Description +
UNSTABLE_ReactComponentTracker @@ -78,4 +84,5 @@ Description +
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index d3f9e304d6..269eb8f58b 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -39,6 +39,7 @@ Type Description +
configuration @@ -54,6 +55,7 @@ ReactPluginConfiguration (Optional) +
**Returns:** diff --git a/docs/browser-rum-slim.md b/docs/browser-rum-slim.md index 1632946a84..995582d35b 100644 --- a/docs/browser-rum-slim.md +++ b/docs/browser-rum-slim.md @@ -18,6 +18,7 @@ Variable Description +
datadogRum @@ -28,4 +29,5 @@ Description The global RUM instance (slim version without Session Replay and Profiling). Use this to call RUM methods. +
diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 950384773e..16c2719b4c 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -34,6 +34,7 @@ Type Description +
_dd @@ -54,6 +55,7 @@ Description Internal properties +
account? @@ -74,6 +76,7 @@ Internal properties (Optional) Account properties +
application @@ -94,6 +97,7 @@ Internal properties Application properties +
build_id? @@ -114,6 +118,7 @@ string (Optional) Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. +
build_version? @@ -134,6 +139,7 @@ string (Optional) The build version for this application +
ci_test? @@ -154,6 +160,7 @@ string (Optional) CI Visibility properties +
connectivity? @@ -172,6 +179,7 @@ string (Optional) Device connectivity properties +
context? @@ -190,6 +198,7 @@ string (Optional) User provided context +
date @@ -210,6 +219,7 @@ number Start of the event in ms from epoch +
device? @@ -228,6 +238,7 @@ Start of the event in ms from epoch (Optional) Device properties +
display? @@ -246,6 +257,7 @@ Start of the event in ms from epoch (Optional) Display properties +
os? @@ -264,6 +276,7 @@ Start of the event in ms from epoch (Optional) Operating system properties +
service? @@ -282,6 +295,7 @@ string (Optional) The service name for this application +
session @@ -302,6 +316,7 @@ string Session properties +
source? @@ -322,6 +337,7 @@ Session properties (Optional) The source of this event +
synthetics? @@ -342,6 +358,7 @@ Session properties (Optional) Synthetics properties +
usr? @@ -362,6 +379,7 @@ Session properties (Optional) User properties +
version? @@ -380,6 +398,7 @@ string (Optional) The version for this application +
view @@ -400,4 +419,5 @@ string View properties +
diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 8ed1fcb980..47fff1e4e9 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -18,6 +18,7 @@ Interface Description +
CommonProperties @@ -28,6 +29,7 @@ Description Schema of common properties of RUM events +
RumActionEventDomainContext @@ -38,6 +40,7 @@ Schema of common properties of RUM events Additional information available when the SDK dispatches a RUM \*\*Action\*\* event. +
RumErrorEventDomainContext @@ -48,6 +51,7 @@ Additional information available when the SDK dispatches a RUM \*\*Action\*\* ev Additional information available when the SDK dispatches an \*\*Error\*\* event. +
RumFetchResourceEventDomainContext @@ -58,6 +62,7 @@ Additional information available when the SDK dispatches an \*\*Error\*\* event. Additional information available when the SDK dispatches a \*\*Fetch\*\* resource event. +
RumGlobal @@ -68,6 +73,7 @@ Additional information available when the SDK dispatches a \*\*Fetch\*\* resourc The RUM Browser SDK global object that provides all the public methods. +
RumInitConfiguration @@ -78,6 +84,7 @@ The RUM Browser SDK global object that provides all the public methods. Configuration options to pass to the `init()` method when initializing the RUM SDK. +
RumLongTaskEventDomainContext @@ -88,6 +95,7 @@ Configuration options to pass to the `init()` method when initializing the RUM S Additional information available when the SDK dispatches a \*\*Long Task\*\* event. +
RumOtherResourceEventDomainContext @@ -98,6 +106,7 @@ Additional information available when the SDK dispatches a \*\*Long Task\*\* eve Additional information available when the SDK dispatches a \*\*Resource\*\* event that is neither fetch nor XHR. +
RumViewEventDomainContext @@ -108,6 +117,7 @@ Additional information available when the SDK dispatches a \*\*Resource\*\* even Additional information available when the SDK dispatches a RUM \*\*View\*\* event. +
RumXhrResourceEventDomainContext @@ -118,6 +128,7 @@ Additional information available when the SDK dispatches a RUM \*\*View\*\* even Additional information available when the SDK dispatches an \*\*XHR\*\* resource event. +
## Variables @@ -132,6 +143,7 @@ Variable Description +
datadogRum @@ -142,6 +154,7 @@ Description The global RUM instance. Use this to call RUM methods. +
## Type Aliases @@ -156,6 +169,7 @@ Type Alias Description +
RumActionEvent @@ -166,6 +180,7 @@ Description Schema of all properties of an Action event +
RumErrorEvent @@ -176,6 +191,7 @@ Schema of all properties of an Action event Schema of all properties of an Error event +
RumEvent @@ -186,6 +202,7 @@ Schema of all properties of an Error event Schema of all properties of a RUM event +
RumEventDomainContext @@ -196,6 +213,7 @@ Schema of all properties of a RUM event Additional context data that varies based on the type of RUM event being dispatched. +
RumLongTaskEvent @@ -206,6 +224,7 @@ Additional context data that varies based on the type of RUM event being dispatc Schema of all properties of a Long Task event +
RumResourceEvent @@ -216,6 +235,7 @@ Schema of all properties of a Long Task event Schema of all properties of a Resource event +
RumViewEvent @@ -226,6 +246,7 @@ Schema of all properties of a Resource event Schema of all properties of a View event +
RumVitalEvent @@ -236,4 +257,5 @@ Schema of all properties of a View event Schema of all properties of a Vital event +
diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index 3305cd25d9..090559196c 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
events? @@ -52,6 +53,7 @@ Event[] (Optional) DOM events that triggered this action. +
handlingStack? @@ -70,4 +72,5 @@ string (Optional) Stack trace of where the action was handled by the SDK. +
diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 7c8eae6863..3074a67321 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
error @@ -52,6 +53,7 @@ unknown The original error object that was captured. +
handlingStack? @@ -70,4 +72,5 @@ string (Optional) Stack trace of where the error was handled by the SDK. +
diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 946fabcce8..f467b35c6e 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
error? @@ -52,6 +53,7 @@ Error (Optional) Error that occurred during the fetch call. +
handlingStack? @@ -70,6 +72,7 @@ string (Optional) Stack trace of where the resource was handled by the SDK. +
isAborted @@ -88,6 +91,7 @@ boolean Whether the fetch call was aborted. +
performanceEntry? @@ -106,6 +110,7 @@ PerformanceEntry (Optional) Browser performance entry for this resource. +
requestInit? @@ -124,6 +129,7 @@ RequestInit (Optional) Init object passed to the fetch call. +
requestInput @@ -142,6 +148,7 @@ RequestInfo Input parameter passed to the fetch call. +
response? @@ -160,4 +167,5 @@ Response (Optional) Response object returned by the fetch call. +
diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index 22d416aa0c..5217531576 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -35,6 +35,7 @@ Type Description +
addAction @@ -53,6 +54,7 @@ Description Add a custom action, stored in `@action` +
addDurationVital @@ -71,6 +73,7 @@ Add a custom action, stored in `@action` Add a custom duration vital +
addError @@ -89,6 +92,7 @@ Add a custom duration vital Add a custom error, stored in `@error`. +
addFeatureFlagEvaluation @@ -107,6 +111,7 @@ Add a custom error, stored in `@error`. Add a feature flag evaluation, stored in `@feature_flags.` +
addTiming @@ -125,6 +130,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` Add a custom timing relative to the start of the current view, stored in `@view.custom_timings.` +
clearAccount @@ -143,6 +149,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. Clear all account information +
clearGlobalContext @@ -163,6 +170,7 @@ Clear the global context See Global context for further information. +
clearUser @@ -183,6 +191,7 @@ Clear all user information See User session for further information. +
getAccount @@ -201,6 +210,7 @@ See getGlobalContext @@ -221,6 +231,7 @@ Get the global Context See Global context for further information. +
getInitConfiguration @@ -239,6 +250,7 @@ See getInternalContext @@ -257,6 +269,7 @@ Get the init configuration [Internal API] Get the internal SDK context +
getSessionReplayLink @@ -277,6 +290,7 @@ Get the Session Replay Link. See Connect Session Replay To Your Third-Party Tools for further information. +
getUser @@ -297,6 +311,7 @@ Get user information See User session for further information. +
getViewContext @@ -315,6 +330,7 @@ See init @@ -333,6 +349,7 @@ Get View Context. Init the RUM browser SDK. +
removeAccountProperty @@ -351,6 +368,7 @@ Init the RUM browser SDK. Remove an account property +
removeGlobalContextProperty @@ -371,6 +389,7 @@ Remove a global context property See Global context for further information. +
removeUserProperty @@ -391,6 +410,7 @@ Remove a user property See User session for further information. +
setAccount @@ -409,6 +429,7 @@ See setAccountProperty @@ -427,6 +448,7 @@ Set account information to all events, stored in `@account` Set or update the account property, stored in `@account.` +
setGlobalContext @@ -445,6 +467,7 @@ Set or update the account property, stored in `@account.` Set the global context information to all events, stored in `@context` +
setGlobalContextProperty @@ -463,6 +486,7 @@ Set the global context information to all events, stored in `@context` Set or update a global context property, stored in `@context.` +
setTrackingConsent @@ -481,6 +505,7 @@ Set or update a global context property, stored in `@context.` Set the tracking consent of the current user. +
setUserProperty @@ -499,6 +524,7 @@ Set the tracking consent of the current user. Set or update the user property, stored in `@usr.` +
setViewContext @@ -519,6 +545,7 @@ Set View Context. Enable to manually set the context of the current view. +
setViewContextProperty @@ -539,6 +566,7 @@ Set View Context Property. Enable to manually set a property of the context of the current view. +
setViewName @@ -559,6 +587,7 @@ Set View Name. Enable to manually change the name of the current view. +
startDurationVital @@ -579,6 +608,7 @@ Start a custom duration vital. If you plan to have multiple durations for the same vital, you should use the reference returned by this method. +
startSessionReplayRecording @@ -599,6 +629,7 @@ Start Session Replay recording. Enable to conditionally start the recording, use See Browser Session Replay for further information. +
startView @@ -617,6 +648,7 @@ See stopDurationVital @@ -635,6 +667,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t Stop a custom duration vital +
stopSession @@ -653,6 +686,7 @@ Stop a custom duration vital Stop the session. A new session will start at the next user interaction with the page. +
stopSessionReplayRecording @@ -673,6 +707,7 @@ Stop Session Replay recording. See Browser Session Replay for further information. +
## Methods @@ -687,6 +722,7 @@ Method Description +
setUser(newUser) @@ -699,6 +735,7 @@ Set user information to all events, stored in `@usr` See User session for further information. +
setUser(newUser) @@ -709,4 +746,5 @@ See actionNameAttribute? @@ -53,6 +54,7 @@ string | undefined (Optional) Specify your own attribute to use to name actions. See Declare a name for click actions for further information. +
allowedTracingUrls? @@ -71,6 +73,7 @@ Array | undefined (Optional) A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. +
applicationId @@ -89,6 +92,7 @@ string The RUM application ID. +
beforeSend? @@ -109,6 +113,7 @@ The RUM application ID. See Enrich And Control Browser RUM Data With beforeSend for further information. +
compressIntakeRequests? @@ -127,6 +132,7 @@ boolean | undefined (Optional) Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. +
defaultPrivacyLevel? @@ -145,6 +151,7 @@ DefaultPrivacyLevel | undefined (Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +
enablePrivacyForActionName? @@ -163,6 +170,7 @@ boolean | undefined (Optional) Enables privacy control for action names. +
excludedActivityUrls? @@ -181,6 +189,7 @@ MatchOption[] | undefined (Optional) A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. +
plugins? @@ -199,6 +208,7 @@ RumPlugin[] | undefined (Optional) List of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using. +
profilingSampleRate? @@ -217,6 +227,7 @@ number | undefined (Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +
propagateTraceBaggage? @@ -235,6 +246,7 @@ boolean | undefined (Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false +
remoteConfigurationId? @@ -253,6 +265,7 @@ string | undefined (Optional) Identifier of the remote configuration to fetch dynamic settings for your application at runtime. Unless you have been instructed by Datadog support to use this feature, you should leave this parameter undefined. +
sessionReplaySampleRate? @@ -271,6 +284,7 @@ number | undefined (Optional) The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +
startSessionReplayRecordingManually? @@ -289,6 +303,7 @@ boolean | undefined (Optional) If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. +
subdomain? @@ -307,6 +322,7 @@ string (Optional) If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. +
traceContextInjection? @@ -325,6 +341,7 @@ TraceContextInjection | undefined (Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +
traceSampleRate? @@ -343,6 +360,7 @@ number | undefined (Optional) The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. +
trackFeatureFlagsForEvents? @@ -361,6 +379,7 @@ FeatureFlagsForEvents[] (Optional) Enables collection of features flags in chosen events. +
trackLongTasks? @@ -379,6 +398,7 @@ boolean | undefined (Optional) Enables collection of long task events. true +
trackResources? @@ -397,6 +417,7 @@ boolean | undefined (Optional) Enables collection of resource events. true +
trackUserInteractions? @@ -415,6 +436,7 @@ boolean | undefined (Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true +
trackViewsManually? @@ -433,6 +455,7 @@ boolean | undefined (Optional) Allows you to control RUM views creation. See Override default RUM view names for further information. +
workerUrl? @@ -451,4 +474,5 @@ string (Optional) URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. +
diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.md b/docs/browser-rum.rumlongtaskeventdomaincontext.md index 7c09ee9a68..a2a9eb756c 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
performanceEntry @@ -52,4 +53,5 @@ PerformanceEntry Browser performance entry for this long task. +
diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index a84b2c7313..b00f68d864 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
performanceEntry @@ -52,4 +53,5 @@ PerformanceEntry Browser performance entry for this resource. +
diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 9a39af6570..566ba8ae49 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
location @@ -52,4 +53,5 @@ Readonly The browser location object at the time the view was created. +
diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 72c52eba01..d37e01623a 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -34,6 +34,7 @@ Type Description +
handlingStack? @@ -52,6 +53,7 @@ string (Optional) Stack trace of where the resource was handled by the SDK. +
isAborted @@ -70,6 +72,7 @@ boolean Whether the XHR request was aborted. +
performanceEntry? @@ -88,6 +91,7 @@ PerformanceEntry (Optional) Browser performance entry for this resource. +
xhr @@ -106,4 +110,5 @@ XMLHttpRequest The XMLHttpRequest object that made the request. +
diff --git a/docs/index.md b/docs/index.md index 675c0c5108..752a2b7655 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,6 +16,7 @@ Package Description +
@datadog/browser-logs @@ -26,6 +27,7 @@ Description Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Provides comprehensive logging capabilities with automatic error tracking and custom log collection. +
@datadog/browser-rum @@ -36,6 +38,7 @@ Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog. Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience. +
@datadog/browser-rum-react @@ -46,6 +49,7 @@ Datadog Browser RUM SDK - Full version with Session Replay and Real User Profili Datadog Browser RUM React Integration - Additional components and hooks for React applications. Provides React-specific features like Error Boundaries and component performance tracking. +
@datadog/browser-rum-slim @@ -56,4 +60,5 @@ Datadog Browser RUM React Integration - Additional components and hooks for Reac Datadog Browser RUM SDK - Slim version without Session Replay and Real User Profiling. Lightweight alternative for basic RUM monitoring with reduced bundle size. +
diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js index 028ae689b4..fcea981ef2 100644 --- a/scripts/fix-api-docs-final.js +++ b/scripts/fix-api-docs-final.js @@ -40,64 +40,7 @@ function removeEmptyHtmlComments(content) { } function fixHtmlTables(content) { - const lines = content.split('\n') - const fixedLines = [] - let inTable = false - let currentRow = [] - - for (let i = 0; i < lines.length; i++) { - const line = lines[i].trim() - - if (line.includes('')) { - inTable = true - fixedLines.push(lines[i]) - continue - } - - if (line === '
' || line === '
') { - if (currentRow.length > 0) { - fixedLines.push(`${currentRow.join(' ')}
') || line.startsWith('')) { - currentRow.push(lines[i]) - } else if (currentRow.length > 0) { - currentRow[currentRow.length - 1] += ` ${lines[i]}` - } else { - fixedLines.push(lines[i]) - } - } else { - fixedLines.push(lines[i]) - } - } - - if (currentRow.length > 0) { - fixedLines.push(`${currentRow.join(' ')}
+Add an ALERT log (action must be taken immediately). +
@@ -39,6 +45,8 @@ Description +Add a CRITICAL log (serious failure). +
@@ -48,6 +56,8 @@ Description +Add a DEBUG log (developer usage). +
@@ -57,6 +67,8 @@ Description +Add an EMERGENCY log (system is unusable). +
@@ -66,6 +78,8 @@ Description +Add an ERROR log (runtime error). +
@@ -75,6 +89,8 @@ Description +Add an INFO log (notable but expected). +
@@ -84,6 +100,8 @@ Description +Add a NOTICE log (normal but significant). +
@@ -93,6 +111,8 @@ Description +Add an OK log (success). +
@@ -102,6 +122,8 @@ Description +Add a WARN log (unexpected behaviour). +
diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index c51aa6ae28..c4b20e1681 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -4,6 +4,8 @@ ## Logger.notice() method +Add a NOTICE log (normal but significant). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 27c7df460e..1542b1c6ad 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -4,6 +4,8 @@ ## Logger.ok() method +Add an OK log (success). + **Signature:** ```typescript diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index 8627f5f35c..dd0d013eed 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -4,6 +4,8 @@ ## Logger.warn() method +Add a WARN log (unexpected behaviour). + **Signature:** ```typescript diff --git a/docs/browser-logs.logsmessage.context.md b/docs/browser-logs.logsmessage.context.md index b3cb258ec9..2b025ba6d5 100644 --- a/docs/browser-logs.logsmessage.context.md +++ b/docs/browser-logs.logsmessage.context.md @@ -4,6 +4,8 @@ ## LogsMessage.context property +Optional context attached to the log + **Signature:** ```typescript diff --git a/docs/browser-logs.logsmessage.md b/docs/browser-logs.logsmessage.md index 12be7ea49c..7892477a42 100644 --- a/docs/browser-logs.logsmessage.md +++ b/docs/browser-logs.logsmessage.md @@ -4,6 +4,8 @@ ## LogsMessage interface +Structure passed to the internal log handling strategy. + **Signature:** ```typescript @@ -48,7 +50,7 @@ Context 		-(Optional) +(Optional) Optional context attached to the log
+Raw message provided by the customer +
@@ -84,6 +88,8 @@ string +Severity of the log +
diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index 84712e6c45..c63e9c58c7 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -4,6 +4,8 @@ ## LogsMessage.message property +Raw message provided by the customer + **Signature:** ```typescript diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index 7fa75e5968..fa0860bd5b 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -4,6 +4,8 @@ ## LogsMessage.status property +Severity of the log + **Signature:** ```typescript diff --git a/docs/browser-logs.md b/docs/browser-logs.md index 600f7bc6c8..c2be976c7a 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -50,6 +50,10 @@ Description 		+Set of convenience methods for each supported log level. + +All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log. +
@@ -95,6 +99,8 @@ Description +Structure passed to the internal log handling strategy. +
diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index 9724d1afb7..c62f6375d6 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -4,6 +4,8 @@ ## addReactError() function +Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the ErrorBoundary component or React's error lifecycle. + **Signature:** ```typescript @@ -40,6 +42,8 @@ Error 		+The JavaScript `Error` instance thrown by React. +
@@ -54,6 +58,8 @@ ErrorInfo +Additional React error information, including the component stack. +
diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index 46e0493db4..f092578063 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -4,6 +4,10 @@ ## ErrorBoundary class +Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught. + + React.Component + **Signature:** ```typescript diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index c7241ab43a..1cb59b1acb 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -26,6 +26,10 @@ Description 		+Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught. + + React.Component +
@@ -50,6 +54,8 @@ Description 		+Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the ErrorBoundary component or React's error lifecycle. +
@@ -59,6 +65,10 @@ Description +Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). + +The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM \*Error\* events) - Optional react-router view tracking - Component performance tracking utilities (see UNSTABLE_ReactComponentTracker). +
@@ -83,6 +93,8 @@ Description 		+Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`. +
diff --git a/docs/browser-rum-react.reactplugin.md b/docs/browser-rum-react.reactplugin.md index 269eb8f58b..e7fcff1a09 100644 --- a/docs/browser-rum-react.reactplugin.md +++ b/docs/browser-rum-react.reactplugin.md @@ -4,6 +4,10 @@ ## reactPlugin() function +Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). + +The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM \*Error\* events) - Optional react-router view tracking - Component performance tracking utilities (see UNSTABLE_ReactComponentTracker). + **Signature:** ```typescript @@ -52,7 +56,7 @@ ReactPluginConfiguration 		-(Optional) +(Optional) React plugin specific configuration.
-Additional information available when the SDK dispatches a RUM \*\*Action\*\* event. +Additional information available when the SDK dispatches a RUM Action event.
-Additional information available when the SDK dispatches an \*\*Error\*\* event. +Additional information available when the SDK dispatches an Error event.
-Additional information available when the SDK dispatches a \*\*Fetch\*\* resource event. +Additional information available when the SDK dispatches a Fetch resource event.
-Additional information available when the SDK dispatches a \*\*Long Task\*\* event. +Additional information available when the SDK dispatches a Long Task event.
-Additional information available when the SDK dispatches a \*\*Resource\*\* event that is neither fetch nor XHR. +Additional information available when the SDK dispatches a Resource event that is neither fetch nor XHR.
-Additional information available when the SDK dispatches a RUM \*\*View\*\* event. +Additional information available when the SDK dispatches a RUM View event.
-Additional information available when the SDK dispatches an \*\*XHR\*\* resource event. +Additional information available when the SDK dispatches an XHR resource event.
\n') + content = content.replace(/(<\/td><\/tr>\s*){2,}/g, '
-(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void +(logsMessage: LogsMessage, logger: Logger, handlingStack?: string) => void @@ -67,7 +74,7 @@ handlerType -HandlerType | HandlerType[] +HandlerType | HandlerType\[\] @@ -83,7 +90,7 @@ level -StatusType +StatusType diff --git a/docs/browser-logs.logger.alert.md b/docs/browser-logs.logger.alert.md index 2b2c3c7a94..de6669b6b3 100644 --- a/docs/browser-logs.logger.alert.md +++ b/docs/browser-logs.logger.alert.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.alert() method" +nav_order: 204 +permalink: /browser-logs.logger.alert.html +--- + -Home > @datadog/browser-logs > Logger > alert +Home > @datadog/browser-logs > Logger > alert ## Logger.alert() method diff --git a/docs/browser-logs.logger.clearcontext.md b/docs/browser-logs.logger.clearcontext.md index 287f697b81..ffa5608649 100644 --- a/docs/browser-logs.logger.clearcontext.md +++ b/docs/browser-logs.logger.clearcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.clearContext() method" +nav_order: 203 +permalink: /browser-logs.logger.clearcontext.html +--- + -Home > @datadog/browser-logs > Logger > clearContext +Home > @datadog/browser-logs > Logger > clearContext ## Logger.clearContext() method diff --git a/docs/browser-logs.logger.critical.md b/docs/browser-logs.logger.critical.md index eb915d8715..eb9665f13c 100644 --- a/docs/browser-logs.logger.critical.md +++ b/docs/browser-logs.logger.critical.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.critical() method" +nav_order: 202 +permalink: /browser-logs.logger.critical.html +--- + -Home > @datadog/browser-logs > Logger > critical +Home > @datadog/browser-logs > Logger > critical ## Logger.critical() method diff --git a/docs/browser-logs.logger.debug.md b/docs/browser-logs.logger.debug.md index 01901a51d3..8c5bc60c61 100644 --- a/docs/browser-logs.logger.debug.md +++ b/docs/browser-logs.logger.debug.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.debug() method" +nav_order: 201 +permalink: /browser-logs.logger.debug.html +--- + -Home > @datadog/browser-logs > Logger > debug +Home > @datadog/browser-logs > Logger > debug ## Logger.debug() method diff --git a/docs/browser-logs.logger.emerg.md b/docs/browser-logs.logger.emerg.md index aca5c175ed..3a82378a00 100644 --- a/docs/browser-logs.logger.emerg.md +++ b/docs/browser-logs.logger.emerg.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.emerg() method" +nav_order: 200 +permalink: /browser-logs.logger.emerg.html +--- + -Home > @datadog/browser-logs > Logger > emerg +Home > @datadog/browser-logs > Logger > emerg ## Logger.emerg() method diff --git a/docs/browser-logs.logger.error.md b/docs/browser-logs.logger.error.md index 5ce44d8b73..bfe9085364 100644 --- a/docs/browser-logs.logger.error.md +++ b/docs/browser-logs.logger.error.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.error() method" +nav_order: 199 +permalink: /browser-logs.logger.error.html +--- + -Home > @datadog/browser-logs > Logger > error +Home > @datadog/browser-logs > Logger > error ## Logger.error() method diff --git a/docs/browser-logs.logger.getcontext.md b/docs/browser-logs.logger.getcontext.md index 07b7b7a06f..f0667bf198 100644 --- a/docs/browser-logs.logger.getcontext.md +++ b/docs/browser-logs.logger.getcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.getContext() method" +nav_order: 198 +permalink: /browser-logs.logger.getcontext.html +--- + -Home > @datadog/browser-logs > Logger > getContext +Home > @datadog/browser-logs > Logger > getContext ## Logger.getContext() method diff --git a/docs/browser-logs.logger.gethandler.md b/docs/browser-logs.logger.gethandler.md index 44e325a0c0..14c68116d0 100644 --- a/docs/browser-logs.logger.gethandler.md +++ b/docs/browser-logs.logger.gethandler.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.getHandler() method" +nav_order: 197 +permalink: /browser-logs.logger.gethandler.html +--- + -Home > @datadog/browser-logs > Logger > getHandler +Home > @datadog/browser-logs > Logger > getHandler ## Logger.getHandler() method @@ -11,5 +18,5 @@ getHandler(): HandlerType | HandlerType[]; ``` **Returns:** -HandlerType | HandlerType[] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logger.getlevel.md b/docs/browser-logs.logger.getlevel.md index 42232d6d2f..11bfc55820 100644 --- a/docs/browser-logs.logger.getlevel.md +++ b/docs/browser-logs.logger.getlevel.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.getLevel() method" +nav_order: 196 +permalink: /browser-logs.logger.getlevel.html +--- + -Home > @datadog/browser-logs > Logger > getLevel +Home > @datadog/browser-logs > Logger > getLevel ## Logger.getLevel() method @@ -11,5 +18,5 @@ getLevel(): StatusType; ``` **Returns:** -StatusType +StatusType diff --git a/docs/browser-logs.logger.info.md b/docs/browser-logs.logger.info.md index dd511cc4e6..cb715d82cd 100644 --- a/docs/browser-logs.logger.info.md +++ b/docs/browser-logs.logger.info.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.info() method" +nav_order: 195 +permalink: /browser-logs.logger.info.html +--- + -Home > @datadog/browser-logs > Logger > info +Home > @datadog/browser-logs > Logger > info ## Logger.info() method diff --git a/docs/browser-logs.logger.log.md b/docs/browser-logs.logger.log.md index 5dadf3e1b7..13f730f7e5 100644 --- a/docs/browser-logs.logger.log.md +++ b/docs/browser-logs.logger.log.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.log() method" +nav_order: 194 +permalink: /browser-logs.logger.log.html +--- + -Home > @datadog/browser-logs > Logger > log +Home > @datadog/browser-logs > Logger > log ## Logger.log() method @@ -65,7 +72,7 @@ status -StatusType +StatusType diff --git a/docs/browser-logs.logger.logimplementation.md b/docs/browser-logs.logger.logimplementation.md index 1cf20d1c60..087d6c96e1 100644 --- a/docs/browser-logs.logger.logimplementation.md +++ b/docs/browser-logs.logger.logimplementation.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.logImplementation() method" +nav_order: 193 +permalink: /browser-logs.logger.logimplementation.html +--- + -Home > @datadog/browser-logs > Logger > logImplementation +Home > @datadog/browser-logs > Logger > logImplementation ## Logger.logImplementation() method @@ -65,7 +72,7 @@ status -StatusType +StatusType diff --git a/docs/browser-logs.logger.md b/docs/browser-logs.logger.md index 12ea1b5190..f99011c433 100644 --- a/docs/browser-logs.logger.md +++ b/docs/browser-logs.logger.md @@ -1,12 +1,17 @@ +--- +layout: default +title: "Logger interface" +nav_order: 192 +permalink: /browser-logs.logger.html +--- + -Home > @datadog/browser-logs > Logger +Home > @datadog/browser-logs > Logger ## Logger interface -Set of convenience methods for each supported log level. - -All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log. +Provides convenience methods for logging at each supported level. Each method accepts a message, optional context, and an optional error. **Signature:** @@ -29,7 +34,7 @@ Description
-alert(message, messageContext, error) +alert(message, messageContext, error) @@ -40,7 +45,7 @@ Add an ALERT log (action must be taken immediately).
-critical(message, messageContext, error) +critical(message, messageContext, error) @@ -51,7 +56,7 @@ Add a CRITICAL log (serious failure).
-debug(message, messageContext, error) +debug(message, messageContext, error) @@ -62,7 +67,7 @@ Add a DEBUG log (developer usage).
-emerg(message, messageContext, error) +emerg(message, messageContext, error) @@ -73,7 +78,7 @@ Add an EMERGENCY log (system is unusable).
-error(message, messageContext, error) +error(message, messageContext, error) @@ -84,7 +89,7 @@ Add an ERROR log (runtime error).
-info(message, messageContext, error) +info(message, messageContext, error) @@ -95,7 +100,7 @@ Add an INFO log (notable but expected).
-notice(message, messageContext, error) +notice(message, messageContext, error) @@ -106,7 +111,7 @@ Add a NOTICE log (normal but significant).
-ok(message, messageContext, error) +ok(message, messageContext, error) @@ -117,7 +122,7 @@ Add an OK log (success).
-warn(message, messageContext, error) +warn(message, messageContext, error) diff --git a/docs/browser-logs.logger.notice.md b/docs/browser-logs.logger.notice.md index c4b20e1681..057392923b 100644 --- a/docs/browser-logs.logger.notice.md +++ b/docs/browser-logs.logger.notice.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.notice() method" +nav_order: 191 +permalink: /browser-logs.logger.notice.html +--- + -Home > @datadog/browser-logs > Logger > notice +Home > @datadog/browser-logs > Logger > notice ## Logger.notice() method diff --git a/docs/browser-logs.logger.ok.md b/docs/browser-logs.logger.ok.md index 1542b1c6ad..73d7031858 100644 --- a/docs/browser-logs.logger.ok.md +++ b/docs/browser-logs.logger.ok.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.ok() method" +nav_order: 190 +permalink: /browser-logs.logger.ok.html +--- + -Home > @datadog/browser-logs > Logger > ok +Home > @datadog/browser-logs > Logger > ok ## Logger.ok() method diff --git a/docs/browser-logs.logger.removecontextproperty.md b/docs/browser-logs.logger.removecontextproperty.md index db579777ca..92f743c8bc 100644 --- a/docs/browser-logs.logger.removecontextproperty.md +++ b/docs/browser-logs.logger.removecontextproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.removeContextProperty() method" +nav_order: 189 +permalink: /browser-logs.logger.removecontextproperty.html +--- + -Home > @datadog/browser-logs > Logger > removeContextProperty +Home > @datadog/browser-logs > Logger > removeContextProperty ## Logger.removeContextProperty() method diff --git a/docs/browser-logs.logger.setcontext.md b/docs/browser-logs.logger.setcontext.md index 385291d674..a56a0c4ea6 100644 --- a/docs/browser-logs.logger.setcontext.md +++ b/docs/browser-logs.logger.setcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.setContext() method" +nav_order: 188 +permalink: /browser-logs.logger.setcontext.html +--- + -Home > @datadog/browser-logs > Logger > setContext +Home > @datadog/browser-logs > Logger > setContext ## Logger.setContext() method diff --git a/docs/browser-logs.logger.setcontextproperty.md b/docs/browser-logs.logger.setcontextproperty.md index 1234ebb9e6..7587141b23 100644 --- a/docs/browser-logs.logger.setcontextproperty.md +++ b/docs/browser-logs.logger.setcontextproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.setContextProperty() method" +nav_order: 187 +permalink: /browser-logs.logger.setcontextproperty.html +--- + -Home > @datadog/browser-logs > Logger > setContextProperty +Home > @datadog/browser-logs > Logger > setContextProperty ## Logger.setContextProperty() method diff --git a/docs/browser-logs.logger.sethandler.md b/docs/browser-logs.logger.sethandler.md index ae49c92c36..c8e818ee77 100644 --- a/docs/browser-logs.logger.sethandler.md +++ b/docs/browser-logs.logger.sethandler.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.setHandler() method" +nav_order: 186 +permalink: /browser-logs.logger.sethandler.html +--- + -Home > @datadog/browser-logs > Logger > setHandler +Home > @datadog/browser-logs > Logger > setHandler ## Logger.setHandler() method @@ -35,7 +42,7 @@ handler -HandlerType | HandlerType[] +HandlerType | HandlerType\[\] diff --git a/docs/browser-logs.logger.setlevel.md b/docs/browser-logs.logger.setlevel.md index 496538f248..f7059ef2bb 100644 --- a/docs/browser-logs.logger.setlevel.md +++ b/docs/browser-logs.logger.setlevel.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.setLevel() method" +nav_order: 185 +permalink: /browser-logs.logger.setlevel.html +--- + -Home > @datadog/browser-logs > Logger > setLevel +Home > @datadog/browser-logs > Logger > setLevel ## Logger.setLevel() method @@ -35,7 +42,7 @@ level -StatusType +StatusType diff --git a/docs/browser-logs.logger.warn.md b/docs/browser-logs.logger.warn.md index dd0d013eed..f6a9750bc6 100644 --- a/docs/browser-logs.logger.warn.md +++ b/docs/browser-logs.logger.warn.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "Logger.warn() method" +nav_order: 184 +permalink: /browser-logs.logger.warn.html +--- + -Home > @datadog/browser-logs > Logger > warn +Home > @datadog/browser-logs > Logger > warn ## Logger.warn() method diff --git a/docs/browser-logs.loggerconfiguration.context.md b/docs/browser-logs.loggerconfiguration.context.md index cde7c70422..d3b291ddeb 100644 --- a/docs/browser-logs.loggerconfiguration.context.md +++ b/docs/browser-logs.loggerconfiguration.context.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LoggerConfiguration.context property" +nav_order: 183 +permalink: /browser-logs.loggerconfiguration.context.html +--- + -Home > @datadog/browser-logs > LoggerConfiguration > context +Home > @datadog/browser-logs > LoggerConfiguration > context ## LoggerConfiguration.context property diff --git a/docs/browser-logs.loggerconfiguration.handler.md b/docs/browser-logs.loggerconfiguration.handler.md index f8008047ea..817004ae97 100644 --- a/docs/browser-logs.loggerconfiguration.handler.md +++ b/docs/browser-logs.loggerconfiguration.handler.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LoggerConfiguration.handler property" +nav_order: 182 +permalink: /browser-logs.loggerconfiguration.handler.html +--- + -Home > @datadog/browser-logs > LoggerConfiguration > handler +Home > @datadog/browser-logs > LoggerConfiguration > handler ## LoggerConfiguration.handler property diff --git a/docs/browser-logs.loggerconfiguration.level.md b/docs/browser-logs.loggerconfiguration.level.md index 870e7bcde3..2fb14e0ba1 100644 --- a/docs/browser-logs.loggerconfiguration.level.md +++ b/docs/browser-logs.loggerconfiguration.level.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LoggerConfiguration.level property" +nav_order: 181 +permalink: /browser-logs.loggerconfiguration.level.html +--- + -Home > @datadog/browser-logs > LoggerConfiguration > level +Home > @datadog/browser-logs > LoggerConfiguration > level ## LoggerConfiguration.level property diff --git a/docs/browser-logs.loggerconfiguration.md b/docs/browser-logs.loggerconfiguration.md index fea34505e9..e3ff9832be 100644 --- a/docs/browser-logs.loggerconfiguration.md +++ b/docs/browser-logs.loggerconfiguration.md @@ -1,9 +1,18 @@ +--- +layout: default +title: "LoggerConfiguration interface" +nav_order: 180 +permalink: /browser-logs.loggerconfiguration.html +--- + -Home > @datadog/browser-logs > LoggerConfiguration +Home > @datadog/browser-logs > LoggerConfiguration ## LoggerConfiguration interface +Configuration options for a logger. Includes the log level to determine the severity of logs, the handler(s) responsible for processing log messages, and an optional context object to provide additional metadata for logs. + **Signature:** ```typescript @@ -35,7 +44,7 @@ Description
-context? +context? @@ -54,7 +63,7 @@ object
-handler? +handler? @@ -62,7 +71,7 @@ object -HandlerType | HandlerType[] +HandlerType | HandlerType\[\] @@ -73,7 +82,7 @@ object
-level? +level? @@ -81,7 +90,7 @@ object -StatusType +StatusType diff --git a/docs/browser-logs.logsevent.application_id.md b/docs/browser-logs.logsevent.application_id.md index 1354ea6752..0f0c55bd9c 100644 --- a/docs/browser-logs.logsevent.application_id.md +++ b/docs/browser-logs.logsevent.application_id.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.application_id property" +nav_order: 179 +permalink: /browser-logs.logsevent.application_id.html +--- + -Home > @datadog/browser-logs > LogsEvent > application_id +Home > @datadog/browser-logs > LogsEvent > application_id ## LogsEvent.application_id property diff --git a/docs/browser-logs.logsevent.date.md b/docs/browser-logs.logsevent.date.md index 4d1e3ad47a..5f22734722 100644 --- a/docs/browser-logs.logsevent.date.md +++ b/docs/browser-logs.logsevent.date.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.date property" +nav_order: 178 +permalink: /browser-logs.logsevent.date.html +--- + -Home > @datadog/browser-logs > LogsEvent > date +Home > @datadog/browser-logs > LogsEvent > date ## LogsEvent.date property diff --git a/docs/browser-logs.logsevent.error.md b/docs/browser-logs.logsevent.error.md index ea1380ec1e..457cdaa9b9 100644 --- a/docs/browser-logs.logsevent.error.md +++ b/docs/browser-logs.logsevent.error.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.error property" +nav_order: 177 +permalink: /browser-logs.logsevent.error.html +--- + -Home > @datadog/browser-logs > LogsEvent > error +Home > @datadog/browser-logs > LogsEvent > error ## LogsEvent.error property @@ -10,16 +17,16 @@ Error properties ```typescript error?: { - kind?: string; - stack?: string; - fingerprint?: string; - message?: string; - causes?: Array<{ - message: string; - source: string; - type?: string; - stack?: string; - }>; - [k: string]: unknown; - }; + kind?: string; + stack?: string; + fingerprint?: string; + message?: string; + causes?: Array<{ + message: string; + source: string; + type?: string; + stack?: string; + }>; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.http.md b/docs/browser-logs.logsevent.http.md index 7ebe67e608..2a86e91cdd 100644 --- a/docs/browser-logs.logsevent.http.md +++ b/docs/browser-logs.logsevent.http.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.http property" +nav_order: 176 +permalink: /browser-logs.logsevent.http.html +--- + -Home > @datadog/browser-logs > LogsEvent > http +Home > @datadog/browser-logs > LogsEvent > http ## LogsEvent.http property @@ -10,9 +17,9 @@ Resource properties of the error ```typescript http?: { - method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; - status_code: number; - url: string; - [k: string]: unknown; - }; + method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; + status_code: number; + url: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.logger.md b/docs/browser-logs.logsevent.logger.md index 104956466b..6be918b1a5 100644 --- a/docs/browser-logs.logsevent.logger.md +++ b/docs/browser-logs.logsevent.logger.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.logger property" +nav_order: 175 +permalink: /browser-logs.logsevent.logger.html +--- + -Home > @datadog/browser-logs > LogsEvent > logger +Home > @datadog/browser-logs > LogsEvent > logger ## LogsEvent.logger property @@ -10,7 +17,7 @@ Logger properties ```typescript logger?: { - name: string; - [k: string]: unknown; - }; + name: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.md b/docs/browser-logs.logsevent.md index bc1704f0fb..1d47b18549 100644 --- a/docs/browser-logs.logsevent.md +++ b/docs/browser-logs.logsevent.md @@ -1,9 +1,18 @@ +--- +layout: default +title: "LogsEvent interface" +nav_order: 174 +permalink: /browser-logs.logsevent.html +--- + -Home > @datadog/browser-logs > LogsEvent +Home > @datadog/browser-logs > LogsEvent ## LogsEvent interface +Represents a log event collected by the Datadog Browser Logs SDK, containing information such as message, context, and metadata. + **Signature:** ```typescript @@ -35,7 +44,7 @@ Description
-application_id? +application_id? @@ -54,7 +63,7 @@ string
-date +date @@ -73,7 +82,7 @@ Start of the log in ms from epoch
-error? +error? @@ -81,7 +90,7 @@ Start of the log in ms from epoch -{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; [k: string]: unknown; } +{ kind?: string; stack?: string; fingerprint?: string; message?: string; causes?: Array<{ message: string; source: string; type?: string; stack?: string; }>; \[k: string\]: unknown; } @@ -92,7 +101,7 @@ Start of the log in ms from epoch
-http? +http? @@ -100,7 +109,7 @@ Start of the log in ms from epoch -{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status_code: number; url: string; [k: string]: unknown; } +{ method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH'; status_code: number; url: string; \[k: string\]: unknown; } @@ -111,7 +120,7 @@ Start of the log in ms from epoch
-logger? +logger? @@ -119,7 +128,7 @@ Start of the log in ms from epoch -{ name: string; [k: string]: unknown; } +{ name: string; \[k: string\]: unknown; } @@ -130,7 +139,7 @@ Start of the log in ms from epoch
-message +message @@ -149,7 +158,7 @@ The log message
-origin +origin @@ -168,7 +177,7 @@ Origin of the log
-service? +service? @@ -187,7 +196,7 @@ string
-session_id? +session_id? @@ -206,7 +215,7 @@ string
-session? +session? @@ -214,7 +223,7 @@ string -{ id?: string; [k: string]: unknown; } +{ id?: string; \[k: string\]: unknown; } @@ -225,7 +234,7 @@ string
-status +status @@ -244,7 +253,7 @@ The log status
-view +view @@ -252,7 +261,7 @@ The log status -{ referrer?: string; url: string; id?: string; [k: string]: unknown; } +{ referrer?: string; url: string; id?: string; \[k: string\]: unknown; } diff --git a/docs/browser-logs.logsevent.message.md b/docs/browser-logs.logsevent.message.md index f6ee5ede03..f0774a6dc0 100644 --- a/docs/browser-logs.logsevent.message.md +++ b/docs/browser-logs.logsevent.message.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.message property" +nav_order: 173 +permalink: /browser-logs.logsevent.message.html +--- + -Home > @datadog/browser-logs > LogsEvent > message +Home > @datadog/browser-logs > LogsEvent > message ## LogsEvent.message property diff --git a/docs/browser-logs.logsevent.origin.md b/docs/browser-logs.logsevent.origin.md index 93444e5ddf..d149bf5079 100644 --- a/docs/browser-logs.logsevent.origin.md +++ b/docs/browser-logs.logsevent.origin.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.origin property" +nav_order: 172 +permalink: /browser-logs.logsevent.origin.html +--- + -Home > @datadog/browser-logs > LogsEvent > origin +Home > @datadog/browser-logs > LogsEvent > origin ## LogsEvent.origin property diff --git a/docs/browser-logs.logsevent.service.md b/docs/browser-logs.logsevent.service.md index f2cc1b7b07..0a71881384 100644 --- a/docs/browser-logs.logsevent.service.md +++ b/docs/browser-logs.logsevent.service.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.service property" +nav_order: 171 +permalink: /browser-logs.logsevent.service.html +--- + -Home > @datadog/browser-logs > LogsEvent > service +Home > @datadog/browser-logs > LogsEvent > service ## LogsEvent.service property diff --git a/docs/browser-logs.logsevent.session.md b/docs/browser-logs.logsevent.session.md index 0d4d900162..07956560c9 100644 --- a/docs/browser-logs.logsevent.session.md +++ b/docs/browser-logs.logsevent.session.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.session property" +nav_order: 170 +permalink: /browser-logs.logsevent.session.html +--- + -Home > @datadog/browser-logs > LogsEvent > session +Home > @datadog/browser-logs > LogsEvent > session ## LogsEvent.session property @@ -10,7 +17,7 @@ Session properties ```typescript session?: { - id?: string; - [k: string]: unknown; - }; + id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logsevent.session_id.md b/docs/browser-logs.logsevent.session_id.md index 8fd965830f..002c76d2c3 100644 --- a/docs/browser-logs.logsevent.session_id.md +++ b/docs/browser-logs.logsevent.session_id.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.session_id property" +nav_order: 169 +permalink: /browser-logs.logsevent.session_id.html +--- + -Home > @datadog/browser-logs > LogsEvent > session_id +Home > @datadog/browser-logs > LogsEvent > session_id ## LogsEvent.session_id property diff --git a/docs/browser-logs.logsevent.status.md b/docs/browser-logs.logsevent.status.md index 7fd4e630f2..fa0c64849d 100644 --- a/docs/browser-logs.logsevent.status.md +++ b/docs/browser-logs.logsevent.status.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.status property" +nav_order: 168 +permalink: /browser-logs.logsevent.status.html +--- + -Home > @datadog/browser-logs > LogsEvent > status +Home > @datadog/browser-logs > LogsEvent > status ## LogsEvent.status property diff --git a/docs/browser-logs.logsevent.view.md b/docs/browser-logs.logsevent.view.md index 027fa26a4c..ee6f65733b 100644 --- a/docs/browser-logs.logsevent.view.md +++ b/docs/browser-logs.logsevent.view.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEvent.view property" +nav_order: 167 +permalink: /browser-logs.logsevent.view.html +--- + -Home > @datadog/browser-logs > LogsEvent > view +Home > @datadog/browser-logs > LogsEvent > view ## LogsEvent.view property @@ -10,9 +17,9 @@ View properties ```typescript view: { - referrer?: string; - url: string; - id?: string; - [k: string]: unknown; - }; + referrer?: string; + url: string; + id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-logs.logseventdomaincontext.md b/docs/browser-logs.logseventdomaincontext.md index 98a463405c..be7c880795 100644 --- a/docs/browser-logs.logseventdomaincontext.md +++ b/docs/browser-logs.logseventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsEventDomainContext type" +nav_order: 166 +permalink: /browser-logs.logseventdomaincontext.html +--- + -Home > @datadog/browser-logs > LogsEventDomainContext +Home > @datadog/browser-logs > LogsEventDomainContext ## LogsEventDomainContext type diff --git a/docs/browser-logs.logsglobal.clearaccount.md b/docs/browser-logs.logsglobal.clearaccount.md index 060db1903e..29bfb15ae9 100644 --- a/docs/browser-logs.logsglobal.clearaccount.md +++ b/docs/browser-logs.logsglobal.clearaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.clearAccount property" +nav_order: 165 +permalink: /browser-logs.logsglobal.clearaccount.html +--- + -Home > @datadog/browser-logs > LogsGlobal > clearAccount +Home > @datadog/browser-logs > LogsGlobal > clearAccount ## LogsGlobal.clearAccount property diff --git a/docs/browser-logs.logsglobal.clearglobalcontext.md b/docs/browser-logs.logsglobal.clearglobalcontext.md index c3ba2df793..367c2b6cbb 100644 --- a/docs/browser-logs.logsglobal.clearglobalcontext.md +++ b/docs/browser-logs.logsglobal.clearglobalcontext.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.clearGlobalContext property" +nav_order: 164 +permalink: /browser-logs.logsglobal.clearglobalcontext.html +--- + -Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext +Home > @datadog/browser-logs > LogsGlobal > clearGlobalContext ## LogsGlobal.clearGlobalContext property Clear the global context -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.clearuser.md b/docs/browser-logs.logsglobal.clearuser.md index c5db42d8a7..18f09ab934 100644 --- a/docs/browser-logs.logsglobal.clearuser.md +++ b/docs/browser-logs.logsglobal.clearuser.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.clearUser property" +nav_order: 163 +permalink: /browser-logs.logsglobal.clearuser.html +--- + -Home > @datadog/browser-logs > LogsGlobal > clearUser +Home > @datadog/browser-logs > LogsGlobal > clearUser ## LogsGlobal.clearUser property Clear all user information -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.createlogger.md b/docs/browser-logs.logsglobal.createlogger.md index ab9cf826d3..4c7c57272f 100644 --- a/docs/browser-logs.logsglobal.createlogger.md +++ b/docs/browser-logs.logsglobal.createlogger.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.createLogger property" +nav_order: 162 +permalink: /browser-logs.logsglobal.createlogger.html +--- + -Home > @datadog/browser-logs > LogsGlobal > createLogger +Home > @datadog/browser-logs > LogsGlobal > createLogger ## LogsGlobal.createLogger property -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getaccount.md b/docs/browser-logs.logsglobal.getaccount.md index 968f787d83..3efd701ab7 100644 --- a/docs/browser-logs.logsglobal.getaccount.md +++ b/docs/browser-logs.logsglobal.getaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.getAccount property" +nav_order: 161 +permalink: /browser-logs.logsglobal.getaccount.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getAccount +Home > @datadog/browser-logs > LogsGlobal > getAccount ## LogsGlobal.getAccount property diff --git a/docs/browser-logs.logsglobal.getglobalcontext.md b/docs/browser-logs.logsglobal.getglobalcontext.md index 624405042c..c37f78b41a 100644 --- a/docs/browser-logs.logsglobal.getglobalcontext.md +++ b/docs/browser-logs.logsglobal.getglobalcontext.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.getGlobalContext property" +nav_order: 160 +permalink: /browser-logs.logsglobal.getglobalcontext.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getGlobalContext +Home > @datadog/browser-logs > LogsGlobal > getGlobalContext ## LogsGlobal.getGlobalContext property Get the global Context -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getinitconfiguration.md b/docs/browser-logs.logsglobal.getinitconfiguration.md index f8c8f4764a..07368c20dc 100644 --- a/docs/browser-logs.logsglobal.getinitconfiguration.md +++ b/docs/browser-logs.logsglobal.getinitconfiguration.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.getInitConfiguration property" +nav_order: 159 +permalink: /browser-logs.logsglobal.getinitconfiguration.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration +Home > @datadog/browser-logs > LogsGlobal > getInitConfiguration ## LogsGlobal.getInitConfiguration property diff --git a/docs/browser-logs.logsglobal.getinternalcontext.md b/docs/browser-logs.logsglobal.getinternalcontext.md index ec690c74f8..bae5813191 100644 --- a/docs/browser-logs.logsglobal.getinternalcontext.md +++ b/docs/browser-logs.logsglobal.getinternalcontext.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.getInternalContext property" +nav_order: 158 +permalink: /browser-logs.logsglobal.getinternalcontext.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getInternalContext +Home > @datadog/browser-logs > LogsGlobal > getInternalContext ## LogsGlobal.getInternalContext property -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context -See Access internal context for further information. +See \Access internal context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getlogger.md b/docs/browser-logs.logsglobal.getlogger.md index de423b6ec5..54eab1dd71 100644 --- a/docs/browser-logs.logsglobal.getlogger.md +++ b/docs/browser-logs.logsglobal.getlogger.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.getLogger property" +nav_order: 157 +permalink: /browser-logs.logsglobal.getlogger.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getLogger +Home > @datadog/browser-logs > LogsGlobal > getLogger ## LogsGlobal.getLogger property Get a logger -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.getuser.md b/docs/browser-logs.logsglobal.getuser.md index db13e72d69..ca97d9ea48 100644 --- a/docs/browser-logs.logsglobal.getuser.md +++ b/docs/browser-logs.logsglobal.getuser.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.getUser property" +nav_order: 156 +permalink: /browser-logs.logsglobal.getuser.html +--- + -Home > @datadog/browser-logs > LogsGlobal > getUser +Home > @datadog/browser-logs > LogsGlobal > getUser ## LogsGlobal.getUser property Get user information -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.init.md b/docs/browser-logs.logsglobal.init.md index 5d8b5bcc31..7c5b14c3dc 100644 --- a/docs/browser-logs.logsglobal.init.md +++ b/docs/browser-logs.logsglobal.init.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.init property" +nav_order: 155 +permalink: /browser-logs.logsglobal.init.html +--- + -Home > @datadog/browser-logs > LogsGlobal > init +Home > @datadog/browser-logs > LogsGlobal > init ## LogsGlobal.init property diff --git a/docs/browser-logs.logsglobal.logger.md b/docs/browser-logs.logsglobal.logger.md index 2d57d00341..604f4eba0a 100644 --- a/docs/browser-logs.logsglobal.logger.md +++ b/docs/browser-logs.logsglobal.logger.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.logger property" +nav_order: 154 +permalink: /browser-logs.logsglobal.logger.html +--- + -Home > @datadog/browser-logs > LogsGlobal > logger +Home > @datadog/browser-logs > LogsGlobal > logger ## LogsGlobal.logger property diff --git a/docs/browser-logs.logsglobal.md b/docs/browser-logs.logsglobal.md index a029027b86..7903cdecc5 100644 --- a/docs/browser-logs.logsglobal.md +++ b/docs/browser-logs.logsglobal.md @@ -1,9 +1,18 @@ +--- +layout: default +title: "LogsGlobal interface" +nav_order: 153 +permalink: /browser-logs.logsglobal.html +--- + -Home > @datadog/browser-logs > LogsGlobal +Home > @datadog/browser-logs > LogsGlobal ## LogsGlobal interface +The public API for the Datadog Browser Logs SDK. Provides methods to initialize the SDK, manage global/user/account contexts, and interact with loggers for collecting and forwarding logs. + **Signature:** ```typescript @@ -36,7 +45,7 @@ Description
-clearAccount +clearAccount @@ -44,7 +53,7 @@ Description -() => void +() => void @@ -55,7 +64,7 @@ Clear all account information
-clearGlobalContext +clearGlobalContext @@ -63,20 +72,20 @@ Clear all account information -() => void +() => void Clear the global context -See Overwrite context for further information. +See \Overwrite context\ for further information.
-clearUser +clearUser @@ -84,20 +93,20 @@ See User context for further information. +See \User context\ for further information.
-createLogger +createLogger @@ -105,20 +114,20 @@ See LoggerConfiguration) => Logger +(name: string, conf?: LoggerConfiguration) => Logger -The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. +The Datadog browser logs SDK contains a default logger `DD_LOGS.logger`, but this API allows to create different ones. -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information.
-getAccount +getAccount @@ -126,7 +135,7 @@ See getGlobalContext +getGlobalContext @@ -145,20 +154,20 @@ Get account information -() => Context +() => Context Get the global Context -See Overwrite context for further information. +See \Overwrite context\ for further information.
-getInitConfiguration +getInitConfiguration @@ -166,7 +175,7 @@ See LogsInitConfiguration | undefined +() => LogsInitConfiguration | undefined @@ -177,7 +186,7 @@ Get the init configuration
-getInternalContext +getInternalContext @@ -185,20 +194,20 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext | undefined -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context -See Access internal context for further information. +See \Access internal context\ for further information.
-getLogger +getLogger @@ -206,20 +215,20 @@ See Logger | undefined +(name: string) => Logger | undefined Get a logger -See Define multiple loggers for further information. +See \Define multiple loggers\ for further information.
-getUser +getUser @@ -227,20 +236,20 @@ See User context for further information. +See \User context\ for further information.
-init +init @@ -248,7 +257,7 @@ See LogsInitConfiguration) => void +(initConfiguration: LogsInitConfiguration) => void @@ -259,7 +268,7 @@ Init the Logs browser SDK.
-logger +logger @@ -267,7 +276,7 @@ Init the Logs browser SDK. -Logger +Logger @@ -276,7 +285,7 @@ Init the Logs browser SDK.
-removeAccountProperty +removeAccountProperty @@ -284,7 +293,7 @@ Init the Logs browser SDK. -(key: string) => void +(key: string) => void @@ -295,7 +304,7 @@ Remove an account property
-removeGlobalContextProperty +removeGlobalContextProperty @@ -303,20 +312,20 @@ Remove an account property -(key: any) => void +(key: any) => void Remove a global context property -See Overwrite context for further information. +See \Overwrite context\ for further information.
-removeUserProperty +removeUserProperty @@ -324,20 +333,20 @@ See User context for further information. +See \User context\ for further information.
-setAccount +setAccount @@ -345,7 +354,7 @@ See setAccountProperty +setAccountProperty @@ -364,7 +373,7 @@ Set account information to all events, stored in `@account` -(key: string, property: any) => void +(key: string, property: any) => void @@ -375,7 +384,7 @@ Set or update the account property, stored in `@account.`
-setGlobalContext +setGlobalContext @@ -383,7 +392,7 @@ Set or update the account property, stored in `@account.` -(context: any) => void +(context: any) => void @@ -394,7 +403,7 @@ Set the global context information to all logs, stored in `@context`
-setGlobalContextProperty +setGlobalContextProperty @@ -402,7 +411,7 @@ Set the global context information to all logs, stored in `@context` -(key: any, value: any) => void +(key: any, value: any) => void @@ -413,7 +422,7 @@ Set or update a global context property, stored in `@context.`
-setTrackingConsent +setTrackingConsent @@ -421,7 +430,7 @@ Set or update a global context property, stored in `@context.` -(trackingConsent: TrackingConsent) => void +(trackingConsent: TrackingConsent) => void @@ -432,7 +441,7 @@ Set the tracking consent of the current user.
-setUserProperty +setUserProperty @@ -440,7 +449,7 @@ Set the tracking consent of the current user. -(key: any, property: any) => void +(key: any, property: any) => void @@ -466,20 +475,20 @@ Description
-setUser(newUser) +setUser(newUser) Set user information to all events, stored in `@usr` -See User context for further information. +See \User context\ for further information.
-setUser(newUser) +setUser(newUser) diff --git a/docs/browser-logs.logsglobal.removeaccountproperty.md b/docs/browser-logs.logsglobal.removeaccountproperty.md index b76e1dc557..b4710dfc04 100644 --- a/docs/browser-logs.logsglobal.removeaccountproperty.md +++ b/docs/browser-logs.logsglobal.removeaccountproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.removeAccountProperty property" +nav_order: 152 +permalink: /browser-logs.logsglobal.removeaccountproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty +Home > @datadog/browser-logs > LogsGlobal > removeAccountProperty ## LogsGlobal.removeAccountProperty property diff --git a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md index 9449a76730..6ac7d250ed 100644 --- a/docs/browser-logs.logsglobal.removeglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.removeglobalcontextproperty.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.removeGlobalContextProperty property" +nav_order: 151 +permalink: /browser-logs.logsglobal.removeglobalcontextproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > removeGlobalContextProperty ## LogsGlobal.removeGlobalContextProperty property Remove a global context property -See Overwrite context for further information. +See \Overwrite context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.removeuserproperty.md b/docs/browser-logs.logsglobal.removeuserproperty.md index 959cf118ee..91e4675f27 100644 --- a/docs/browser-logs.logsglobal.removeuserproperty.md +++ b/docs/browser-logs.logsglobal.removeuserproperty.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "LogsGlobal.removeUserProperty property" +nav_order: 150 +permalink: /browser-logs.logsglobal.removeuserproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > removeUserProperty +Home > @datadog/browser-logs > LogsGlobal > removeUserProperty ## LogsGlobal.removeUserProperty property Remove a user property -See User context for further information. +See \User context\ for further information. **Signature:** diff --git a/docs/browser-logs.logsglobal.setaccount.md b/docs/browser-logs.logsglobal.setaccount.md index a795ee6206..8389dc3ee5 100644 --- a/docs/browser-logs.logsglobal.setaccount.md +++ b/docs/browser-logs.logsglobal.setaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setAccount property" +nav_order: 149 +permalink: /browser-logs.logsglobal.setaccount.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setAccount +Home > @datadog/browser-logs > LogsGlobal > setAccount ## LogsGlobal.setAccount property diff --git a/docs/browser-logs.logsglobal.setaccountproperty.md b/docs/browser-logs.logsglobal.setaccountproperty.md index b3af24e5e6..662422376d 100644 --- a/docs/browser-logs.logsglobal.setaccountproperty.md +++ b/docs/browser-logs.logsglobal.setaccountproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setAccountProperty property" +nav_order: 148 +permalink: /browser-logs.logsglobal.setaccountproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setAccountProperty +Home > @datadog/browser-logs > LogsGlobal > setAccountProperty ## LogsGlobal.setAccountProperty property diff --git a/docs/browser-logs.logsglobal.setglobalcontext.md b/docs/browser-logs.logsglobal.setglobalcontext.md index 70756de993..1456a8ad6c 100644 --- a/docs/browser-logs.logsglobal.setglobalcontext.md +++ b/docs/browser-logs.logsglobal.setglobalcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setGlobalContext property" +nav_order: 147 +permalink: /browser-logs.logsglobal.setglobalcontext.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setGlobalContext +Home > @datadog/browser-logs > LogsGlobal > setGlobalContext ## LogsGlobal.setGlobalContext property diff --git a/docs/browser-logs.logsglobal.setglobalcontextproperty.md b/docs/browser-logs.logsglobal.setglobalcontextproperty.md index 6f932a486a..0b6c8dbbe1 100644 --- a/docs/browser-logs.logsglobal.setglobalcontextproperty.md +++ b/docs/browser-logs.logsglobal.setglobalcontextproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setGlobalContextProperty property" +nav_order: 146 +permalink: /browser-logs.logsglobal.setglobalcontextproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty +Home > @datadog/browser-logs > LogsGlobal > setGlobalContextProperty ## LogsGlobal.setGlobalContextProperty property diff --git a/docs/browser-logs.logsglobal.settrackingconsent.md b/docs/browser-logs.logsglobal.settrackingconsent.md index 5beb4d993e..0f7482709d 100644 --- a/docs/browser-logs.logsglobal.settrackingconsent.md +++ b/docs/browser-logs.logsglobal.settrackingconsent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setTrackingConsent property" +nav_order: 145 +permalink: /browser-logs.logsglobal.settrackingconsent.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent +Home > @datadog/browser-logs > LogsGlobal > setTrackingConsent ## LogsGlobal.setTrackingConsent property diff --git a/docs/browser-logs.logsglobal.setuser.md b/docs/browser-logs.logsglobal.setuser.md index 71aa07f0df..4786e0a923 100644 --- a/docs/browser-logs.logsglobal.setuser.md +++ b/docs/browser-logs.logsglobal.setuser.md @@ -1,19 +1,26 @@ +--- +layout: default +title: "LogsGlobal.setUser() method" +nav_order: 144 +permalink: /browser-logs.logsglobal.setuser.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method Set user information to all events, stored in `@usr` -See User context for further information. +See \User context\ for further information. **Signature:** ```typescript setUser(newUser: User & { - id: string; - }): void; + id: string; + }): void; ``` ## Parameters @@ -41,7 +48,7 @@ newUser -User & { id: string; } +User & { id: string; } diff --git a/docs/browser-logs.logsglobal.setuser_1.md b/docs/browser-logs.logsglobal.setuser_1.md index 5d67f0c1c6..c80a0df1e3 100644 --- a/docs/browser-logs.logsglobal.setuser_1.md +++ b/docs/browser-logs.logsglobal.setuser_1.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setUser() method" +nav_order: 143 +permalink: /browser-logs.logsglobal.setuser_1.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setUser +Home > @datadog/browser-logs > LogsGlobal > setUser ## LogsGlobal.setUser() method diff --git a/docs/browser-logs.logsglobal.setuserproperty.md b/docs/browser-logs.logsglobal.setuserproperty.md index db689f0b77..830b1db774 100644 --- a/docs/browser-logs.logsglobal.setuserproperty.md +++ b/docs/browser-logs.logsglobal.setuserproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsGlobal.setUserProperty property" +nav_order: 142 +permalink: /browser-logs.logsglobal.setuserproperty.html +--- + -Home > @datadog/browser-logs > LogsGlobal > setUserProperty +Home > @datadog/browser-logs > LogsGlobal > setUserProperty ## LogsGlobal.setUserProperty property diff --git a/docs/browser-logs.logsinitconfiguration.beforesend.md b/docs/browser-logs.logsinitconfiguration.beforesend.md index ca9ee23e48..84dc6c21d1 100644 --- a/docs/browser-logs.logsinitconfiguration.beforesend.md +++ b/docs/browser-logs.logsinitconfiguration.beforesend.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsInitConfiguration.beforeSend property" +nav_order: 141 +permalink: /browser-logs.logsinitconfiguration.beforesend.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend +Home > @datadog/browser-logs > LogsInitConfiguration > beforeSend ## LogsInitConfiguration.beforeSend property diff --git a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md index 7208874b17..ccfbc4d862 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md +++ b/docs/browser-logs.logsinitconfiguration.forwardconsolelogs.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "LogsInitConfiguration.forwardConsoleLogs property" +nav_order: 140 +permalink: /browser-logs.logsinitconfiguration.forwardconsolelogs.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardConsoleLogs ## LogsInitConfiguration.forwardConsoleLogs property -Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. +Forward logs from console.* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md index aae928941d..bfc5db0f3b 100644 --- a/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md +++ b/docs/browser-logs.logsinitconfiguration.forwarderrorstologs.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "LogsInitConfiguration.forwardErrorsToLogs property" +nav_order: 139 +permalink: /browser-logs.logsinitconfiguration.forwarderrorstologs.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs +Home > @datadog/browser-logs > LogsInitConfiguration > forwardErrorsToLogs ## LogsInitConfiguration.forwardErrorsToLogs property -Forward console.error logs, uncaught exceptions and network errors to Datadog. true +Forward console.error logs, uncaught exceptions and network errors to Datadog. true **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.forwardreports.md b/docs/browser-logs.logsinitconfiguration.forwardreports.md index 33f42825c2..0ad13669a7 100644 --- a/docs/browser-logs.logsinitconfiguration.forwardreports.md +++ b/docs/browser-logs.logsinitconfiguration.forwardreports.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "LogsInitConfiguration.forwardReports property" +nav_order: 138 +permalink: /browser-logs.logsinitconfiguration.forwardreports.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports +Home > @datadog/browser-logs > LogsInitConfiguration > forwardReports ## LogsInitConfiguration.forwardReports property -Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. **Signature:** diff --git a/docs/browser-logs.logsinitconfiguration.md b/docs/browser-logs.logsinitconfiguration.md index 186c47beab..803d61510b 100644 --- a/docs/browser-logs.logsinitconfiguration.md +++ b/docs/browser-logs.logsinitconfiguration.md @@ -1,9 +1,18 @@ +--- +layout: default +title: "LogsInitConfiguration interface" +nav_order: 137 +permalink: /browser-logs.logsinitconfiguration.html +--- + -Home > @datadog/browser-logs > LogsInitConfiguration +Home > @datadog/browser-logs > LogsInitConfiguration ## LogsInitConfiguration interface +Configuration options for initializing the Datadog Browser Logs SDK. Extends the base InitConfiguration and includes additional options specific to log collection, such as error forwarding, console log forwarding, and the ability to modify or discard logs before they are sent. + **Signature:** ```typescript @@ -36,7 +45,7 @@ Description
-beforeSend? +beforeSend? @@ -44,7 +53,7 @@ Description -((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined +((event: LogsEvent, context: LogsEventDomainContext) => boolean) | undefined @@ -55,7 +64,7 @@ Description
-forwardConsoleLogs? +forwardConsoleLogs? @@ -63,18 +72,18 @@ Description -ConsoleApiName[] | 'all' | undefined +ConsoleApiName\[\] | 'all' | undefined -(Optional) Forward logs from console.\* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset. +(Optional) Forward logs from console.* to Datadog. Use "all" to forward everything or an array of console API names to forward only a subset.
-forwardErrorsToLogs? +forwardErrorsToLogs? @@ -87,13 +96,13 @@ boolean | undefined -(Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true +(Optional) Forward console.error logs, uncaught exceptions and network errors to Datadog. true
-forwardReports? +forwardReports? @@ -101,18 +110,18 @@ boolean | undefined -RawReportType[] | 'all' | undefined +RawReportType\[\] | 'all' | undefined -(Optional) Forward reports from the Reporting API to Datadog. Use "all" to forward everything or an array of report types to forward only a subset. +(Optional) Forward reports from the \Reporting API\ to Datadog. Use "all" to forward everything or an array of report types to forward only a subset.
-usePciIntake? +usePciIntake? @@ -125,7 +134,7 @@ boolean -(Optional) Use PCI-compliant intake. See PCI DSS Compliance for further information. false +(Optional) Use PCI-compliant intake. See \PCI DSS Compliance\ for further information. false
-context? +context? @@ -56,7 +63,7 @@ Context
-message +message @@ -75,7 +82,7 @@ Raw message provided by the customer
-status +status @@ -83,7 +90,7 @@ Raw message provided by the customer -StatusType +StatusType diff --git a/docs/browser-logs.logsmessage.message.md b/docs/browser-logs.logsmessage.message.md index c63e9c58c7..31f907962c 100644 --- a/docs/browser-logs.logsmessage.message.md +++ b/docs/browser-logs.logsmessage.message.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsMessage.message property" +nav_order: 133 +permalink: /browser-logs.logsmessage.message.html +--- + -Home > @datadog/browser-logs > LogsMessage > message +Home > @datadog/browser-logs > LogsMessage > message ## LogsMessage.message property diff --git a/docs/browser-logs.logsmessage.status.md b/docs/browser-logs.logsmessage.status.md index fa0860bd5b..aacb0dd1c1 100644 --- a/docs/browser-logs.logsmessage.status.md +++ b/docs/browser-logs.logsmessage.status.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "LogsMessage.status property" +nav_order: 132 +permalink: /browser-logs.logsmessage.status.html +--- + -Home > @datadog/browser-logs > LogsMessage > status +Home > @datadog/browser-logs > LogsMessage > status ## LogsMessage.status property diff --git a/docs/browser-logs.md b/docs/browser-logs.md index c2be976c7a..73a9945fdf 100644 --- a/docs/browser-logs.md +++ b/docs/browser-logs.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "browser-logs package" +nav_order: 131 +permalink: /browser-logs.html +--- + -Home > @datadog/browser-logs +Home > @datadog/browser-logs ## browser-logs package @@ -21,7 +28,7 @@ Description
-Logger +Logger @@ -45,56 +52,62 @@ Description
-Logger +Logger -Set of convenience methods for each supported log level. - -All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log. +Provides convenience methods for logging at each supported level. Each method accepts a message, optional context, and an optional error.
-LoggerConfiguration +LoggerConfiguration +Configuration options for a logger. Includes the log level to determine the severity of logs, the handler(s) responsible for processing log messages, and an optional context object to provide additional metadata for logs. +
-LogsEvent +LogsEvent +Represents a log event collected by the Datadog Browser Logs SDK, containing information such as message, context, and metadata. +
-LogsGlobal +LogsGlobal +The public API for the Datadog Browser Logs SDK. Provides methods to initialize the SDK, manage global/user/account contexts, and interact with loggers for collecting and forwarding logs. +
-LogsInitConfiguration +LogsInitConfiguration +Configuration options for initializing the Datadog Browser Logs SDK. Extends the base InitConfiguration and includes additional options specific to log collection, such as error forwarding, console log forwarding, and the ability to modify or discard logs before they are sent. +
-LogsMessage +LogsMessage @@ -120,7 +133,7 @@ Description
-datadogLogs +datadogLogs @@ -131,20 +144,24 @@ The global Logs instance. Use this to call Logs methods.
-HandlerType +HandlerType +Defines the types of handlers for processing logs: console, HTTP, or silent. +
-StatusType +StatusType +Defines the severity levels for log messages, ranging from debug to emergency. +
@@ -164,7 +181,7 @@ Description
-HandlerType +HandlerType @@ -173,7 +190,7 @@ Description
-LogsEventDomainContext +LogsEventDomainContext @@ -182,7 +199,7 @@ Description
-StatusType +StatusType diff --git a/docs/browser-logs.statustype.md b/docs/browser-logs.statustype.md index d6be8530b4..cd58fc33fc 100644 --- a/docs/browser-logs.statustype.md +++ b/docs/browser-logs.statustype.md @@ -1,21 +1,30 @@ +--- +layout: default +title: "StatusType variable" +nav_order: 130 +permalink: /browser-logs.statustype.html +--- + -Home > @datadog/browser-logs > StatusType +Home > @datadog/browser-logs > StatusType ## StatusType variable +Defines the severity levels for log messages, ranging from debug to emergency. + **Signature:** ```typescript StatusType: { - readonly ok: "ok"; - readonly debug: "debug"; - readonly info: "info"; - readonly notice: "notice"; - readonly warn: "warn"; - readonly error: "error"; - readonly critical: "critical"; - readonly alert: "alert"; - readonly emerg: "emerg"; + readonly ok: "ok"; + readonly debug: "debug"; + readonly info: "info"; + readonly notice: "notice"; + readonly warn: "warn"; + readonly error: "error"; + readonly critical: "critical"; + readonly alert: "alert"; + readonly emerg: "emerg"; } ``` diff --git a/docs/browser-rum-react.addreacterror.md b/docs/browser-rum-react.addreacterror.md index c62f6375d6..c2d85732e0 100644 --- a/docs/browser-rum-react.addreacterror.md +++ b/docs/browser-rum-react.addreacterror.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "addReactError() function" +nav_order: 129 +permalink: /browser-rum-react.addreacterror.html +--- + -Home > @datadog/browser-rum-react > addReactError +Home > @datadog/browser-rum-react > addReactError ## addReactError() function -Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the ErrorBoundary component or React's error lifecycle. +Reports an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM with relevant context and stack information. **Signature:** @@ -42,8 +49,6 @@ Error -The JavaScript `Error` instance thrown by React. -
@@ -58,8 +63,6 @@ ErrorInfo -Additional React error information, including the component stack. -
diff --git a/docs/browser-rum-react.errorboundary._constructor_.md b/docs/browser-rum-react.errorboundary._constructor_.md index d6860a9f2f..456908aa42 100644 --- a/docs/browser-rum-react.errorboundary._constructor_.md +++ b/docs/browser-rum-react.errorboundary._constructor_.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "ErrorBoundary.(constructor)" +nav_order: 128 +permalink: /browser-rum-react.errorboundary._constructor_.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) +Home > @datadog/browser-rum-react > ErrorBoundary > (constructor) ## ErrorBoundary.(constructor) diff --git a/docs/browser-rum-react.errorboundary.componentdidcatch.md b/docs/browser-rum-react.errorboundary.componentdidcatch.md index 48870cd09e..281d99b069 100644 --- a/docs/browser-rum-react.errorboundary.componentdidcatch.md +++ b/docs/browser-rum-react.errorboundary.componentdidcatch.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "ErrorBoundary.componentDidCatch() method" +nav_order: 127 +permalink: /browser-rum-react.errorboundary.componentdidcatch.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch +Home > @datadog/browser-rum-react > ErrorBoundary > componentDidCatch ## ErrorBoundary.componentDidCatch() method diff --git a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md index b3b66ec01e..c2131d1b4d 100644 --- a/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md +++ b/docs/browser-rum-react.errorboundary.getderivedstatefromerror.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "ErrorBoundary.getDerivedStateFromError() method" +nav_order: 126 +permalink: /browser-rum-react.errorboundary.getderivedstatefromerror.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError +Home > @datadog/browser-rum-react > ErrorBoundary > getDerivedStateFromError ## ErrorBoundary.getDerivedStateFromError() method diff --git a/docs/browser-rum-react.errorboundary.md b/docs/browser-rum-react.errorboundary.md index f092578063..d2ad667ca5 100644 --- a/docs/browser-rum-react.errorboundary.md +++ b/docs/browser-rum-react.errorboundary.md @@ -1,19 +1,24 @@ +--- +layout: default +title: "ErrorBoundary class" +nav_order: 125 +permalink: /browser-rum-react.errorboundary.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary +Home > @datadog/browser-rum-react > ErrorBoundary ## ErrorBoundary class -Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught. - - React.Component +A React Error Boundary that captures runtime errors in its child components and reports them to Datadog RUM, rendering the `fallback` component when an error occurs. **Signature:** ```typescript export declare class ErrorBoundary extends React.Component ``` -**Extends:** React.Component +**Extends:** React.Component<Props, State> ## Constructors @@ -35,7 +40,7 @@ Description
-(constructor)(props) +(constructor)(props) @@ -74,7 +79,7 @@ Description
-resetError +resetError @@ -82,7 +87,7 @@ Description -() => void +() => void @@ -111,7 +116,7 @@ Description
-componentDidCatch(error, errorInfo) +componentDidCatch(error, errorInfo) @@ -123,7 +128,7 @@ Description
-getDerivedStateFromError(error) +getDerivedStateFromError(error) @@ -137,7 +142,7 @@ Description
-render() +render() diff --git a/docs/browser-rum-react.errorboundary.render.md b/docs/browser-rum-react.errorboundary.render.md index 346c338588..bed10bc6a7 100644 --- a/docs/browser-rum-react.errorboundary.render.md +++ b/docs/browser-rum-react.errorboundary.render.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "ErrorBoundary.render() method" +nav_order: 124 +permalink: /browser-rum-react.errorboundary.render.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary > render +Home > @datadog/browser-rum-react > ErrorBoundary > render ## ErrorBoundary.render() method diff --git a/docs/browser-rum-react.errorboundary.reseterror.md b/docs/browser-rum-react.errorboundary.reseterror.md index 28cb6a6eae..6b52aa889d 100644 --- a/docs/browser-rum-react.errorboundary.reseterror.md +++ b/docs/browser-rum-react.errorboundary.reseterror.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "ErrorBoundary.resetError property" +nav_order: 123 +permalink: /browser-rum-react.errorboundary.reseterror.html +--- + -Home > @datadog/browser-rum-react > ErrorBoundary > resetError +Home > @datadog/browser-rum-react > ErrorBoundary > resetError ## ErrorBoundary.resetError property diff --git a/docs/browser-rum-react.md b/docs/browser-rum-react.md index 1cb59b1acb..3623edaaab 100644 --- a/docs/browser-rum-react.md +++ b/docs/browser-rum-react.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "browser-rum-react package" +nav_order: 122 +permalink: /browser-rum-react.html +--- + -Home > @datadog/browser-rum-react +Home > @datadog/browser-rum-react ## browser-rum-react package @@ -21,14 +28,12 @@ Description
-ErrorBoundary +ErrorBoundary -Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught. - - React.Component +A React Error Boundary that captures runtime errors in its child components and reports them to Datadog RUM, rendering the `fallback` component when an error occurs.
-addReactError(error, info) +addReactError(error, info) -Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the ErrorBoundary component or React's error lifecycle. +Reports an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM with relevant context and stack information.
-reactPlugin(configuration) +reactPlugin(configuration) -Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). - -The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM \*Error\* events) - Optional react-router view tracking - Component performance tracking utilities (see UNSTABLE_ReactComponentTracker). +Factory function that creates the React plugin for Datadog RUM, enabling features like ErrorBoundary integration, optional react-router view tracking, and component performance tracking utilities.
-UNSTABLE_ReactComponentTracker +UNSTABLE_ReactComponentTracker -Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`. +Experimental component that tracks the render lifecycle of its children and reports a duration vital named `reactComponentRender`.
-(Optional) React plugin specific configuration. +(Optional)
-datadogRum +datadogRum diff --git a/docs/browser-rum.commonproperties._dd.md b/docs/browser-rum.commonproperties._dd.md index 770da23217..962cf9e60a 100644 --- a/docs/browser-rum.commonproperties._dd.md +++ b/docs/browser-rum.commonproperties._dd.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties._dd property" +nav_order: 117 +permalink: /browser-rum.commonproperties._dd.html +--- + -Home > @datadog/browser-rum > CommonProperties > _dd +Home > @datadog/browser-rum > CommonProperties > _dd ## CommonProperties._dd property @@ -10,18 +17,18 @@ Internal properties ```typescript readonly _dd: { - readonly format_version: 2; - session?: { - plan?: 1 | 2; - readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; - [k: string]: unknown; - }; - readonly configuration?: { - readonly session_sample_rate: number; - readonly session_replay_sample_rate?: number; - [k: string]: unknown; - }; - readonly browser_sdk_version?: string; - [k: string]: unknown; - }; + readonly format_version: 2; + session?: { + plan?: 1 | 2; + readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; + [k: string]: unknown; + }; + readonly configuration?: { + readonly session_sample_rate: number; + readonly session_replay_sample_rate?: number; + [k: string]: unknown; + }; + readonly browser_sdk_version?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.account.md b/docs/browser-rum.commonproperties.account.md index 3288173716..7063568f86 100644 --- a/docs/browser-rum.commonproperties.account.md +++ b/docs/browser-rum.commonproperties.account.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.account property" +nav_order: 116 +permalink: /browser-rum.commonproperties.account.html +--- + -Home > @datadog/browser-rum > CommonProperties > account +Home > @datadog/browser-rum > CommonProperties > account ## CommonProperties.account property @@ -10,8 +17,8 @@ Account properties ```typescript readonly account?: { - readonly id: string; - readonly name?: string; - [k: string]: unknown; - }; + readonly id: string; + readonly name?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.application.md b/docs/browser-rum.commonproperties.application.md index eb5eef9ea0..7b4c223e49 100644 --- a/docs/browser-rum.commonproperties.application.md +++ b/docs/browser-rum.commonproperties.application.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.application property" +nav_order: 115 +permalink: /browser-rum.commonproperties.application.html +--- + -Home > @datadog/browser-rum > CommonProperties > application +Home > @datadog/browser-rum > CommonProperties > application ## CommonProperties.application property @@ -10,7 +17,7 @@ Application properties ```typescript readonly application: { - readonly id: string; - [k: string]: unknown; - }; + readonly id: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.build_id.md b/docs/browser-rum.commonproperties.build_id.md index a228bec43a..3166bcf2b2 100644 --- a/docs/browser-rum.commonproperties.build_id.md +++ b/docs/browser-rum.commonproperties.build_id.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.build_id property" +nav_order: 114 +permalink: /browser-rum.commonproperties.build_id.html +--- + -Home > @datadog/browser-rum > CommonProperties > build_id +Home > @datadog/browser-rum > CommonProperties > build_id ## CommonProperties.build_id property diff --git a/docs/browser-rum.commonproperties.build_version.md b/docs/browser-rum.commonproperties.build_version.md index 2229436437..1deb5d8510 100644 --- a/docs/browser-rum.commonproperties.build_version.md +++ b/docs/browser-rum.commonproperties.build_version.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.build_version property" +nav_order: 113 +permalink: /browser-rum.commonproperties.build_version.html +--- + -Home > @datadog/browser-rum > CommonProperties > build_version +Home > @datadog/browser-rum > CommonProperties > build_version ## CommonProperties.build_version property diff --git a/docs/browser-rum.commonproperties.ci_test.md b/docs/browser-rum.commonproperties.ci_test.md index 4214fb0bf1..698662a751 100644 --- a/docs/browser-rum.commonproperties.ci_test.md +++ b/docs/browser-rum.commonproperties.ci_test.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.ci_test property" +nav_order: 112 +permalink: /browser-rum.commonproperties.ci_test.html +--- + -Home > @datadog/browser-rum > CommonProperties > ci_test +Home > @datadog/browser-rum > CommonProperties > ci_test ## CommonProperties.ci_test property @@ -10,7 +17,7 @@ CI Visibility properties ```typescript readonly ci_test?: { - readonly test_execution_id: string; - [k: string]: unknown; - }; + readonly test_execution_id: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.connectivity.md b/docs/browser-rum.commonproperties.connectivity.md index 506f74e0ad..ce0b0ba252 100644 --- a/docs/browser-rum.commonproperties.connectivity.md +++ b/docs/browser-rum.commonproperties.connectivity.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.connectivity property" +nav_order: 111 +permalink: /browser-rum.commonproperties.connectivity.html +--- + -Home > @datadog/browser-rum > CommonProperties > connectivity +Home > @datadog/browser-rum > CommonProperties > connectivity ## CommonProperties.connectivity property @@ -10,14 +17,14 @@ Device connectivity properties ```typescript connectivity?: { - readonly status: 'connected' | 'not_connected' | 'maybe'; - readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; - readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; - readonly cellular?: { - readonly technology?: string; - readonly carrier_name?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; + readonly status: 'connected' | 'not_connected' | 'maybe'; + readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; + readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; + readonly cellular?: { + readonly technology?: string; + readonly carrier_name?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.context.md b/docs/browser-rum.commonproperties.context.md index f169e538e6..421a7b84a5 100644 --- a/docs/browser-rum.commonproperties.context.md +++ b/docs/browser-rum.commonproperties.context.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.context property" +nav_order: 110 +permalink: /browser-rum.commonproperties.context.html +--- + -Home > @datadog/browser-rum > CommonProperties > context +Home > @datadog/browser-rum > CommonProperties > context ## CommonProperties.context property @@ -10,6 +17,6 @@ User provided context ```typescript context?: { - [k: string]: unknown; - }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.date.md b/docs/browser-rum.commonproperties.date.md index bf6a83a7b4..9e40053ce3 100644 --- a/docs/browser-rum.commonproperties.date.md +++ b/docs/browser-rum.commonproperties.date.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.date property" +nav_order: 109 +permalink: /browser-rum.commonproperties.date.html +--- + -Home > @datadog/browser-rum > CommonProperties > date +Home > @datadog/browser-rum > CommonProperties > date ## CommonProperties.date property diff --git a/docs/browser-rum.commonproperties.device.md b/docs/browser-rum.commonproperties.device.md index d5cde8df9e..ed34632b2a 100644 --- a/docs/browser-rum.commonproperties.device.md +++ b/docs/browser-rum.commonproperties.device.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.device property" +nav_order: 108 +permalink: /browser-rum.commonproperties.device.html +--- + -Home > @datadog/browser-rum > CommonProperties > device +Home > @datadog/browser-rum > CommonProperties > device ## CommonProperties.device property @@ -10,11 +17,11 @@ Device properties ```typescript device?: { - readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; - readonly name?: string; - readonly model?: string; - readonly brand?: string; - readonly architecture?: string; - [k: string]: unknown; - }; + readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; + readonly name?: string; + readonly model?: string; + readonly brand?: string; + readonly architecture?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.display.md b/docs/browser-rum.commonproperties.display.md index a2b6685296..a2246b43a2 100644 --- a/docs/browser-rum.commonproperties.display.md +++ b/docs/browser-rum.commonproperties.display.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.display property" +nav_order: 107 +permalink: /browser-rum.commonproperties.display.html +--- + -Home > @datadog/browser-rum > CommonProperties > display +Home > @datadog/browser-rum > CommonProperties > display ## CommonProperties.display property @@ -10,11 +17,11 @@ Display properties ```typescript display?: { - readonly viewport?: { - readonly width: number; - readonly height: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; + readonly viewport?: { + readonly width: number; + readonly height: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.md b/docs/browser-rum.commonproperties.md index 16c2719b4c..00666c9206 100644 --- a/docs/browser-rum.commonproperties.md +++ b/docs/browser-rum.commonproperties.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties interface" +nav_order: 106 +permalink: /browser-rum.commonproperties.html +--- + -Home > @datadog/browser-rum > CommonProperties +Home > @datadog/browser-rum > CommonProperties ## CommonProperties interface @@ -37,7 +44,7 @@ Description
-_dd +_dd @@ -47,7 +54,7 @@ Description -{ readonly format_version: 2; session?: { plan?: 1 | 2; readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; [k: string]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; [k: string]: unknown; }; readonly browser_sdk_version?: string; [k: string]: unknown; } +{ readonly format_version: 2; session?: { plan?: 1 | 2; readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; \[k: string\]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; \[k: string\]: unknown; }; readonly browser_sdk_version?: string; \[k: string\]: unknown; } @@ -58,7 +65,7 @@ Internal properties
-account? +account? @@ -68,7 +75,7 @@ Internal properties -{ readonly id: string; readonly name?: string; [k: string]: unknown; } +{ readonly id: string; readonly name?: string; \[k: string\]: unknown; } @@ -79,7 +86,7 @@ Internal properties
-application +application @@ -89,7 +96,7 @@ Internal properties -{ readonly id: string; [k: string]: unknown; } +{ readonly id: string; \[k: string\]: unknown; } @@ -100,7 +107,7 @@ Application properties
-build_id? +build_id? @@ -121,7 +128,7 @@ string
-build_version? +build_version? @@ -142,7 +149,7 @@ string
-ci_test? +ci_test? @@ -152,7 +159,7 @@ string -{ readonly test_execution_id: string; [k: string]: unknown; } +{ readonly test_execution_id: string; \[k: string\]: unknown; } @@ -163,7 +170,7 @@ string
-connectivity? +connectivity? @@ -171,7 +178,7 @@ string -{ readonly status: 'connected' | 'not_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; [k: string]: unknown; }; [k: string]: unknown; } +{ readonly status: 'connected' | 'not_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')\[\]; readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; \[k: string\]: unknown; }; \[k: string\]: unknown; } @@ -182,7 +189,7 @@ string
-context? +context? @@ -190,7 +197,7 @@ string -{ [k: string]: unknown; } +{ \[k: string\]: unknown; } @@ -201,7 +208,7 @@ string
-date +date @@ -222,7 +229,7 @@ Start of the event in ms from epoch
-device? +device? @@ -230,7 +237,7 @@ Start of the event in ms from epoch -{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; [k: string]: unknown; } +{ readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; \[k: string\]: unknown; } @@ -241,7 +248,7 @@ Start of the event in ms from epoch
-display? +display? @@ -249,7 +256,7 @@ Start of the event in ms from epoch -{ readonly viewport?: { readonly width: number; readonly height: number; [k: string]: unknown; }; [k: string]: unknown; } +{ readonly viewport?: { readonly width: number; readonly height: number; \[k: string\]: unknown; }; \[k: string\]: unknown; } @@ -260,7 +267,7 @@ Start of the event in ms from epoch
-os? +os? @@ -268,7 +275,7 @@ Start of the event in ms from epoch -{ readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; [k: string]: unknown; } +{ readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; \[k: string\]: unknown; } @@ -279,7 +286,7 @@ Start of the event in ms from epoch
-service? +service? @@ -298,7 +305,7 @@ string
-session +session @@ -308,7 +315,7 @@ string -{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci_test'; readonly has_replay?: boolean; [k: string]: unknown; } +{ readonly id: string; readonly type: 'user' | 'synthetics' | 'ci_test'; readonly has_replay?: boolean; \[k: string\]: unknown; } @@ -319,7 +326,7 @@ Session properties
-source? +source? @@ -340,7 +347,7 @@ Session properties
-synthetics? +synthetics? @@ -350,7 +357,7 @@ Session properties -{ readonly test_id: string; readonly result_id: string; readonly injected?: boolean; [k: string]: unknown; } +{ readonly test_id: string; readonly result_id: string; readonly injected?: boolean; \[k: string\]: unknown; } @@ -361,7 +368,7 @@ Session properties
-usr? +usr? @@ -371,7 +378,7 @@ Session properties -{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; [k: string]: unknown; } +{ readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; \[k: string\]: unknown; } @@ -382,7 +389,7 @@ Session properties
-version? +version? @@ -401,7 +408,7 @@ string
-view +view @@ -411,7 +418,7 @@ string -{ readonly id: string; referrer?: string; url: string; name?: string; [k: string]: unknown; } +{ readonly id: string; referrer?: string; url: string; name?: string; \[k: string\]: unknown; } diff --git a/docs/browser-rum.commonproperties.os.md b/docs/browser-rum.commonproperties.os.md index 30dacd5044..97a7f010db 100644 --- a/docs/browser-rum.commonproperties.os.md +++ b/docs/browser-rum.commonproperties.os.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.os property" +nav_order: 105 +permalink: /browser-rum.commonproperties.os.html +--- + -Home > @datadog/browser-rum > CommonProperties > os +Home > @datadog/browser-rum > CommonProperties > os ## CommonProperties.os property @@ -10,10 +17,10 @@ Operating system properties ```typescript os?: { - readonly name: string; - readonly version: string; - readonly build?: string; - readonly version_major: string; - [k: string]: unknown; - }; + readonly name: string; + readonly version: string; + readonly build?: string; + readonly version_major: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.service.md b/docs/browser-rum.commonproperties.service.md index defdf44bf6..95837bd51f 100644 --- a/docs/browser-rum.commonproperties.service.md +++ b/docs/browser-rum.commonproperties.service.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.service property" +nav_order: 104 +permalink: /browser-rum.commonproperties.service.html +--- + -Home > @datadog/browser-rum > CommonProperties > service +Home > @datadog/browser-rum > CommonProperties > service ## CommonProperties.service property diff --git a/docs/browser-rum.commonproperties.session.md b/docs/browser-rum.commonproperties.session.md index d157bac935..629aa5e737 100644 --- a/docs/browser-rum.commonproperties.session.md +++ b/docs/browser-rum.commonproperties.session.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.session property" +nav_order: 103 +permalink: /browser-rum.commonproperties.session.html +--- + -Home > @datadog/browser-rum > CommonProperties > session +Home > @datadog/browser-rum > CommonProperties > session ## CommonProperties.session property @@ -10,9 +17,9 @@ Session properties ```typescript readonly session: { - readonly id: string; - readonly type: 'user' | 'synthetics' | 'ci_test'; - readonly has_replay?: boolean; - [k: string]: unknown; - }; + readonly id: string; + readonly type: 'user' | 'synthetics' | 'ci_test'; + readonly has_replay?: boolean; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.source.md b/docs/browser-rum.commonproperties.source.md index b18802e93b..9519a2d02a 100644 --- a/docs/browser-rum.commonproperties.source.md +++ b/docs/browser-rum.commonproperties.source.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.source property" +nav_order: 102 +permalink: /browser-rum.commonproperties.source.html +--- + -Home > @datadog/browser-rum > CommonProperties > source +Home > @datadog/browser-rum > CommonProperties > source ## CommonProperties.source property diff --git a/docs/browser-rum.commonproperties.synthetics.md b/docs/browser-rum.commonproperties.synthetics.md index 134e3085ec..21c9d709f7 100644 --- a/docs/browser-rum.commonproperties.synthetics.md +++ b/docs/browser-rum.commonproperties.synthetics.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.synthetics property" +nav_order: 101 +permalink: /browser-rum.commonproperties.synthetics.html +--- + -Home > @datadog/browser-rum > CommonProperties > synthetics +Home > @datadog/browser-rum > CommonProperties > synthetics ## CommonProperties.synthetics property @@ -10,9 +17,9 @@ Synthetics properties ```typescript readonly synthetics?: { - readonly test_id: string; - readonly result_id: string; - readonly injected?: boolean; - [k: string]: unknown; - }; + readonly test_id: string; + readonly result_id: string; + readonly injected?: boolean; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.usr.md b/docs/browser-rum.commonproperties.usr.md index 32a86d51ba..7d6e88f676 100644 --- a/docs/browser-rum.commonproperties.usr.md +++ b/docs/browser-rum.commonproperties.usr.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.usr property" +nav_order: 100 +permalink: /browser-rum.commonproperties.usr.html +--- + -Home > @datadog/browser-rum > CommonProperties > usr +Home > @datadog/browser-rum > CommonProperties > usr ## CommonProperties.usr property @@ -10,10 +17,10 @@ User properties ```typescript readonly usr?: { - readonly id?: string; - readonly name?: string; - readonly email?: string; - readonly anonymous_id?: string; - [k: string]: unknown; - }; + readonly id?: string; + readonly name?: string; + readonly email?: string; + readonly anonymous_id?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.commonproperties.version.md b/docs/browser-rum.commonproperties.version.md index 69621890d1..45ab8bbcb2 100644 --- a/docs/browser-rum.commonproperties.version.md +++ b/docs/browser-rum.commonproperties.version.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.version property" +nav_order: 99 +permalink: /browser-rum.commonproperties.version.html +--- + -Home > @datadog/browser-rum > CommonProperties > version +Home > @datadog/browser-rum > CommonProperties > version ## CommonProperties.version property diff --git a/docs/browser-rum.commonproperties.view.md b/docs/browser-rum.commonproperties.view.md index 6c2575f075..84770ef441 100644 --- a/docs/browser-rum.commonproperties.view.md +++ b/docs/browser-rum.commonproperties.view.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "CommonProperties.view property" +nav_order: 98 +permalink: /browser-rum.commonproperties.view.html +--- + -Home > @datadog/browser-rum > CommonProperties > view +Home > @datadog/browser-rum > CommonProperties > view ## CommonProperties.view property @@ -10,10 +17,10 @@ View properties ```typescript readonly view: { - readonly id: string; - referrer?: string; - url: string; - name?: string; - [k: string]: unknown; - }; + readonly id: string; + referrer?: string; + url: string; + name?: string; + [k: string]: unknown; + }; ``` diff --git a/docs/browser-rum.datadogrum.md b/docs/browser-rum.datadogrum.md index b427e89cc3..a8a6850a7d 100644 --- a/docs/browser-rum.datadogrum.md +++ b/docs/browser-rum.datadogrum.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "datadogRum variable" +nav_order: 97 +permalink: /browser-rum.datadogrum.html +--- + -Home > @datadog/browser-rum > datadogRum +Home > @datadog/browser-rum > datadogRum ## datadogRum variable diff --git a/docs/browser-rum.md b/docs/browser-rum.md index 45330f2515..3a55de72cc 100644 --- a/docs/browser-rum.md +++ b/docs/browser-rum.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "browser-rum package" +nav_order: 96 +permalink: /browser-rum.html +--- + -Home > @datadog/browser-rum +Home > @datadog/browser-rum ## browser-rum package @@ -21,7 +28,7 @@ Description
-CommonProperties +CommonProperties @@ -32,7 +39,7 @@ Schema of common properties of RUM events
-RumActionEventDomainContext +RumActionEventDomainContext @@ -43,7 +50,7 @@ Additional information available when the SDK dispatches a RUM Action event.
-RumErrorEventDomainContext +RumErrorEventDomainContext @@ -54,7 +61,7 @@ Additional information available when the SDK dispatches an Error event.
-RumFetchResourceEventDomainContext +RumFetchResourceEventDomainContext @@ -65,7 +72,7 @@ Additional information available when the SDK dispatches a Fetch resource event.
-RumGlobal +RumGlobal @@ -76,7 +83,7 @@ The RUM Browser SDK global object that provides all the public methods.
-RumInitConfiguration +RumInitConfiguration @@ -87,7 +94,7 @@ Configuration options to pass to the `init()` method when initializing the RUM S
-RumLongTaskEventDomainContext +RumLongTaskEventDomainContext @@ -98,7 +105,7 @@ Additional information available when the SDK dispatches a Long Task event.
-RumOtherResourceEventDomainContext +RumOtherResourceEventDomainContext @@ -109,7 +116,7 @@ Additional information available when the SDK dispatches a Resource event that i
-RumViewEventDomainContext +RumViewEventDomainContext @@ -120,7 +127,7 @@ Additional information available when the SDK dispatches a RUM View event.
-RumXhrResourceEventDomainContext +RumXhrResourceEventDomainContext @@ -146,7 +153,7 @@ Description
-datadogRum +datadogRum @@ -172,7 +179,7 @@ Description
-RumActionEvent +RumActionEvent @@ -183,7 +190,7 @@ Schema of all properties of an Action event
-RumErrorEvent +RumErrorEvent @@ -194,7 +201,7 @@ Schema of all properties of an Error event
-RumEvent +RumEvent @@ -205,7 +212,7 @@ Schema of all properties of a RUM event
-RumEventDomainContext +RumEventDomainContext @@ -216,7 +223,7 @@ Additional context data that varies based on the type of RUM event being dispatc
-RumLongTaskEvent +RumLongTaskEvent @@ -227,7 +234,7 @@ Schema of all properties of a Long Task event
-RumResourceEvent +RumResourceEvent @@ -238,7 +245,7 @@ Schema of all properties of a Resource event
-RumViewEvent +RumViewEvent @@ -249,7 +256,7 @@ Schema of all properties of a View event
-RumVitalEvent +RumVitalEvent diff --git a/docs/browser-rum.rumactionevent.md b/docs/browser-rum.rumactionevent.md index a6f69c6bcf..16eaeecb7a 100644 --- a/docs/browser-rum.rumactionevent.md +++ b/docs/browser-rum.rumactionevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumActionEvent type" +nav_order: 95 +permalink: /browser-rum.rumactionevent.html +--- + -Home > @datadog/browser-rum > RumActionEvent +Home > @datadog/browser-rum > RumActionEvent ## RumActionEvent type @@ -10,61 +17,61 @@ Schema of all properties of an Action event ```typescript export type RumActionEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'action'; - readonly action: { - readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; - readonly id?: string; - readonly loading_time?: number; - readonly target?: { - name: string; - [k: string]: unknown; - }; - readonly frustration?: { - readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; - [k: string]: unknown; - }; - readonly error?: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly resource?: { - readonly count: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - _dd?: { - readonly action?: { - readonly position?: { - readonly x: number; - readonly y: number; - [k: string]: unknown; - }; - target?: { - readonly selector?: string; - readonly width?: number; - readonly height?: number; - [k: string]: unknown; - }; - name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'action'; + readonly action: { + readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back'; + readonly id?: string; + readonly loading_time?: number; + readonly target?: { + name: string; + [k: string]: unknown; + }; + readonly frustration?: { + readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[]; + [k: string]: unknown; + }; + readonly error?: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly resource?: { + readonly count: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + _dd?: { + readonly action?: { + readonly position?: { + readonly x: number; + readonly y: number; + [k: string]: unknown; + }; + target?: { + readonly selector?: string; + readonly width?: number; + readonly height?: number; + [k: string]: unknown; + }; + name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumactioneventdomaincontext.events.md b/docs/browser-rum.rumactioneventdomaincontext.events.md index 9a77e661c4..bb2136f9d2 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.events.md +++ b/docs/browser-rum.rumactioneventdomaincontext.events.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumActionEventDomainContext.events property" +nav_order: 94 +permalink: /browser-rum.rumactioneventdomaincontext.events.html +--- + -Home > @datadog/browser-rum > RumActionEventDomainContext > events +Home > @datadog/browser-rum > RumActionEventDomainContext > events ## RumActionEventDomainContext.events property diff --git a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md index 7963f4c0d7..3eec186299 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumactioneventdomaincontext.handlingstack.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumActionEventDomainContext.handlingStack property" +nav_order: 93 +permalink: /browser-rum.rumactioneventdomaincontext.handlingstack.html +--- + -Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumActionEventDomainContext > handlingStack ## RumActionEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumactioneventdomaincontext.md b/docs/browser-rum.rumactioneventdomaincontext.md index e7eb94c577..a44be0e1dc 100644 --- a/docs/browser-rum.rumactioneventdomaincontext.md +++ b/docs/browser-rum.rumactioneventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumActionEventDomainContext interface" +nav_order: 92 +permalink: /browser-rum.rumactioneventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumActionEventDomainContext +Home > @datadog/browser-rum > RumActionEventDomainContext ## RumActionEventDomainContext interface @@ -37,7 +44,7 @@ Description
-events? +events? @@ -45,7 +52,7 @@ Description -Event[] +Event\[\] @@ -56,7 +63,7 @@ Event[]
-handlingStack? +handlingStack? diff --git a/docs/browser-rum.rumerrorevent.md b/docs/browser-rum.rumerrorevent.md index 371dd7c7e2..589062c30f 100644 --- a/docs/browser-rum.rumerrorevent.md +++ b/docs/browser-rum.rumerrorevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumErrorEvent type" +nav_order: 91 +permalink: /browser-rum.rumerrorevent.html +--- + -Home > @datadog/browser-rum > RumErrorEvent +Home > @datadog/browser-rum > RumErrorEvent ## RumErrorEvent type @@ -10,85 +17,85 @@ Schema of all properties of an Error event ```typescript export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'error'; - readonly error: { - readonly id?: string; - message: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - stack?: string; - causes?: { - message: string; - readonly type?: string; - stack?: string; - readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; - [k: string]: unknown; - }[]; - readonly is_crash?: boolean; - fingerprint?: string; - readonly type?: string; - readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; - readonly handling?: 'handled' | 'unhandled'; - readonly handling_stack?: string; - readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; - readonly resource?: { - readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - readonly status_code: number; - url: string; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - threads?: { - readonly name: string; - readonly crashed: boolean; - readonly stack: string; - readonly state?: string; - [k: string]: unknown; - }[]; - readonly binary_images?: { - readonly uuid: string; - readonly name: string; - readonly is_system: boolean; - readonly load_address?: string; - readonly max_address?: string; - readonly arch?: string; - [k: string]: unknown; - }[]; - readonly was_truncated?: boolean; - readonly meta?: { - readonly code_type?: string; - readonly parent_process?: string; - readonly incident_identifier?: string; - readonly process?: string; - readonly exception_type?: string; - readonly exception_codes?: string; - readonly path?: string; - [k: string]: unknown; - }; - readonly csp?: { - readonly disposition?: 'enforce' | 'report'; - [k: string]: unknown; - }; - readonly time_since_app_start?: number; - [k: string]: unknown; - }; - readonly freeze?: { - readonly duration: number; - [k: string]: unknown; - }; - readonly view?: { - readonly in_foreground?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'error'; + readonly error: { + readonly id?: string; + message: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + stack?: string; + causes?: { + message: string; + readonly type?: string; + stack?: string; + readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report'; + [k: string]: unknown; + }[]; + readonly is_crash?: boolean; + fingerprint?: string; + readonly type?: string; + readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning'; + readonly handling?: 'handled' | 'unhandled'; + readonly handling_stack?: string; + readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp'; + readonly resource?: { + readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + readonly status_code: number; + url: string; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + threads?: { + readonly name: string; + readonly crashed: boolean; + readonly stack: string; + readonly state?: string; + [k: string]: unknown; + }[]; + readonly binary_images?: { + readonly uuid: string; + readonly name: string; + readonly is_system: boolean; + readonly load_address?: string; + readonly max_address?: string; + readonly arch?: string; + [k: string]: unknown; + }[]; + readonly was_truncated?: boolean; + readonly meta?: { + readonly code_type?: string; + readonly parent_process?: string; + readonly incident_identifier?: string; + readonly process?: string; + readonly exception_type?: string; + readonly exception_codes?: string; + readonly path?: string; + [k: string]: unknown; + }; + readonly csp?: { + readonly disposition?: 'enforce' | 'report'; + [k: string]: unknown; + }; + readonly time_since_app_start?: number; + [k: string]: unknown; + }; + readonly freeze?: { + readonly duration: number; + [k: string]: unknown; + }; + readonly view?: { + readonly in_foreground?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumerroreventdomaincontext.error.md b/docs/browser-rum.rumerroreventdomaincontext.error.md index b6893512cc..c5d9e45530 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.error.md +++ b/docs/browser-rum.rumerroreventdomaincontext.error.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumErrorEventDomainContext.error property" +nav_order: 90 +permalink: /browser-rum.rumerroreventdomaincontext.error.html +--- + -Home > @datadog/browser-rum > RumErrorEventDomainContext > error +Home > @datadog/browser-rum > RumErrorEventDomainContext > error ## RumErrorEventDomainContext.error property diff --git a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md index 0e27ff6e17..4f367da578 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumerroreventdomaincontext.handlingstack.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumErrorEventDomainContext.handlingStack property" +nav_order: 89 +permalink: /browser-rum.rumerroreventdomaincontext.handlingstack.html +--- + -Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumErrorEventDomainContext > handlingStack ## RumErrorEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumerroreventdomaincontext.md b/docs/browser-rum.rumerroreventdomaincontext.md index 9c50c3762e..4b3ff90ccc 100644 --- a/docs/browser-rum.rumerroreventdomaincontext.md +++ b/docs/browser-rum.rumerroreventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumErrorEventDomainContext interface" +nav_order: 88 +permalink: /browser-rum.rumerroreventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumErrorEventDomainContext +Home > @datadog/browser-rum > RumErrorEventDomainContext ## RumErrorEventDomainContext interface @@ -37,7 +44,7 @@ Description
-error +error @@ -56,7 +63,7 @@ The original error object that was captured.
-handlingStack? +handlingStack? diff --git a/docs/browser-rum.rumevent.md b/docs/browser-rum.rumevent.md index 15d672d968..74cebcca9d 100644 --- a/docs/browser-rum.rumevent.md +++ b/docs/browser-rum.rumevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumEvent type" +nav_order: 87 +permalink: /browser-rum.rumevent.html +--- + -Home > @datadog/browser-rum > RumEvent +Home > @datadog/browser-rum > RumEvent ## RumEvent type @@ -11,5 +18,5 @@ Schema of all properties of a RUM event ```typescript export type RumEvent = RumActionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumVitalEvent; ``` -**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent +**References:** RumActionEvent, RumErrorEvent, RumLongTaskEvent, RumResourceEvent, RumViewEvent, RumVitalEvent diff --git a/docs/browser-rum.rumeventdomaincontext.md b/docs/browser-rum.rumeventdomaincontext.md index 4d7ad6b101..f5a4e50b9a 100644 --- a/docs/browser-rum.rumeventdomaincontext.md +++ b/docs/browser-rum.rumeventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumEventDomainContext type" +nav_order: 86 +permalink: /browser-rum.rumeventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumEventDomainContext +Home > @datadog/browser-rum > RumEventDomainContext ## RumEventDomainContext type @@ -11,5 +18,5 @@ Additional context data that varies based on the type of RUM event being dispatc ```typescript export type RumEventDomainContext = T extends RumEventType.VIEW ? RumViewEventDomainContext : T extends RumEventType.ACTION ? RumActionEventDomainContext : T extends RumEventType.RESOURCE ? RumFetchResourceEventDomainContext | RumXhrResourceEventDomainContext | RumOtherResourceEventDomainContext : T extends RumEventType.ERROR ? RumErrorEventDomainContext : T extends RumEventType.LONG_TASK ? RumLongTaskEventDomainContext : T extends RumEventType.VITAL ? RumVitalEventDomainContext : never; ``` -**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext +**References:** RumViewEventDomainContext, RumActionEventDomainContext, RumFetchResourceEventDomainContext, RumXhrResourceEventDomainContext, RumOtherResourceEventDomainContext, RumErrorEventDomainContext, RumLongTaskEventDomainContext diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md index 097cac7751..ef4c51cd77 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.error.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.error property" +nav_order: 85 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.error.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > error ## RumFetchResourceEventDomainContext.error property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md index 83fbb50c72..c71bb69ec9 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.handlingStack property" +nav_order: 84 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.handlingstack.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > handlingStack ## RumFetchResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md index 14793c512d..74e66de3ec 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.isaborted.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.isAborted property" +nav_order: 83 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.isaborted.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > isAborted ## RumFetchResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.md index 0d303e091e..7f08e662e8 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext interface" +nav_order: 82 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext ## RumFetchResourceEventDomainContext interface @@ -37,7 +44,7 @@ Description
-error? +error? @@ -56,7 +63,7 @@ Error
-handlingStack? +handlingStack? @@ -75,7 +82,7 @@ string
-isAborted +isAborted @@ -94,7 +101,7 @@ Whether the fetch call was aborted.
-performanceEntry? +performanceEntry? @@ -113,7 +120,7 @@ PerformanceEntry
-requestInit? +requestInit? @@ -132,7 +139,7 @@ RequestInit
-requestInput +requestInput @@ -151,7 +158,7 @@ Input parameter passed to the fetch call.
-response? +response? diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md index c50666f58d..03f9159855 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.performanceEntry property" +nav_order: 81 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.performanceentry.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > performanceEntry ## RumFetchResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md index c885071c47..dd3778b91b 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinit.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.requestInit property" +nav_order: 80 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.requestinit.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInit ## RumFetchResourceEventDomainContext.requestInit property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md index b847e75b1f..aa7d9d51bd 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.requestinput.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.requestInput property" +nav_order: 79 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.requestinput.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > requestInput ## RumFetchResourceEventDomainContext.requestInput property diff --git a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md index 276ef2d3ca..ea80317107 100644 --- a/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md +++ b/docs/browser-rum.rumfetchresourceeventdomaincontext.response.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumFetchResourceEventDomainContext.response property" +nav_order: 78 +permalink: /browser-rum.rumfetchresourceeventdomaincontext.response.html +--- + -Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response +Home > @datadog/browser-rum > RumFetchResourceEventDomainContext > response ## RumFetchResourceEventDomainContext.response property diff --git a/docs/browser-rum.rumglobal.addaction.md b/docs/browser-rum.rumglobal.addaction.md index 906682c862..aecb887270 100644 --- a/docs/browser-rum.rumglobal.addaction.md +++ b/docs/browser-rum.rumglobal.addaction.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.addAction property" +nav_order: 77 +permalink: /browser-rum.rumglobal.addaction.html +--- + -Home > @datadog/browser-rum > RumGlobal > addAction +Home > @datadog/browser-rum > RumGlobal > addAction ## RumGlobal.addAction property diff --git a/docs/browser-rum.rumglobal.adddurationvital.md b/docs/browser-rum.rumglobal.adddurationvital.md index 2615b75d88..fcaf91ee50 100644 --- a/docs/browser-rum.rumglobal.adddurationvital.md +++ b/docs/browser-rum.rumglobal.adddurationvital.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.addDurationVital property" +nav_order: 76 +permalink: /browser-rum.rumglobal.adddurationvital.html +--- + -Home > @datadog/browser-rum > RumGlobal > addDurationVital +Home > @datadog/browser-rum > RumGlobal > addDurationVital ## RumGlobal.addDurationVital property @@ -10,9 +17,9 @@ Add a custom duration vital ```typescript addDurationVital: (name: string, options: { - startTime: number; - duration: number; - context?: object; - description?: string; - }) => void; + startTime: number; + duration: number; + context?: object; + description?: string; + }) => void; ``` diff --git a/docs/browser-rum.rumglobal.adderror.md b/docs/browser-rum.rumglobal.adderror.md index 7a52a90c05..8c5f374480 100644 --- a/docs/browser-rum.rumglobal.adderror.md +++ b/docs/browser-rum.rumglobal.adderror.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumGlobal.addError property" +nav_order: 75 +permalink: /browser-rum.rumglobal.adderror.html +--- + -Home > @datadog/browser-rum > RumGlobal > addError +Home > @datadog/browser-rum > RumGlobal > addError ## RumGlobal.addError property -Add a custom error, stored in `@error`. +Add a custom error, stored in `@error`. **Signature:** diff --git a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md index 6500c0cb05..76a4d846e9 100644 --- a/docs/browser-rum.rumglobal.addfeatureflagevaluation.md +++ b/docs/browser-rum.rumglobal.addfeatureflagevaluation.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.addFeatureFlagEvaluation property" +nav_order: 74 +permalink: /browser-rum.rumglobal.addfeatureflagevaluation.html +--- + -Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation +Home > @datadog/browser-rum > RumGlobal > addFeatureFlagEvaluation ## RumGlobal.addFeatureFlagEvaluation property diff --git a/docs/browser-rum.rumglobal.addtiming.md b/docs/browser-rum.rumglobal.addtiming.md index 540b61d72a..308cbee01e 100644 --- a/docs/browser-rum.rumglobal.addtiming.md +++ b/docs/browser-rum.rumglobal.addtiming.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.addTiming property" +nav_order: 73 +permalink: /browser-rum.rumglobal.addtiming.html +--- + -Home > @datadog/browser-rum > RumGlobal > addTiming +Home > @datadog/browser-rum > RumGlobal > addTiming ## RumGlobal.addTiming property diff --git a/docs/browser-rum.rumglobal.clearaccount.md b/docs/browser-rum.rumglobal.clearaccount.md index 442c5c4c4e..fc42e1160b 100644 --- a/docs/browser-rum.rumglobal.clearaccount.md +++ b/docs/browser-rum.rumglobal.clearaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.clearAccount property" +nav_order: 72 +permalink: /browser-rum.rumglobal.clearaccount.html +--- + -Home > @datadog/browser-rum > RumGlobal > clearAccount +Home > @datadog/browser-rum > RumGlobal > clearAccount ## RumGlobal.clearAccount property diff --git a/docs/browser-rum.rumglobal.clearglobalcontext.md b/docs/browser-rum.rumglobal.clearglobalcontext.md index 0a359415ba..d8704b3691 100644 --- a/docs/browser-rum.rumglobal.clearglobalcontext.md +++ b/docs/browser-rum.rumglobal.clearglobalcontext.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.clearGlobalContext property" +nav_order: 71 +permalink: /browser-rum.rumglobal.clearglobalcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > clearGlobalContext +Home > @datadog/browser-rum > RumGlobal > clearGlobalContext ## RumGlobal.clearGlobalContext property Clear the global context -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.clearuser.md b/docs/browser-rum.rumglobal.clearuser.md index a36ebcb3aa..0f63691e32 100644 --- a/docs/browser-rum.rumglobal.clearuser.md +++ b/docs/browser-rum.rumglobal.clearuser.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.clearUser property" +nav_order: 70 +permalink: /browser-rum.rumglobal.clearuser.html +--- + -Home > @datadog/browser-rum > RumGlobal > clearUser +Home > @datadog/browser-rum > RumGlobal > clearUser ## RumGlobal.clearUser property Clear all user information -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getaccount.md b/docs/browser-rum.rumglobal.getaccount.md index 9207d3f4d7..2be637db4c 100644 --- a/docs/browser-rum.rumglobal.getaccount.md +++ b/docs/browser-rum.rumglobal.getaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.getAccount property" +nav_order: 69 +permalink: /browser-rum.rumglobal.getaccount.html +--- + -Home > @datadog/browser-rum > RumGlobal > getAccount +Home > @datadog/browser-rum > RumGlobal > getAccount ## RumGlobal.getAccount property diff --git a/docs/browser-rum.rumglobal.getglobalcontext.md b/docs/browser-rum.rumglobal.getglobalcontext.md index 0c10cdaa6b..a30158f14a 100644 --- a/docs/browser-rum.rumglobal.getglobalcontext.md +++ b/docs/browser-rum.rumglobal.getglobalcontext.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.getGlobalContext property" +nav_order: 68 +permalink: /browser-rum.rumglobal.getglobalcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > getGlobalContext +Home > @datadog/browser-rum > RumGlobal > getGlobalContext ## RumGlobal.getGlobalContext property Get the global Context -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getinitconfiguration.md b/docs/browser-rum.rumglobal.getinitconfiguration.md index afe51d2e54..861e4caa24 100644 --- a/docs/browser-rum.rumglobal.getinitconfiguration.md +++ b/docs/browser-rum.rumglobal.getinitconfiguration.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.getInitConfiguration property" +nav_order: 67 +permalink: /browser-rum.rumglobal.getinitconfiguration.html +--- + -Home > @datadog/browser-rum > RumGlobal > getInitConfiguration +Home > @datadog/browser-rum > RumGlobal > getInitConfiguration ## RumGlobal.getInitConfiguration property diff --git a/docs/browser-rum.rumglobal.getinternalcontext.md b/docs/browser-rum.rumglobal.getinternalcontext.md index 5dcd08d42f..ee514add3e 100644 --- a/docs/browser-rum.rumglobal.getinternalcontext.md +++ b/docs/browser-rum.rumglobal.getinternalcontext.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumGlobal.getInternalContext property" +nav_order: 66 +permalink: /browser-rum.rumglobal.getinternalcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > getInternalContext +Home > @datadog/browser-rum > RumGlobal > getInternalContext ## RumGlobal.getInternalContext property -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context **Signature:** diff --git a/docs/browser-rum.rumglobal.getsessionreplaylink.md b/docs/browser-rum.rumglobal.getsessionreplaylink.md index 54c783f0e3..ecfa57c033 100644 --- a/docs/browser-rum.rumglobal.getsessionreplaylink.md +++ b/docs/browser-rum.rumglobal.getsessionreplaylink.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.getSessionReplayLink property" +nav_order: 65 +permalink: /browser-rum.rumglobal.getsessionreplaylink.html +--- + -Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink +Home > @datadog/browser-rum > RumGlobal > getSessionReplayLink ## RumGlobal.getSessionReplayLink property Get the Session Replay Link. -See Connect Session Replay To Your Third-Party Tools for further information. +See \Connect Session Replay To Your Third-Party Tools\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getuser.md b/docs/browser-rum.rumglobal.getuser.md index 2d8ab5ae00..9a3f981ced 100644 --- a/docs/browser-rum.rumglobal.getuser.md +++ b/docs/browser-rum.rumglobal.getuser.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.getUser property" +nav_order: 64 +permalink: /browser-rum.rumglobal.getuser.html +--- + -Home > @datadog/browser-rum > RumGlobal > getUser +Home > @datadog/browser-rum > RumGlobal > getUser ## RumGlobal.getUser property Get user information -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.getviewcontext.md b/docs/browser-rum.rumglobal.getviewcontext.md index a39be299f6..390755ac6f 100644 --- a/docs/browser-rum.rumglobal.getviewcontext.md +++ b/docs/browser-rum.rumglobal.getviewcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.getViewContext property" +nav_order: 63 +permalink: /browser-rum.rumglobal.getviewcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > getViewContext +Home > @datadog/browser-rum > RumGlobal > getViewContext ## RumGlobal.getViewContext property diff --git a/docs/browser-rum.rumglobal.init.md b/docs/browser-rum.rumglobal.init.md index 468eee8769..5238c118ed 100644 --- a/docs/browser-rum.rumglobal.init.md +++ b/docs/browser-rum.rumglobal.init.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.init property" +nav_order: 62 +permalink: /browser-rum.rumglobal.init.html +--- + -Home > @datadog/browser-rum > RumGlobal > init +Home > @datadog/browser-rum > RumGlobal > init ## RumGlobal.init property diff --git a/docs/browser-rum.rumglobal.md b/docs/browser-rum.rumglobal.md index 5217531576..261cbe99a6 100644 --- a/docs/browser-rum.rumglobal.md +++ b/docs/browser-rum.rumglobal.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal interface" +nav_order: 61 +permalink: /browser-rum.rumglobal.html +--- + -Home > @datadog/browser-rum > RumGlobal +Home > @datadog/browser-rum > RumGlobal ## RumGlobal interface @@ -38,7 +45,7 @@ Description
-addAction +addAction @@ -46,7 +53,7 @@ Description -(name: string, context?: object) => void +(name: string, context?: object) => void @@ -57,7 +64,7 @@ Add a custom action, stored in `@action`
-addDurationVital +addDurationVital @@ -65,7 +72,7 @@ Add a custom action, stored in `@action` -(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void +(name: string, options: { startTime: number; duration: number; context?: object; description?: string; }) => void @@ -76,7 +83,7 @@ Add a custom duration vital
-addError +addError @@ -84,18 +91,18 @@ Add a custom duration vital -(error: unknown, context?: object) => void +(error: unknown, context?: object) => void -Add a custom error, stored in `@error`. +Add a custom error, stored in `@error`.
-addFeatureFlagEvaluation +addFeatureFlagEvaluation @@ -103,7 +110,7 @@ Add a custom error, stored in `@error`. -(key: string, value: any) => void +(key: string, value: any) => void @@ -114,7 +121,7 @@ Add a feature flag evaluation, stored in `@feature_flags.`
-addTiming +addTiming @@ -122,7 +129,7 @@ Add a feature flag evaluation, stored in `@feature_flags.` -(name: string, time?: number) => void +(name: string, time?: number) => void @@ -133,7 +140,7 @@ Add a custom timing relative to the start of the current view, stored in `@view.
-clearAccount +clearAccount @@ -141,7 +148,7 @@ Add a custom timing relative to the start of the current view, stored in `@view. -() => void +() => void @@ -152,7 +159,7 @@ Clear all account information
-clearGlobalContext +clearGlobalContext @@ -160,20 +167,20 @@ Clear all account information -() => void +() => void Clear the global context -See Global context for further information. +See \Global context\ for further information.
-clearUser +clearUser @@ -181,20 +188,20 @@ See User session for further information. +See \User session\ for further information.
-getAccount +getAccount @@ -202,7 +209,7 @@ See getGlobalContext +getGlobalContext @@ -221,20 +228,20 @@ Get account information -() => Context +() => Context Get the global Context -See Global context for further information. +See \Global context\ for further information.
-getInitConfiguration +getInitConfiguration @@ -242,7 +249,7 @@ See RumInitConfiguration | undefined +() => RumInitConfiguration | undefined @@ -253,7 +260,7 @@ Get the init configuration
-getInternalContext +getInternalContext @@ -261,18 +268,18 @@ Get the init configuration -(startTime?: number) => InternalContext | undefined +(startTime?: number) => InternalContext | undefined -[Internal API] Get the internal SDK context +\[Internal API\] Get the internal SDK context
-getSessionReplayLink +getSessionReplayLink @@ -280,20 +287,20 @@ Get the init configuration -() => string | undefined +() => string | undefined Get the Session Replay Link. -See Connect Session Replay To Your Third-Party Tools for further information. +See \Connect Session Replay To Your Third-Party Tools\ for further information.
-getUser +getUser @@ -301,20 +308,20 @@ See User session for further information. +See \User session\ for further information.
-getViewContext +getViewContext @@ -322,7 +329,7 @@ See init +init @@ -341,7 +348,7 @@ Get View Context. -(initConfiguration: RumInitConfiguration) => void +(initConfiguration: RumInitConfiguration) => void @@ -352,7 +359,7 @@ Init the RUM browser SDK.
-removeAccountProperty +removeAccountProperty @@ -360,7 +367,7 @@ Init the RUM browser SDK. -(key: string) => void +(key: string) => void @@ -371,7 +378,7 @@ Remove an account property
-removeGlobalContextProperty +removeGlobalContextProperty @@ -379,20 +386,20 @@ Remove an account property -(key: any) => void +(key: any) => void Remove a global context property -See Global context for further information. +See \Global context\ for further information.
-removeUserProperty +removeUserProperty @@ -400,20 +407,20 @@ See User session for further information. +See \User session\ for further information.
-setAccount +setAccount @@ -421,7 +428,7 @@ See setAccountProperty +setAccountProperty @@ -440,7 +447,7 @@ Set account information to all events, stored in `@account` -(key: string, property: any) => void +(key: string, property: any) => void @@ -451,7 +458,7 @@ Set or update the account property, stored in `@account.`
-setGlobalContext +setGlobalContext @@ -459,7 +466,7 @@ Set or update the account property, stored in `@account.` -(context: any) => void +(context: any) => void @@ -470,7 +477,7 @@ Set the global context information to all events, stored in `@context`
-setGlobalContextProperty +setGlobalContextProperty @@ -478,7 +485,7 @@ Set the global context information to all events, stored in `@context` -(key: any, value: any) => void +(key: any, value: any) => void @@ -489,7 +496,7 @@ Set or update a global context property, stored in `@context.`
-setTrackingConsent +setTrackingConsent @@ -497,7 +504,7 @@ Set or update a global context property, stored in `@context.` -(trackingConsent: TrackingConsent) => void +(trackingConsent: TrackingConsent) => void @@ -508,7 +515,7 @@ Set the tracking consent of the current user.
-setUserProperty +setUserProperty @@ -516,7 +523,7 @@ Set the tracking consent of the current user. -(key: any, property: any) => void +(key: any, property: any) => void @@ -527,7 +534,7 @@ Set or update the user property, stored in `@usr.`
-setViewContext +setViewContext @@ -535,7 +542,7 @@ Set or update the user property, stored in `@usr.` -(context: Context) => void +(context: Context) => void @@ -548,7 +555,7 @@ Enable to manually set the context of the current view.
-setViewContextProperty +setViewContextProperty @@ -556,7 +563,7 @@ Enable to manually set the context of the current view. -(key: string, value: any) => void +(key: string, value: any) => void @@ -569,7 +576,7 @@ Enable to manually set a property of the context of the current view.
-setViewName +setViewName @@ -577,7 +584,7 @@ Enable to manually set a property of the context of the current view. -(name: string) => void +(name: string) => void @@ -590,7 +597,7 @@ Enable to manually change the name of the current view.
-startDurationVital +startDurationVital @@ -598,7 +605,7 @@ Enable to manually change the name of the current view. -(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference +(name: string, options?: { context?: object; description?: string; }) => DurationVitalReference @@ -611,7 +618,7 @@ If you plan to have multiple durations for the same vital, you should use the re
-startSessionReplayRecording +startSessionReplayRecording @@ -619,20 +626,20 @@ If you plan to have multiple durations for the same vital, you should use the re -(options?: StartRecordingOptions) => void +(options?: StartRecordingOptions) => void Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information.
-startView +startView @@ -651,7 +658,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t
-stopDurationVital +stopDurationVital @@ -659,7 +666,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t -(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void +(nameOrRef: string | DurationVitalReference, options?: { context?: object; description?: string; }) => void @@ -670,7 +677,7 @@ Stop a custom duration vital
-stopSession +stopSession @@ -678,7 +685,7 @@ Stop a custom duration vital -() => void +() => void @@ -689,7 +696,7 @@ Stop the session. A new session will start at the next user interaction with the
-stopSessionReplayRecording +stopSessionReplayRecording @@ -697,14 +704,14 @@ Stop the session. A new session will start at the next user interaction with the -() => void +() => void Stop Session Replay recording. -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information.
-setUser(newUser) +setUser(newUser) Set user information to all events, stored in `@usr` -See User session for further information. +See \User session\ for further information.
-setUser(newUser) +setUser(newUser) diff --git a/docs/browser-rum.rumglobal.removeaccountproperty.md b/docs/browser-rum.rumglobal.removeaccountproperty.md index e73d73dbe8..dc0966e096 100644 --- a/docs/browser-rum.rumglobal.removeaccountproperty.md +++ b/docs/browser-rum.rumglobal.removeaccountproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.removeAccountProperty property" +nav_order: 60 +permalink: /browser-rum.rumglobal.removeaccountproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > removeAccountProperty +Home > @datadog/browser-rum > RumGlobal > removeAccountProperty ## RumGlobal.removeAccountProperty property diff --git a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md index 70a6cc418d..5a687d259c 100644 --- a/docs/browser-rum.rumglobal.removeglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.removeglobalcontextproperty.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.removeGlobalContextProperty property" +nav_order: 59 +permalink: /browser-rum.rumglobal.removeglobalcontextproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > removeGlobalContextProperty ## RumGlobal.removeGlobalContextProperty property Remove a global context property -See Global context for further information. +See \Global context\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.removeuserproperty.md b/docs/browser-rum.rumglobal.removeuserproperty.md index b49f944b0a..d312f17ad6 100644 --- a/docs/browser-rum.rumglobal.removeuserproperty.md +++ b/docs/browser-rum.rumglobal.removeuserproperty.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.removeUserProperty property" +nav_order: 58 +permalink: /browser-rum.rumglobal.removeuserproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > removeUserProperty +Home > @datadog/browser-rum > RumGlobal > removeUserProperty ## RumGlobal.removeUserProperty property Remove a user property -See User session for further information. +See \User session\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.setaccount.md b/docs/browser-rum.rumglobal.setaccount.md index 282ddeffb7..dad53265b1 100644 --- a/docs/browser-rum.rumglobal.setaccount.md +++ b/docs/browser-rum.rumglobal.setaccount.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setAccount property" +nav_order: 57 +permalink: /browser-rum.rumglobal.setaccount.html +--- + -Home > @datadog/browser-rum > RumGlobal > setAccount +Home > @datadog/browser-rum > RumGlobal > setAccount ## RumGlobal.setAccount property diff --git a/docs/browser-rum.rumglobal.setaccountproperty.md b/docs/browser-rum.rumglobal.setaccountproperty.md index 9c6cdaa4b6..a7ef2e7ffd 100644 --- a/docs/browser-rum.rumglobal.setaccountproperty.md +++ b/docs/browser-rum.rumglobal.setaccountproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setAccountProperty property" +nav_order: 56 +permalink: /browser-rum.rumglobal.setaccountproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > setAccountProperty +Home > @datadog/browser-rum > RumGlobal > setAccountProperty ## RumGlobal.setAccountProperty property diff --git a/docs/browser-rum.rumglobal.setglobalcontext.md b/docs/browser-rum.rumglobal.setglobalcontext.md index 037b8fb12d..e8201fbb10 100644 --- a/docs/browser-rum.rumglobal.setglobalcontext.md +++ b/docs/browser-rum.rumglobal.setglobalcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setGlobalContext property" +nav_order: 55 +permalink: /browser-rum.rumglobal.setglobalcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > setGlobalContext +Home > @datadog/browser-rum > RumGlobal > setGlobalContext ## RumGlobal.setGlobalContext property diff --git a/docs/browser-rum.rumglobal.setglobalcontextproperty.md b/docs/browser-rum.rumglobal.setglobalcontextproperty.md index 63132b3c24..8ea7a14eed 100644 --- a/docs/browser-rum.rumglobal.setglobalcontextproperty.md +++ b/docs/browser-rum.rumglobal.setglobalcontextproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setGlobalContextProperty property" +nav_order: 54 +permalink: /browser-rum.rumglobal.setglobalcontextproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty +Home > @datadog/browser-rum > RumGlobal > setGlobalContextProperty ## RumGlobal.setGlobalContextProperty property diff --git a/docs/browser-rum.rumglobal.settrackingconsent.md b/docs/browser-rum.rumglobal.settrackingconsent.md index a6438b3028..3d27ff610b 100644 --- a/docs/browser-rum.rumglobal.settrackingconsent.md +++ b/docs/browser-rum.rumglobal.settrackingconsent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setTrackingConsent property" +nav_order: 53 +permalink: /browser-rum.rumglobal.settrackingconsent.html +--- + -Home > @datadog/browser-rum > RumGlobal > setTrackingConsent +Home > @datadog/browser-rum > RumGlobal > setTrackingConsent ## RumGlobal.setTrackingConsent property diff --git a/docs/browser-rum.rumglobal.setuser.md b/docs/browser-rum.rumglobal.setuser.md index 15119a6e37..57c136e528 100644 --- a/docs/browser-rum.rumglobal.setuser.md +++ b/docs/browser-rum.rumglobal.setuser.md @@ -1,19 +1,26 @@ +--- +layout: default +title: "RumGlobal.setUser() method" +nav_order: 52 +permalink: /browser-rum.rumglobal.setuser.html +--- + -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method Set user information to all events, stored in `@usr` -See User session for further information. +See \User session\ for further information. **Signature:** ```typescript setUser(newUser: User & { - id: string; - }): void; + id: string; + }): void; ``` ## Parameters @@ -41,7 +48,7 @@ newUser -User & { id: string; } +User & { id: string; } diff --git a/docs/browser-rum.rumglobal.setuser_1.md b/docs/browser-rum.rumglobal.setuser_1.md index 33de258369..f3efe9a09c 100644 --- a/docs/browser-rum.rumglobal.setuser_1.md +++ b/docs/browser-rum.rumglobal.setuser_1.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setUser() method" +nav_order: 51 +permalink: /browser-rum.rumglobal.setuser_1.html +--- + -Home > @datadog/browser-rum > RumGlobal > setUser +Home > @datadog/browser-rum > RumGlobal > setUser ## RumGlobal.setUser() method diff --git a/docs/browser-rum.rumglobal.setuserproperty.md b/docs/browser-rum.rumglobal.setuserproperty.md index 53c490fc62..5ba6d98702 100644 --- a/docs/browser-rum.rumglobal.setuserproperty.md +++ b/docs/browser-rum.rumglobal.setuserproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setUserProperty property" +nav_order: 50 +permalink: /browser-rum.rumglobal.setuserproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > setUserProperty +Home > @datadog/browser-rum > RumGlobal > setUserProperty ## RumGlobal.setUserProperty property diff --git a/docs/browser-rum.rumglobal.setviewcontext.md b/docs/browser-rum.rumglobal.setviewcontext.md index 85afdb7c2c..5bb6781221 100644 --- a/docs/browser-rum.rumglobal.setviewcontext.md +++ b/docs/browser-rum.rumglobal.setviewcontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setViewContext property" +nav_order: 49 +permalink: /browser-rum.rumglobal.setviewcontext.html +--- + -Home > @datadog/browser-rum > RumGlobal > setViewContext +Home > @datadog/browser-rum > RumGlobal > setViewContext ## RumGlobal.setViewContext property diff --git a/docs/browser-rum.rumglobal.setviewcontextproperty.md b/docs/browser-rum.rumglobal.setviewcontextproperty.md index a320a525a6..6455f010cd 100644 --- a/docs/browser-rum.rumglobal.setviewcontextproperty.md +++ b/docs/browser-rum.rumglobal.setviewcontextproperty.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setViewContextProperty property" +nav_order: 48 +permalink: /browser-rum.rumglobal.setviewcontextproperty.html +--- + -Home > @datadog/browser-rum > RumGlobal > setViewContextProperty +Home > @datadog/browser-rum > RumGlobal > setViewContextProperty ## RumGlobal.setViewContextProperty property diff --git a/docs/browser-rum.rumglobal.setviewname.md b/docs/browser-rum.rumglobal.setviewname.md index 2fb7ffec9b..7af8d03a41 100644 --- a/docs/browser-rum.rumglobal.setviewname.md +++ b/docs/browser-rum.rumglobal.setviewname.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.setViewName property" +nav_order: 47 +permalink: /browser-rum.rumglobal.setviewname.html +--- + -Home > @datadog/browser-rum > RumGlobal > setViewName +Home > @datadog/browser-rum > RumGlobal > setViewName ## RumGlobal.setViewName property diff --git a/docs/browser-rum.rumglobal.startdurationvital.md b/docs/browser-rum.rumglobal.startdurationvital.md index 8cfd1f3788..9514e62d59 100644 --- a/docs/browser-rum.rumglobal.startdurationvital.md +++ b/docs/browser-rum.rumglobal.startdurationvital.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.startDurationVital property" +nav_order: 46 +permalink: /browser-rum.rumglobal.startdurationvital.html +--- + -Home > @datadog/browser-rum > RumGlobal > startDurationVital +Home > @datadog/browser-rum > RumGlobal > startDurationVital ## RumGlobal.startDurationVital property @@ -12,7 +19,7 @@ If you plan to have multiple durations for the same vital, you should use the re ```typescript startDurationVital: (name: string, options?: { - context?: object; - description?: string; - }) => DurationVitalReference; + context?: object; + description?: string; + }) => DurationVitalReference; ``` diff --git a/docs/browser-rum.rumglobal.startsessionreplayrecording.md b/docs/browser-rum.rumglobal.startsessionreplayrecording.md index 81bc8f1613..382a950bc0 100644 --- a/docs/browser-rum.rumglobal.startsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.startsessionreplayrecording.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.startSessionReplayRecording property" +nav_order: 45 +permalink: /browser-rum.rumglobal.startsessionreplayrecording.html +--- + -Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > startSessionReplayRecording ## RumGlobal.startSessionReplayRecording property Start Session Replay recording. Enable to conditionally start the recording, use the `startSessionReplayRecordingManually:true` init parameter and call `startSessionReplayRecording()` -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. **Signature:** diff --git a/docs/browser-rum.rumglobal.startview.md b/docs/browser-rum.rumglobal.startview.md index b4be83846a..24fe662188 100644 --- a/docs/browser-rum.rumglobal.startview.md +++ b/docs/browser-rum.rumglobal.startview.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.startView property" +nav_order: 44 +permalink: /browser-rum.rumglobal.startview.html +--- + -Home > @datadog/browser-rum > RumGlobal > startView +Home > @datadog/browser-rum > RumGlobal > startView ## RumGlobal.startView property @@ -10,7 +17,7 @@ Start a view manually. Enable to manual start a view, use `trackViewsManually: t ```typescript startView: { - (name?: string): void; - (options: ViewOptions): void; - }; + (name?: string): void; + (options: ViewOptions): void; + }; ``` diff --git a/docs/browser-rum.rumglobal.stopdurationvital.md b/docs/browser-rum.rumglobal.stopdurationvital.md index de6c4d82ff..01e1517e81 100644 --- a/docs/browser-rum.rumglobal.stopdurationvital.md +++ b/docs/browser-rum.rumglobal.stopdurationvital.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.stopDurationVital property" +nav_order: 43 +permalink: /browser-rum.rumglobal.stopdurationvital.html +--- + -Home > @datadog/browser-rum > RumGlobal > stopDurationVital +Home > @datadog/browser-rum > RumGlobal > stopDurationVital ## RumGlobal.stopDurationVital property @@ -10,7 +17,7 @@ Stop a custom duration vital ```typescript stopDurationVital: (nameOrRef: string | DurationVitalReference, options?: { - context?: object; - description?: string; - }) => void; + context?: object; + description?: string; + }) => void; ``` diff --git a/docs/browser-rum.rumglobal.stopsession.md b/docs/browser-rum.rumglobal.stopsession.md index b0d56aae9c..3afbbb0660 100644 --- a/docs/browser-rum.rumglobal.stopsession.md +++ b/docs/browser-rum.rumglobal.stopsession.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumGlobal.stopSession property" +nav_order: 42 +permalink: /browser-rum.rumglobal.stopsession.html +--- + -Home > @datadog/browser-rum > RumGlobal > stopSession +Home > @datadog/browser-rum > RumGlobal > stopSession ## RumGlobal.stopSession property diff --git a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md index 8ca302e154..090058dcd7 100644 --- a/docs/browser-rum.rumglobal.stopsessionreplayrecording.md +++ b/docs/browser-rum.rumglobal.stopsessionreplayrecording.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumGlobal.stopSessionReplayRecording property" +nav_order: 41 +permalink: /browser-rum.rumglobal.stopsessionreplayrecording.html +--- + -Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording +Home > @datadog/browser-rum > RumGlobal > stopSessionReplayRecording ## RumGlobal.stopSessionReplayRecording property Stop Session Replay recording. -See Browser Session Replay for further information. +See \Browser Session Replay\ for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md index 3427bb3d4b..10d819862b 100644 --- a/docs/browser-rum.ruminitconfiguration.actionnameattribute.md +++ b/docs/browser-rum.ruminitconfiguration.actionnameattribute.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.actionNameAttribute property" +nav_order: 40 +permalink: /browser-rum.ruminitconfiguration.actionnameattribute.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute +Home > @datadog/browser-rum > RumInitConfiguration > actionNameAttribute ## RumInitConfiguration.actionNameAttribute property -Specify your own attribute to use to name actions. See Declare a name for click actions for further information. +Specify your own attribute to use to name actions. See Declare a name for click actions for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md index 6edf17216e..68c3000693 100644 --- a/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md +++ b/docs/browser-rum.ruminitconfiguration.allowedtracingurls.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.allowedTracingUrls property" +nav_order: 39 +permalink: /browser-rum.ruminitconfiguration.allowedtracingurls.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls +Home > @datadog/browser-rum > RumInitConfiguration > allowedTracingUrls ## RumInitConfiguration.allowedTracingUrls property -A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. +A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.applicationid.md b/docs/browser-rum.ruminitconfiguration.applicationid.md index c24305b9f1..c7afd087d6 100644 --- a/docs/browser-rum.ruminitconfiguration.applicationid.md +++ b/docs/browser-rum.ruminitconfiguration.applicationid.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration.applicationId property" +nav_order: 38 +permalink: /browser-rum.ruminitconfiguration.applicationid.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > applicationId +Home > @datadog/browser-rum > RumInitConfiguration > applicationId ## RumInitConfiguration.applicationId property diff --git a/docs/browser-rum.ruminitconfiguration.beforesend.md b/docs/browser-rum.ruminitconfiguration.beforesend.md index 091f921c57..d4d5a096f6 100644 --- a/docs/browser-rum.ruminitconfiguration.beforesend.md +++ b/docs/browser-rum.ruminitconfiguration.beforesend.md @@ -1,12 +1,19 @@ +--- +layout: default +title: "RumInitConfiguration.beforeSend property" +nav_order: 37 +permalink: /browser-rum.ruminitconfiguration.beforesend.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > beforeSend +Home > @datadog/browser-rum > RumInitConfiguration > beforeSend ## RumInitConfiguration.beforeSend property Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events -See Enrich And Control Browser RUM Data With beforeSend for further information. +See Enrich And Control Browser RUM Data With beforeSend for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md index 9d99f6048a..858a1230a9 100644 --- a/docs/browser-rum.ruminitconfiguration.compressintakerequests.md +++ b/docs/browser-rum.ruminitconfiguration.compressintakerequests.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.compressIntakeRequests property" +nav_order: 36 +permalink: /browser-rum.ruminitconfiguration.compressintakerequests.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests +Home > @datadog/browser-rum > RumInitConfiguration > compressIntakeRequests ## RumInitConfiguration.compressIntakeRequests property -Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. +Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md index df1456fe6e..50271aa0c7 100644 --- a/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md +++ b/docs/browser-rum.ruminitconfiguration.defaultprivacylevel.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.defaultPrivacyLevel property" +nav_order: 35 +permalink: /browser-rum.ruminitconfiguration.defaultprivacylevel.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel +Home > @datadog/browser-rum > RumInitConfiguration > defaultPrivacyLevel ## RumInitConfiguration.defaultPrivacyLevel property -Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md index bfccd771d6..ec9ddcf82a 100644 --- a/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md +++ b/docs/browser-rum.ruminitconfiguration.enableprivacyforactionname.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration.enablePrivacyForActionName property" +nav_order: 34 +permalink: /browser-rum.ruminitconfiguration.enableprivacyforactionname.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName +Home > @datadog/browser-rum > RumInitConfiguration > enablePrivacyForActionName ## RumInitConfiguration.enablePrivacyForActionName property diff --git a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md index e1273d2789..d6724737dd 100644 --- a/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md +++ b/docs/browser-rum.ruminitconfiguration.excludedactivityurls.md @@ -1,10 +1,17 @@ +--- +layout: default +title: "RumInitConfiguration.excludedActivityUrls property" +nav_order: 33 +permalink: /browser-rum.ruminitconfiguration.excludedactivityurls.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls +Home > @datadog/browser-rum > RumInitConfiguration > excludedActivityUrls ## RumInitConfiguration.excludedActivityUrls property -A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. +A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. **Signature:** diff --git a/docs/browser-rum.ruminitconfiguration.md b/docs/browser-rum.ruminitconfiguration.md index 73ec70898d..f2c43c91b5 100644 --- a/docs/browser-rum.ruminitconfiguration.md +++ b/docs/browser-rum.ruminitconfiguration.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumInitConfiguration interface" +nav_order: 32 +permalink: /browser-rum.ruminitconfiguration.html +--- + -Home > @datadog/browser-rum > RumInitConfiguration +Home > @datadog/browser-rum > RumInitConfiguration ## RumInitConfiguration interface @@ -38,7 +45,7 @@ Description
-actionNameAttribute? +actionNameAttribute? @@ -51,13 +58,13 @@ string | undefined -(Optional) Specify your own attribute to use to name actions. See Declare a name for click actions for further information. +(Optional) Specify your own attribute to use to name actions. See Declare a name for click actions for further information.
-allowedTracingUrls? +allowedTracingUrls? @@ -65,18 +72,18 @@ string | undefined -Array | undefined +Array<MatchOption | TracingOption> | undefined -(Optional) A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information. +(Optional) A list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information.
-applicationId +applicationId @@ -95,7 +102,7 @@ The RUM application ID.
-beforeSend? +beforeSend? @@ -103,20 +110,20 @@ The RUM application ID. -((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined +((event: RumEvent, context: RumEventDomainContext) => boolean) | undefined (Optional) Access to every event collected by the RUM SDK before they are sent to Datadog. It allows: - Enrich your RUM events with additional context attributes - Modify your RUM events to modify their content, or redact sensitive sequences (see the list of editable properties) - Discard selected RUM events -See Enrich And Control Browser RUM Data With beforeSend for further information. +See Enrich And Control Browser RUM Data With beforeSend for further information.
-compressIntakeRequests? +compressIntakeRequests? @@ -129,13 +136,13 @@ boolean | undefined -(Optional) Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information. +(Optional) Compress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information.
-defaultPrivacyLevel? +defaultPrivacyLevel? @@ -148,13 +155,13 @@ DefaultPrivacyLevel | undefined -(Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information. +(Optional) Allow to protect end user privacy and prevent sensitive organizational information from being collected. mask See Replay Privacy Options for further information.
-enablePrivacyForActionName? +enablePrivacyForActionName? @@ -173,7 +180,7 @@ boolean | undefined
-excludedActivityUrls? +excludedActivityUrls? @@ -181,18 +188,18 @@ boolean | undefined -MatchOption[] | undefined +MatchOption\[\] | undefined -(Optional) A list of request origins ignored when computing the page activity. See How page activity is calculated for further information. +(Optional) A list of request origins ignored when computing the page activity. See How page activity is calculated for further information.
-plugins? +plugins? @@ -200,7 +207,7 @@ MatchOption[] | undefined -RumPlugin[] | undefined +RumPlugin\[\] | undefined @@ -211,7 +218,7 @@ RumPlugin[] | undefined
-profilingSampleRate? +profilingSampleRate? @@ -224,13 +231,13 @@ number | undefined -(Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0 +(Optional) Not ready for production. The percentage of users profiled. A value between 0 and 100. 0
-propagateTraceBaggage? +propagateTraceBaggage? @@ -243,13 +250,13 @@ boolean | undefined -(Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false +(Optional) Whether to propagate user and account IDs in the baggage header of trace requests. false
-remoteConfigurationId? +remoteConfigurationId? @@ -268,7 +275,7 @@ string | undefined
-sessionReplaySampleRate? +sessionReplaySampleRate? @@ -281,13 +288,13 @@ number | undefined -(Optional) The percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information. +(Optional) The percentage of tracked sessions with \Browser RUM & Session Replay pricing\ features: 100 for all, 0 for none. See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information.
-startSessionReplayRecordingManually? +startSessionReplayRecordingManually? @@ -300,13 +307,13 @@ boolean | undefined -(Optional) If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information. +(Optional) If the session is sampled for Session Replay, only start the recording when `startSessionReplayRecording()` is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false. See Session Replay Usage for further information.
-subdomain? +subdomain? @@ -319,13 +326,13 @@ string -(Optional) If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information. +(Optional) If you are accessing Datadog through a custom subdomain, you can set `subdomain` to include your custom domain in the `getSessionReplayLink()` returned URL . See Connect Session Replay To Your Third-Party Tools for further information.
-traceContextInjection? +traceContextInjection? @@ -338,13 +345,13 @@ TraceContextInjection | undefined -(Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information. +(Optional) If you set a `traceSampleRate`, to ensure backend services' sampling decisions are still applied, configure the `traceContextInjection` initialization parameter to sampled. sampled See Connect RUM and Traces for further information.
-traceSampleRate? +traceSampleRate? @@ -357,13 +364,13 @@ number | undefined -(Optional) The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information. +(Optional) The percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information.
-trackFeatureFlagsForEvents? +trackFeatureFlagsForEvents? @@ -371,7 +378,7 @@ number | undefined -FeatureFlagsForEvents[] +FeatureFlagsForEvents\[\] @@ -382,7 +389,7 @@ FeatureFlagsForEvents[]
-trackLongTasks? +trackLongTasks? @@ -395,13 +402,13 @@ boolean | undefined -(Optional) Enables collection of long task events. true +(Optional) Enables collection of long task events. true
-trackResources? +trackResources? @@ -414,13 +421,13 @@ boolean | undefined -(Optional) Enables collection of resource events. true +(Optional) Enables collection of resource events. true
-trackUserInteractions? +trackUserInteractions? @@ -433,13 +440,13 @@ boolean | undefined -(Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true +(Optional) Enables automatic collection of users actions. See Tracking User Actions for further information. true
-trackViewsManually? +trackViewsManually? @@ -452,13 +459,13 @@ boolean | undefined -(Optional) Allows you to control RUM views creation. See Override default RUM view names for further information. +(Optional) Allows you to control RUM views creation. See Override default RUM view names for further information.
-workerUrl? +workerUrl? @@ -471,7 +478,7 @@ string -(Optional) URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information. +(Optional) URL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information.
-performanceEntry +performanceEntry diff --git a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md index fe9607ae38..9e50afe287 100644 --- a/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumlongtaskeventdomaincontext.performanceentry.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumLongTaskEventDomainContext.performanceEntry property" +nav_order: 14 +permalink: /browser-rum.rumlongtaskeventdomaincontext.performanceentry.html +--- + -Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumLongTaskEventDomainContext > performanceEntry ## RumLongTaskEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.md b/docs/browser-rum.rumotherresourceeventdomaincontext.md index 0a9fbbfa2d..b22d3fcf57 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumOtherResourceEventDomainContext interface" +nav_order: 13 +permalink: /browser-rum.rumotherresourceeventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext ## RumOtherResourceEventDomainContext interface @@ -37,7 +44,7 @@ Description
-performanceEntry +performanceEntry diff --git a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md index 2722850cd7..85f24a0e8d 100644 --- a/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumotherresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumOtherResourceEventDomainContext.performanceEntry property" +nav_order: 12 +permalink: /browser-rum.rumotherresourceeventdomaincontext.performanceentry.html +--- + -Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumOtherResourceEventDomainContext > performanceEntry ## RumOtherResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumresourceevent.md b/docs/browser-rum.rumresourceevent.md index e20b147b5b..fb27ba44e2 100644 --- a/docs/browser-rum.rumresourceevent.md +++ b/docs/browser-rum.rumresourceevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumResourceEvent type" +nav_order: 11 +permalink: /browser-rum.rumresourceevent.html +--- + -Home > @datadog/browser-rum > RumResourceEvent +Home > @datadog/browser-rum > RumResourceEvent ## RumResourceEvent type @@ -10,80 +17,80 @@ Schema of all properties of a Resource event ```typescript export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & { - readonly type: 'resource'; - readonly resource: { - readonly id?: string; - readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; - readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; - url: string; - readonly status_code?: number; - readonly duration?: number; - readonly size?: number; - readonly encoded_body_size?: number; - readonly decoded_body_size?: number; - readonly transfer_size?: number; - readonly render_blocking_status?: 'blocking' | 'non-blocking'; - readonly worker?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly redirect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly dns?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly connect?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly ssl?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly first_byte?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly download?: { - readonly duration: number; - readonly start: number; - [k: string]: unknown; - }; - readonly protocol?: string; - readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; - readonly provider?: { - readonly domain?: string; - readonly name?: string; - readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; - [k: string]: unknown; - }; - readonly graphql?: { - readonly operationType: 'query' | 'mutation' | 'subscription'; - readonly operationName?: string; - payload?: string; - variables?: string; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly span_id?: string; - readonly trace_id?: string; - readonly rule_psr?: number; - readonly discarded?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'resource'; + readonly resource: { + readonly id?: string; + readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native'; + readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT'; + url: string; + readonly status_code?: number; + readonly duration?: number; + readonly size?: number; + readonly encoded_body_size?: number; + readonly decoded_body_size?: number; + readonly transfer_size?: number; + readonly render_blocking_status?: 'blocking' | 'non-blocking'; + readonly worker?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly redirect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly dns?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly connect?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly ssl?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly first_byte?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly download?: { + readonly duration: number; + readonly start: number; + [k: string]: unknown; + }; + readonly protocol?: string; + readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other'; + readonly provider?: { + readonly domain?: string; + readonly name?: string; + readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video'; + [k: string]: unknown; + }; + readonly graphql?: { + readonly operationType: 'query' | 'mutation' | 'subscription'; + readonly operationName?: string; + payload?: string; + variables?: string; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly span_id?: string; + readonly trace_id?: string; + readonly rule_psr?: number; + readonly discarded?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumviewevent.md b/docs/browser-rum.rumviewevent.md index c987fd0d9e..2314a4297c 100644 --- a/docs/browser-rum.rumviewevent.md +++ b/docs/browser-rum.rumviewevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumViewEvent type" +nav_order: 10 +permalink: /browser-rum.rumviewevent.html +--- + -Home > @datadog/browser-rum > RumViewEvent +Home > @datadog/browser-rum > RumViewEvent ## RumViewEvent type @@ -10,134 +17,134 @@ Schema of all properties of a View event ```typescript export type RumViewEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'view'; - readonly view: { - readonly loading_time?: number; - readonly network_settled_time?: number; - readonly interaction_to_next_view_time?: number; - readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; - readonly time_spent: number; - readonly first_contentful_paint?: number; - readonly largest_contentful_paint?: number; - readonly largest_contentful_paint_target_selector?: string; - readonly first_input_delay?: number; - readonly first_input_time?: number; - readonly first_input_target_selector?: string; - readonly interaction_to_next_paint?: number; - readonly interaction_to_next_paint_time?: number; - readonly interaction_to_next_paint_target_selector?: string; - readonly cumulative_layout_shift?: number; - readonly cumulative_layout_shift_time?: number; - readonly cumulative_layout_shift_target_selector?: string; - readonly dom_complete?: number; - readonly dom_content_loaded?: number; - readonly dom_interactive?: number; - readonly load_event?: number; - readonly first_byte?: number; - readonly custom_timings?: { - [k: string]: number; - }; - readonly is_active?: boolean; - readonly is_slow_rendered?: boolean; - readonly action: { - readonly count: number; - [k: string]: unknown; - }; - readonly error: { - readonly count: number; - [k: string]: unknown; - }; - readonly crash?: { - readonly count: number; - [k: string]: unknown; - }; - readonly long_task?: { - readonly count: number; - [k: string]: unknown; - }; - readonly frozen_frame?: { - readonly count: number; - [k: string]: unknown; - }; - readonly slow_frames?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly resource: { - readonly count: number; - [k: string]: unknown; - }; - readonly frustration?: { - readonly count: number; - [k: string]: unknown; - }; - readonly in_foreground_periods?: { - readonly start: number; - readonly duration: number; - [k: string]: unknown; - }[]; - readonly memory_average?: number; - readonly memory_max?: number; - readonly cpu_ticks_count?: number; - readonly cpu_ticks_per_second?: number; - readonly refresh_rate_average?: number; - readonly refresh_rate_min?: number; - readonly slow_frames_rate?: number; - readonly freeze_rate?: number; - flutter_build_time?: RumPerfMetric; - flutter_raster_time?: RumPerfMetric; - js_refresh_rate?: RumPerfMetric; - performance?: ViewPerformanceData; - [k: string]: unknown; - }; - readonly session?: { - readonly is_active?: boolean; - readonly sampled_for_replay?: boolean; - [k: string]: unknown; - }; - readonly feature_flags?: { - [k: string]: unknown; - }; - readonly privacy?: { - readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; - [k: string]: unknown; - }; - readonly _dd: { - readonly document_version: number; - readonly page_states?: { - readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; - readonly start: number; - [k: string]: unknown; - }[]; - replay_stats?: { - records_count?: number; - segments_count?: number; - segments_total_raw_size?: number; - [k: string]: unknown; - }; - readonly cls?: { - readonly device_pixel_ratio?: number; - [k: string]: unknown; - }; - readonly configuration?: { - readonly start_session_replay_recording_manually?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - readonly display?: { - readonly scroll?: { - readonly max_depth: number; - readonly max_depth_scroll_top: number; - readonly max_scroll_height: number; - readonly max_scroll_height_time: number; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'view'; + readonly view: { + readonly loading_time?: number; + readonly network_settled_time?: number; + readonly interaction_to_next_view_time?: number; + readonly loading_type?: 'initial_load' | 'route_change' | 'activity_display' | 'activity_redisplay' | 'fragment_display' | 'fragment_redisplay' | 'view_controller_display' | 'view_controller_redisplay'; + readonly time_spent: number; + readonly first_contentful_paint?: number; + readonly largest_contentful_paint?: number; + readonly largest_contentful_paint_target_selector?: string; + readonly first_input_delay?: number; + readonly first_input_time?: number; + readonly first_input_target_selector?: string; + readonly interaction_to_next_paint?: number; + readonly interaction_to_next_paint_time?: number; + readonly interaction_to_next_paint_target_selector?: string; + readonly cumulative_layout_shift?: number; + readonly cumulative_layout_shift_time?: number; + readonly cumulative_layout_shift_target_selector?: string; + readonly dom_complete?: number; + readonly dom_content_loaded?: number; + readonly dom_interactive?: number; + readonly load_event?: number; + readonly first_byte?: number; + readonly custom_timings?: { + [k: string]: number; + }; + readonly is_active?: boolean; + readonly is_slow_rendered?: boolean; + readonly action: { + readonly count: number; + [k: string]: unknown; + }; + readonly error: { + readonly count: number; + [k: string]: unknown; + }; + readonly crash?: { + readonly count: number; + [k: string]: unknown; + }; + readonly long_task?: { + readonly count: number; + [k: string]: unknown; + }; + readonly frozen_frame?: { + readonly count: number; + [k: string]: unknown; + }; + readonly slow_frames?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly resource: { + readonly count: number; + [k: string]: unknown; + }; + readonly frustration?: { + readonly count: number; + [k: string]: unknown; + }; + readonly in_foreground_periods?: { + readonly start: number; + readonly duration: number; + [k: string]: unknown; + }[]; + readonly memory_average?: number; + readonly memory_max?: number; + readonly cpu_ticks_count?: number; + readonly cpu_ticks_per_second?: number; + readonly refresh_rate_average?: number; + readonly refresh_rate_min?: number; + readonly slow_frames_rate?: number; + readonly freeze_rate?: number; + flutter_build_time?: RumPerfMetric; + flutter_raster_time?: RumPerfMetric; + js_refresh_rate?: RumPerfMetric; + performance?: ViewPerformanceData; + [k: string]: unknown; + }; + readonly session?: { + readonly is_active?: boolean; + readonly sampled_for_replay?: boolean; + [k: string]: unknown; + }; + readonly feature_flags?: { + [k: string]: unknown; + }; + readonly privacy?: { + readonly replay_level: 'allow' | 'mask' | 'mask-user-input'; + [k: string]: unknown; + }; + readonly _dd: { + readonly document_version: number; + readonly page_states?: { + readonly state: 'active' | 'passive' | 'hidden' | 'frozen' | 'terminated'; + readonly start: number; + [k: string]: unknown; + }[]; + replay_stats?: { + records_count?: number; + segments_count?: number; + segments_total_raw_size?: number; + [k: string]: unknown; + }; + readonly cls?: { + readonly device_pixel_ratio?: number; + [k: string]: unknown; + }; + readonly configuration?: { + readonly start_session_replay_recording_manually?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + readonly display?: { + readonly scroll?: { + readonly max_depth: number; + readonly max_depth_scroll_top: number; + readonly max_scroll_height: number; + readonly max_scroll_height_time: number; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumvieweventdomaincontext.location.md b/docs/browser-rum.rumvieweventdomaincontext.location.md index 7a799fcd87..18377875d5 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.location.md +++ b/docs/browser-rum.rumvieweventdomaincontext.location.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumViewEventDomainContext.location property" +nav_order: 9 +permalink: /browser-rum.rumvieweventdomaincontext.location.html +--- + -Home > @datadog/browser-rum > RumViewEventDomainContext > location +Home > @datadog/browser-rum > RumViewEventDomainContext > location ## RumViewEventDomainContext.location property diff --git a/docs/browser-rum.rumvieweventdomaincontext.md b/docs/browser-rum.rumvieweventdomaincontext.md index 0701dabef9..5c0eaaf3f3 100644 --- a/docs/browser-rum.rumvieweventdomaincontext.md +++ b/docs/browser-rum.rumvieweventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumViewEventDomainContext interface" +nav_order: 8 +permalink: /browser-rum.rumvieweventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumViewEventDomainContext +Home > @datadog/browser-rum > RumViewEventDomainContext ## RumViewEventDomainContext interface @@ -37,7 +44,7 @@ Description
-location +location @@ -45,7 +52,7 @@ Description -Readonly +Readonly<Location> diff --git a/docs/browser-rum.rumvitalevent.md b/docs/browser-rum.rumvitalevent.md index af5e5ead83..ed9208296b 100644 --- a/docs/browser-rum.rumvitalevent.md +++ b/docs/browser-rum.rumvitalevent.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumVitalEvent type" +nav_order: 7 +permalink: /browser-rum.rumvitalevent.html +--- + -Home > @datadog/browser-rum > RumVitalEvent +Home > @datadog/browser-rum > RumVitalEvent ## RumVitalEvent type @@ -10,27 +17,27 @@ Schema of all properties of a Vital event ```typescript export type RumVitalEvent = CommonProperties & ViewContainerSchema & { - readonly type: 'vital'; - readonly vital: { - readonly type: 'duration'; - readonly id: string; - readonly name?: string; - readonly description?: string; - readonly duration?: number; - readonly custom?: { - [k: string]: number; - }; - [k: string]: unknown; - }; - readonly _dd?: { - readonly vital?: { - readonly computed_value?: boolean; - [k: string]: unknown; - }; - [k: string]: unknown; - }; - [k: string]: unknown; + readonly type: 'vital'; + readonly vital: { + readonly type: 'duration'; + readonly id: string; + readonly name?: string; + readonly description?: string; + readonly duration?: number; + readonly custom?: { + [k: string]: number; + }; + [k: string]: unknown; + }; + readonly _dd?: { + readonly vital?: { + readonly computed_value?: boolean; + [k: string]: unknown; + }; + [k: string]: unknown; + }; + [k: string]: unknown; }; ``` -**References:** CommonProperties +**References:** CommonProperties diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md index 281d2dfa70..5035524025 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.handlingstack.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumXhrResourceEventDomainContext.handlingStack property" +nav_order: 6 +permalink: /browser-rum.rumxhrresourceeventdomaincontext.handlingstack.html +--- + -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > handlingStack ## RumXhrResourceEventDomainContext.handlingStack property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md index 530e163f13..f03d879a9d 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.isaborted.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumXhrResourceEventDomainContext.isAborted property" +nav_order: 5 +permalink: /browser-rum.rumxhrresourceeventdomaincontext.isaborted.html +--- + -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > isAborted ## RumXhrResourceEventDomainContext.isAborted property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.md index 03760fc503..ca4cfeb6ac 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumXhrResourceEventDomainContext interface" +nav_order: 4 +permalink: /browser-rum.rumxhrresourceeventdomaincontext.html +--- + -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext ## RumXhrResourceEventDomainContext interface @@ -37,7 +44,7 @@ Description
-handlingStack? +handlingStack? @@ -56,7 +63,7 @@ string
-isAborted +isAborted @@ -75,7 +82,7 @@ Whether the XHR request was aborted.
-performanceEntry? +performanceEntry? @@ -94,7 +101,7 @@ PerformanceEntry
-xhr +xhr diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md index ad493c8d8c..71a6e0be9a 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.performanceentry.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumXhrResourceEventDomainContext.performanceEntry property" +nav_order: 3 +permalink: /browser-rum.rumxhrresourceeventdomaincontext.performanceentry.html +--- + -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > performanceEntry ## RumXhrResourceEventDomainContext.performanceEntry property diff --git a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md index 924188c86b..90d8c675e3 100644 --- a/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md +++ b/docs/browser-rum.rumxhrresourceeventdomaincontext.xhr.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "RumXhrResourceEventDomainContext.xhr property" +nav_order: 2 +permalink: /browser-rum.rumxhrresourceeventdomaincontext.xhr.html +--- + -Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr +Home > @datadog/browser-rum > RumXhrResourceEventDomainContext > xhr ## RumXhrResourceEventDomainContext.xhr property diff --git a/docs/index.md b/docs/index.md index 752a2b7655..f7dcc35fa9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,13 @@ +--- +layout: default +title: "API Reference" +nav_order: 1 +permalink: /index.html +--- + -Home +Home ## API Reference @@ -19,7 +26,7 @@ Description
-@datadog/browser-logs +@datadog/browser-logs @@ -30,7 +37,7 @@ Datadog Browser Logs SDK for collecting and forwarding browser logs to Datadog.
-@datadog/browser-rum +@datadog/browser-rum @@ -41,7 +48,7 @@ Datadog Browser RUM SDK - Full version with Session Replay and Real User Profili
-@datadog/browser-rum-react +@datadog/browser-rum-react @@ -52,7 +59,7 @@ Datadog Browser RUM React Integration - Additional components and hooks for Reac
-@datadog/browser-rum-slim +@datadog/browser-rum-slim diff --git a/etc/browser-logs.api.json b/etc/browser-logs.api.json index 300e8c9a2e..cf3fcf7218 100644 --- a/etc/browser-logs.api.json +++ b/etc/browser-logs.api.json @@ -243,7 +243,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-logs!HandlerType:var", - "docComment": "", + "docComment": "/**\n * Defines the types of handlers for processing logs: console, HTTP, or silent.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1037,7 +1037,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!Logger:interface", - "docComment": "/**\n * Set of convenience methods for each supported log level.\n *\n * All methods accept the same parameters: `message`: human-readable log text. `messageContext`: optional JSON-serialisable object merged with the log context. `error`: optional `Error` instance captured with the log.\n *\n * @public\n */\n", + "docComment": "/**\n * Provides convenience methods for logging at each supported level. Each method accepts a message, optional context, and an optional error.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1757,7 +1757,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!LoggerConfiguration:interface", - "docComment": "", + "docComment": "/**\n * Configuration options for a logger. Includes the log level to determine the severity of logs, the handler(s) responsible for processing log messages, and an optional context object to provide additional metadata for logs.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1871,7 +1871,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!LogsEvent:interface", - "docComment": "", + "docComment": "/**\n * Represents a log event collected by the Datadog Browser Logs SDK, containing information such as message, context, and metadata.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2376,7 +2376,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!LogsGlobal:interface", - "docComment": "", + "docComment": "/**\n * The public API for the Datadog Browser Logs SDK. Provides methods to initialize the SDK, manage global/user/account contexts, and interact with loggers for collecting and forwarding logs.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3155,7 +3155,7 @@ { "kind": "Interface", "canonicalReference": "@datadog/browser-logs!LogsInitConfiguration:interface", - "docComment": "", + "docComment": "/**\n * Configuration options for initializing the Datadog Browser Logs SDK. Extends the base InitConfiguration and includes additional options specific to log collection, such as error forwarding, console log forwarding, and the ability to modify or discard logs before they are sent.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3495,7 +3495,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-logs!StatusType:var", - "docComment": "", + "docComment": "/**\n * Defines the severity levels for log messages, ranging from debug to emergency.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/etc/browser-rum-react.api.json b/etc/browser-rum-react.api.json index 1a5ac137a3..7d02738fa9 100644 --- a/etc/browser-rum-react.api.json +++ b/etc/browser-rum-react.api.json @@ -175,7 +175,7 @@ { "kind": "Function", "canonicalReference": "@datadog/browser-rum-react!addReactError:function(1)", - "docComment": "/**\n * Report an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM. This helper should not be called directly; prefer to use the {@link ErrorBoundary} component or React's error lifecycle.\n *\n * @param error - The JavaScript `Error` instance thrown by React.\n *\n * @param info - Additional React error information, including the component stack.\n */\n", + "docComment": "/**\n * Reports an error originating from React (Error Boundary or `componentDidCatch`) to Datadog RUM with relevant context and stack information.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -238,7 +238,7 @@ { "kind": "Class", "canonicalReference": "@datadog/browser-rum-react!ErrorBoundary:class", - "docComment": "/**\n * Error Boundary component used to capture runtime errors in the React tree below and report them to Datadog RUM. It renders the `fallback` component when an error is caught.\n *\n * @extends React.Component\n */\n", + "docComment": "/**\n * A React Error Boundary that captures runtime errors in its child components and reports them to Datadog RUM, rendering the `fallback` component when an error occurs.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -503,7 +503,7 @@ { "kind": "Function", "canonicalReference": "@datadog/browser-rum-react!reactPlugin:function(1)", - "docComment": "/**\n * Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }).\n *\n * The plugin wires React-specific features such as: - ErrorBoundary integration (errors forwarded as RUM *Error* events) - Optional react-router view tracking - Component performance tracking utilities (see {@link UNSTABLE_ReactComponentTracker}).\n *\n * @param configuration - React plugin specific configuration.\n *\n * @returns A RUM plugin instance to include in the SDK init.\n *\n * @public\n */\n", + "docComment": "/**\n * Factory function that creates the React plugin for Datadog RUM, enabling features like ErrorBoundary integration, optional react-router view tracking, and component performance tracking utilities.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -576,7 +576,7 @@ { "kind": "Variable", "canonicalReference": "@datadog/browser-rum-react!UNSTABLE_ReactComponentTracker:var", - "docComment": "/**\n * Experimental component that measures the render lifecycle of its children and reports a duration vital named `reactComponentRender`.\n *\n * @experimental\n */\n", + "docComment": "/**\n * Experimental component that tracks the render lifecycle of its children and reports a duration vital named `reactComponentRender`.\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/package.json b/package.json index 958c269aa3..bb90619407 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,11 @@ "size": "node scripts/show-bundle-size.js", "woke": "scripts/cli woke", "build:types": "lerna run build:esm --stream", - "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs && node scripts/fix-api-docs-final.js" + "docs:api": "yarn build:types && api-extractor run --local -c packages/rum/api-extractor.json && api-extractor run --local -c packages/logs/api-extractor.json && api-extractor run --local -c packages/rum-slim/api-extractor.json && api-extractor run --local -c packages/rum-react/api-extractor.json && api-documenter markdown -i etc -o docs && node scripts/docs-jekyll.js", + "docs:api:clean": "CLEANUP_MD=true yarn docs:api", + "docs:release": "yarn docs:api && echo 'Documentation ready for release'", + "docs:serve": "bundle exec jekyll serve --source docs --destination _site --config _config_docs.yml", + "docs:build": "bundle exec jekyll build --source docs --destination _site --config _config_docs.yml" }, "devDependencies": { "@eslint/js": "9.26.0", diff --git a/packages/logs/src/boot/logsPublicApi.ts b/packages/logs/src/boot/logsPublicApi.ts index 4964a460b2..4f7cc17c0b 100644 --- a/packages/logs/src/boot/logsPublicApi.ts +++ b/packages/logs/src/boot/logsPublicApi.ts @@ -20,13 +20,22 @@ import type { InternalContext } from '../domain/contexts/internalContext' import type { StartLogs, StartLogsResult } from './startLogs' import { createPreStartStrategy } from './preStartLogs' -// +/** + * Configuration options for a logger. + * Includes the log level to determine the severity of logs, + * the handler(s) responsible for processing log messages, + * and an optional context object to provide additional metadata for logs. + */ export interface LoggerConfiguration { level?: StatusType handler?: HandlerType | HandlerType[] context?: object } - +/** + * The public API for the Datadog Browser Logs SDK. + * Provides methods to initialize the SDK, manage global/user/account contexts, + * and interact with loggers for collecting and forwarding logs. + */ export interface LogsPublicApi extends PublicApi { logger: Logger diff --git a/packages/logs/src/domain/configuration.ts b/packages/logs/src/domain/configuration.ts index 8c9ff1bae0..1495d4580b 100644 --- a/packages/logs/src/domain/configuration.ts +++ b/packages/logs/src/domain/configuration.ts @@ -12,6 +12,12 @@ import { import type { LogsEvent } from '../logsEvent.types' import type { LogsEventDomainContext } from '../domainContext.types' +/** + * Configuration options for initializing the Datadog Browser Logs SDK. + * Extends the base InitConfiguration and includes additional options + * specific to log collection, such as error forwarding, console log forwarding, + * and the ability to modify or discard logs before they are sent. + */ export interface LogsInitConfiguration extends InitConfiguration { /** * Access to every logs collected by the Logs SDK before they are sent to Datadog. diff --git a/packages/logs/src/domain/logger.ts b/packages/logs/src/domain/logger.ts index d7e45f04db..730c5b1a0c 100644 --- a/packages/logs/src/domain/logger.ts +++ b/packages/logs/src/domain/logger.ts @@ -29,6 +29,9 @@ export interface LogsMessage { context?: Context } +/** + * Defines the types of handlers for processing logs: console, HTTP, or silent. + */ export const HandlerType = { console: 'console', http: 'http', @@ -158,14 +161,8 @@ Logger.prototype.emerg = createLoggerMethod(StatusType.emerg) /* eslint-enable local-rules/disallow-side-effects */ /** - * Set of convenience methods for each supported log level. - * - * All methods accept the same parameters: - * `message`: human-readable log text. - * `messageContext`: optional JSON-serialisable object merged with the log context. - * `error`: optional `Error` instance captured with the log. - * - * @public + * Provides convenience methods for logging at each supported level. + * Each method accepts a message, optional context, and an optional error. */ // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging export interface Logger { diff --git a/packages/logs/src/domain/logger/isAuthorized.ts b/packages/logs/src/domain/logger/isAuthorized.ts index 50886848e5..5ed2100ffb 100644 --- a/packages/logs/src/domain/logger/isAuthorized.ts +++ b/packages/logs/src/domain/logger/isAuthorized.ts @@ -6,6 +6,9 @@ export function isAuthorized(status: StatusType, handlerType: HandlerType, logge return STATUS_PRIORITIES[status] >= STATUS_PRIORITIES[logger.getLevel()] && sanitizedHandlerType.includes(handlerType) } +/** + * Defines the severity levels for log messages, ranging from debug to emergency. + */ export const StatusType = { ok: 'ok', debug: 'debug', diff --git a/packages/logs/src/logsEvent.types.ts b/packages/logs/src/logsEvent.types.ts index f537feef0a..bfa2babd83 100644 --- a/packages/logs/src/logsEvent.types.ts +++ b/packages/logs/src/logsEvent.types.ts @@ -1,3 +1,7 @@ +/** + * Represents a log event collected by the Datadog Browser Logs SDK, + * containing information such as message, context, and metadata. + */ export interface LogsEvent { /** * Start of the log in ms from epoch diff --git a/packages/rum-react/src/domain/error/addReactError.ts b/packages/rum-react/src/domain/error/addReactError.ts index 17d395baf5..fa5e9402a8 100644 --- a/packages/rum-react/src/domain/error/addReactError.ts +++ b/packages/rum-react/src/domain/error/addReactError.ts @@ -3,12 +3,8 @@ import { callMonitored, clocksNow, createHandlingStack } from '@datadog/browser- import { onRumStart } from '../reactPlugin' /** - * Report an error originating from React (Error Boundary or `componentDidCatch`) - * to Datadog RUM. This helper should not be called directly; prefer to use the - * {@link ErrorBoundary} component or React's error lifecycle. - * - * @param error The JavaScript `Error` instance thrown by React. - * @param info Additional React error information, including the component stack. + * Reports an error originating from React (Error Boundary or `componentDidCatch`) + * to Datadog RUM with relevant context and stack information. */ export function addReactError(error: Error, info: ErrorInfo) { const handlingStack = createHandlingStack('react error') diff --git a/packages/rum-react/src/domain/error/errorBoundary.ts b/packages/rum-react/src/domain/error/errorBoundary.ts index 9aa591d695..58360b50d1 100644 --- a/packages/rum-react/src/domain/error/errorBoundary.ts +++ b/packages/rum-react/src/domain/error/errorBoundary.ts @@ -35,11 +35,8 @@ type State = const INITIAL_STATE: State = { didCatch: false, error: null } /** - * Error Boundary component used to capture runtime errors in the React tree - * below and report them to Datadog RUM. It renders the `fallback` component - * when an error is caught. - * - * @extends React.Component + * A React Error Boundary that captures runtime errors in its child components + * and reports them to Datadog RUM, rendering the `fallback` component when an error occurs. */ // eslint-disable-next-line no-restricted-syntax export class ErrorBoundary extends React.Component { diff --git a/packages/rum-react/src/domain/performance/reactComponentTracker.tsx b/packages/rum-react/src/domain/performance/reactComponentTracker.tsx index 1fa4496eb0..2ce7a363e1 100644 --- a/packages/rum-react/src/domain/performance/reactComponentTracker.tsx +++ b/packages/rum-react/src/domain/performance/reactComponentTracker.tsx @@ -3,10 +3,8 @@ import { createTimer } from './timer' import { addDurationVital } from './addDurationVital' /** - * Experimental component that measures the render lifecycle of its children + * Experimental component that tracks the render lifecycle of its children * and reports a duration vital named `reactComponentRender`. - * - * @experimental */ // eslint-disable-next-line export const UNSTABLE_ReactComponentTracker = ({ diff --git a/packages/rum-react/src/domain/reactPlugin.ts b/packages/rum-react/src/domain/reactPlugin.ts index b1b075478c..c49de36cda 100644 --- a/packages/rum-react/src/domain/reactPlugin.ts +++ b/packages/rum-react/src/domain/reactPlugin.ts @@ -24,17 +24,9 @@ export interface ReactPluginConfiguration { } /** - * Factory returning the react plugin to pass to datadogRum.init({ plugins: [...] }). - * - * The plugin wires React-specific features such as: - * - ErrorBoundary integration (errors forwarded as RUM *Error* events) - * - Optional react-router view tracking - * - Component performance tracking utilities (see {@link UNSTABLE_ReactComponentTracker}). - * - * - * @param configuration React plugin specific configuration. - * @returns A RUM plugin instance to include in the SDK init. - * @public + * Factory function that creates the React plugin for Datadog RUM, + * enabling features like ErrorBoundary integration, optional react-router view tracking, + * and component performance tracking utilities. */ export function reactPlugin(configuration: ReactPluginConfiguration = {}) { return { diff --git a/scripts/docs-jekyll.js b/scripts/docs-jekyll.js new file mode 100644 index 0000000000..fb7cfc90c3 --- /dev/null +++ b/scripts/docs-jekyll.js @@ -0,0 +1,66 @@ +const fs = require('fs') +const path = require('path') +const { globSync } = require('glob') + +const DOCS_DIR = path.join(__dirname, '..', 'docs') +let navOrder = 1 + +function titleFromContent(content, fallback) { + const m = content.match(/^#{1,2}\s+(.+)$/m) + return m ? m[1].replace(/[<>]/g, '') : fallback +} + +function addJekyllFrontMatter(content, filename) { + const title = titleFromContent(content, path.basename(filename, '.md')) + return ( + `---\n` + + `layout: default\n` + + `title: "${title}"\n` + + `nav_order: ${navOrder++}\n` + + `permalink: /${filename.replace('.md', '.html')}\n` + + `---\n\n` + + content + ) +} + +function cleanMarkdownForJekyll(md) { + return md + .replace(/_\(Optional\)_/g, '(Optional)') + .replace(/\[([^\]]+)]\(\s*(https?:\/\/[^\s)]+?)\s*\)/g, (_, label, rawUrl) => { + const url = rawUrl.replace(/\\([)#])/g, '$1') + return `${label}` + }) + .replace( + /\[([^\]]+)]\(\s*(?:\{\{\s*["']?\/([^"')]+\.html)["']?\s*\|\s*relative_url\s*}}|\/([^)]+\.html)|\.\/([^)]+?)(?:\.md|\.html))\s*\)/g, + (_, txt, f1, f2, f3) => { + const file = (f1 || f2 || f3).replace(/\.md$/, '.html') + return `${txt}` + } + ) + .replace(/\\([_*`\\])/g, '$1') + .replace(/\\\|/g, '|') +} + +function processDocFile(file) { + let content = fs.readFileSync(file, 'utf8') + content = cleanMarkdownForJekyll(content) + content = addJekyllFrontMatter(content, path.basename(file)) + fs.writeFileSync(file, content, 'utf8') +} + +function cleanupMarkdownFiles() { + globSync(`${DOCS_DIR}/*.md`) + .filter((f) => !f.endsWith('index.md')) + .forEach((f) => { + fs.unlinkSync(f) + }) +} + +function main() { + const files = globSync(`${DOCS_DIR}/*.md`) + files.forEach(processDocFile) + if (process.env.CLEANUP_MD === 'true') cleanupMarkdownFiles() +} + +if (require.main === module) main() +module.exports = { addJekyllFrontMatter, cleanMarkdownForJekyll } diff --git a/scripts/fix-api-docs-final.js b/scripts/fix-api-docs-final.js deleted file mode 100644 index 02408dc461..0000000000 --- a/scripts/fix-api-docs-final.js +++ /dev/null @@ -1,112 +0,0 @@ -const fs = require('fs') -const path = require('path') -const { globSync } = require('glob') - -function fixTypeBackslashes(content) { - return content.replace(/\\\|/g, '|') -} - -function fixArrayTypes(content) { - return content.replace(/(\w+)\\\[\\]/g, '$1[]') -} - -function fixOptionalFormatting(content) { - return content.replace(/_\(Optional\)_/g, '(Optional)') -} - -function convertMarkdownLinks(content) { - return content.replace(/\[([^\]]+)]\(([^)]+)\)/g, (_match, text, url) => { - let newUrl = url - if (url.endsWith('.md')) { - newUrl = url.replace(/\.md$/, '.html') - } - return `${text}` - }) -} - -function fixHtmlEntities(content) { - content = content.replace(/>/g, '>') - content = content.replace(/</g, '<') - content = content.replace(/&/g, '&') - content = content.replace(/"/g, '"') - - content = content.replace(/=>/g, '=>') - - return content -} - -function removeEmptyHtmlComments(content) { - return content.replace(//g, '') -} - -function fixHtmlTables(content) { - return content -} - -function cleanupSpacing(content) { - content = content.replace(/ {2,}/g, ' ') - - content = content.replace(/\n{3,}/g, '\n\n') - - return content -} - -function fixEscapedTags(content) { - content = content.replace(/\\') - - return content -} - -function fixBackslashes(content) { - content = content.replace(/\\_/g, '_') - content = content.replace(/\\#/g, '#') - - content = content.replace(/\\\[/g, '[') - content = content.replace(/\\\]/g, ']') - - return content -} - -function dedupClosingTableTags(content) { - // Keep a single occurrence of closing tags to prevent malformed tables while - // avoiding duplicated tags sometimes produced by api-documenter. - content = content.replace(/(<\/tbody><\/table>\s*){2,}/g, '
\n') - content = content.replace(/(<\/td><\/tr>\s*){2,}/g, '