diff --git a/plugins/analytics-module-nr/api-report.md b/plugins/analytics-module-nr/api-report.md new file mode 100644 index 0000000000..56c3d166d0 --- /dev/null +++ b/plugins/analytics-module-nr/api-report.md @@ -0,0 +1,25 @@ +## API Report File for "backstage-plugin-analytics-module-nr" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { AnalyticsApi } from '@backstage/core-plugin-api'; +import { AnalyticsEvent } from '@backstage/core-plugin-api'; +import { Config } from '@backstage/config'; +import { IdentityApi } from '@backstage/core-plugin-api'; + +// @public +export class NewRelicBrowser implements AnalyticsApi { + // (undocumented) + captureEvent(event: AnalyticsEvent): void; + // (undocumented) + static fromConfig( + config: Config, + options: { + identityApi?: IdentityApi; + }, + ): NewRelicBrowser; +} + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/analytics-module-nr/src/apis/implementations/AnalyticsApi/NewRelicBrowser.ts b/plugins/analytics-module-nr/src/apis/implementations/AnalyticsApi/NewRelicBrowser.ts index 5270dce156..35be8cc8a0 100644 --- a/plugins/analytics-module-nr/src/apis/implementations/AnalyticsApi/NewRelicBrowser.ts +++ b/plugins/analytics-module-nr/src/apis/implementations/AnalyticsApi/NewRelicBrowser.ts @@ -24,7 +24,7 @@ import type { setAPI } from '@newrelic/browser-agent/loaders/api/api'; type NewRelicAPI = ReturnType; -export type NewRelicBrowserOptions = { +type NewRelicBrowserOptions = { accountId: string; applicationId: string; licenseKey: string; @@ -33,7 +33,10 @@ export type NewRelicBrowserOptions = { useEuEndpoint: boolean; }; -// Implementation that optionally initializes with a userId. +/** + * New Relic Browser API provider for the Backstage Analytics API. + * @public + */ export class NewRelicBrowser implements AnalyticsApi { private readonly agent: NewRelicAPI;