开始使用

安装

bun add @capgo/capacitor-firebase-performance
bunx cap sync

导入

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

API 概述

startTrace

开始追踪

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.startTrace({} as StartTraceOptions);

stopTrace

停止跟踪。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.stopTrace({} as StopTraceOptions);

incrementMetric

原子性地将给定名称的指标在选定的跟踪中增加指定的值。 incrementBy 复制到剪贴板

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.incrementMetric({} as IncrementMetricOptions);

setEnabled

复制到剪贴板

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.setEnabled({} as SetEnabledOptions);

isEnabled

确定是否启用或禁用性能监控。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.isEnabled();

putAttribute

设置一个跟踪的自定义属性到一个给定的值。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.putAttribute({} as PutAttributeOptions);

getAttribute

返回一个跟踪的自定义属性的值。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getAttribute({} as GetAttributeOptions);

getAttributes

获取一个跟踪的所有自定义属性及其值。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getAttributes({} as GetAttributesOptions);

removeAttribute

移除一个trace的自定义属性

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.removeAttribute({} as RemoveAttributeOptions);

putMetric

设置自定义指标的值

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.putMetric({} as PutMetricOptions);

getMetric

通过名称获取自定义指标的值

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.getMetric({} as GetMetricOptions);

record

记录一个trace

仅在web上可用

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.record({} as RecordOptions);

类型参考

StartTraceOptions

export interface StartTraceOptions {
  /**
   * Custom trace name.
   *
   * Names for custom code traces must meet the following requirements:
   * no leading or trailing whitespace, no leading underscore (_) character,
   * and max length is 100 characters.
   *
   * @since 0.1.0
   */
  traceName: string;
}

StopTraceOptions

export interface StopTraceOptions {
  /**
   * Name of the trace that was set with `startTrace`.
   *
   * @since 0.1.0
   */
  traceName: string;
}

IncrementMetricOptions

export interface IncrementMetricOptions {
  /**
   * Name of the trace that was set with `startTrace`.
   *
   * @since 0.1.0
   */
  traceName: string;
  /**
   * Name of the metric to be incremented.
   *
   * @since 0.1.0
   */
  metricName: string;
  /**
   * Amount by which the metric has to be incremented.
   *
   * @default 1
   * @since 0.1.0
   */
  incrementBy?: number;
}

SetEnabledOptions

export interface SetEnabledOptions {
  /**
   * Should performance monitoring be enabled.
   *
   * @since 0.1.0
   */
  enabled: boolean;
}

IsEnabledResult

export interface IsEnabledResult {
  /**
   * `true` if performance monitoring is enabled, otherwise `false`.
   *
   * @since 0.1.0
   */
  enabled: boolean;
}

PutAttributeOptions

export interface PutAttributeOptions {
  /**
   * Name of the trace to set its attribute.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * Name of the attribute to set its value.
   *
   * @since 6.3.0
   * @example "experiment"
   */
  attribute: string;
  /**
   * The value to set to the attribute.
   *
   * @since 6.3.0
   * @example "A"
   */
  value: string;
}

GetAttributeOptions

export interface GetAttributeOptions {
  /**
   * Name of the trace to set its attribute.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * Name of the attribute to retrieve its value.
   *
   * @since 6.3.0
   */
  attribute: string;
}

GetAttributeResult

export interface GetAttributeResult {
  /**
   * The value of the custom attribute.
   *
   * @since 6.3.0
   */
  value: string | null;
}

GetAttributesOptions

export interface GetAttributesOptions {
  /**
   * Name of the trace to get its attributes.
   *
   * @since 6.3.0
   */
  traceName: string;
}

GetAttributesResult

export interface GetAttributesResult {
  /**
   * A map of all custom attributes of a trace with their values.
   *
   * @since 6.3.0
   */
  attributes: { [key: string]: string };
}

RemoveAttributeOptions

export type RemoveAttributeOptions = GetAttributeOptions;

PutMetricOptions

export interface PutMetricOptions {
  /**
   * Name of the trace to set its metric.
   *
   * @since 6.3.0
   */
  traceName: string;
  /**
   * The metric name.
   *
   * @since 6.3.0
   */
  metricName: string;
  /**
   * The value to set for the metric.
   * The given value is floored down to the nearest integer.
   *
   * @since 6.3.0
   */
  num: number;
}

真实数据来源

本页面是由插件生成的 src/definitions.ts. 当公共 API 上游更改时，请重新运行同步。