generate api-report

Signed-off-by: sriram ramakrishnan <sramakr@gmail.com>
This commit is contained in:
sriram ramakrishnan
2023-03-30 08:47:18 -04:00
parent 3744e67906
commit 11c8654353
2 changed files with 3 additions and 7 deletions
@@ -5,13 +5,9 @@
```ts
import { AnalyticsApi } from '@backstage/core-plugin-api';
import { AnalyticsEvent } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { Config } from '@backstage/config';
import { IdentityApi } from '@backstage/core-plugin-api';
// @public @deprecated (undocumented)
export const analyticsModuleGA4: BackstagePlugin<{}, {}, {}>;
// @public
export class GoogleAnalytics4 implements AnalyticsApi {
captureEvent(event: AnalyticsEvent): void;
@@ -95,8 +95,8 @@ export class GoogleAnalytics4 implements AnalyticsApi {
/**
* Instantiate a fully configured GA Analytics API implementation.
* @param config Config object from app config
* @param options options with identityApi and userIdTransform config
* @param config - Config object from app config
* @param options - options with identityApi and userIdTransform config
*/
static fromConfig(
config: Config,
@@ -148,7 +148,7 @@ export class GoogleAnalytics4 implements AnalyticsApi {
* Primary event capture implementation. Handles core navigate event as a
* pageview and the rest as custom events. All custom dimensions/metrics are
* applied as they should be (set on pageview, merged object on events).
* @param event AnalyticsEvent type captured
* @param event - AnalyticsEvent type captured
*/
captureEvent(event: AnalyticsEvent) {
const { context, action, subject, value, attributes } = event;