@sentry/browser
Version:
Official Sentry SDK for browsers
31 lines • 1.28 kB
TypeScript
import type { Integration, IntegrationFn } from '@sentry/core';
export interface FeatureFlagsIntegration extends Integration {
addFeatureFlag: (name: string, value: unknown) => void;
}
/**
* Sentry integration for buffering feature flags manually with an API, and
* capturing them on error events. We recommend you do this on each flag
* evaluation. Flags are buffered per Sentry scope and limited to 100 per event.
*
* See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
*
* @example
* ```
* import * as Sentry from '@sentry/browser';
* import { type FeatureFlagsIntegration } from '@sentry/browser';
*
* // Setup
* Sentry.init(..., integrations: [Sentry.featureFlagsIntegration()])
*
* // Verify
* const flagsIntegration = Sentry.getClient()?.getIntegrationByName<FeatureFlagsIntegration>('FeatureFlags');
* if (flagsIntegration) {
* flagsIntegration.addFeatureFlag('my-flag', true);
* } else {
* // check your setup
* }
* Sentry.captureException(Exception('broke')); // 'my-flag' should be captured to this Sentry event.
* ```
*/
export declare const featureFlagsIntegration: IntegrationFn<FeatureFlagsIntegration>;
//# sourceMappingURL=featureFlagsIntegration.d.ts.map