@atlaskit/editor-common
Version:
A package that contains common classes and components for editor and renderer
51 lines (50 loc) • 1.76 kB
TypeScript
/**
* Built-in failure reasons for experience checks
*
* These are used by the various ExperienceCheck implementations to
* provide consistent, well-known failure reasons for analytics and debugging.
*/
export declare const EXPERIENCE_FAILURE_REASON: {
/**
* Experience timed out before completion
*/
readonly TIMEOUT: "timeout";
/**
* Target element could not be found when starting DOM mutation observation
*/
readonly DOM_MUTATION_TARGET_NOT_FOUND: "domMutationTargetNotFound";
/**
* Error occurred during DOM mutation check execution
*/
readonly DOM_MUTATION_CHECK_ERROR: "domMutationCheckError";
};
/**
* Built-in abort reasons for experiences.
*
* These may be used by various ExperienceCheck implementations to
* provide consistent, well-known abort reasons for analytics and debugging.
*/
export declare const EXPERIENCE_ABORT_REASON: {
/**
* Experience was aborted because it was restarted while already in progress
*/
readonly RESTARTED: "restarted";
};
/**
* Default sample rate for experienceSampled events.
* Set to 1 in 1000 (0.001) to balance data collection with event volume.
*
* Newly defined experiences should use this default unless they have data
* to justify a different rate.
*
* The expectation is that measurements will be gathered after initial
* instrumentation, then the sample rate can be tuned up to a safe threshold.
*/
export declare const DEFAULT_EXPERIENCE_SAMPLE_RATE = 0.001;
export declare const EXPERIENCE_ID: {
readonly ASYNC_OPERATION: "asyncOperation";
readonly MENU_ACTION: "menuAction";
readonly MENU_OPEN: "menuOpen";
readonly TOOLBAR_ACTION: "toolbarAction";
readonly TOOLBAR_OPEN: "toolbarOpen";
};