Skip to content

Commit 66523e3

Browse files
committed
refactor: docs
1 parent 8a8903f commit 66523e3

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

packages/utils/src/lib/profiler/constants.ts

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1+
/**
2+
* Environment variable name for enabling/disabling profiling globally.
3+
* When set to 'true', profiling is enabled. When set to 'false' or unset, profiling is disabled.
4+
*
5+
* @example
6+
* ```bash
7+
* CP_PROFILING=true npm run dev
8+
* ```
9+
*/
110
export const PROFILER_ENABLED_ENV_VAR = 'CP_PROFILING';
11+
12+
/**
13+
* Environment variable name for enabling debug mode for profiler state transitions.
14+
* When set to 'true', profiler state transitions create performance marks for debugging.
15+
*
16+
* @example
17+
* ```bash
18+
* CP_PROFILER_DEBUG=true npm run dev
19+
* ```
20+
*/
221
export const PROFILER_DEBUG_ENV_VAR = 'CP_PROFILER_DEBUG';
3-
export const PROFILER_COORDINATOR_FLAG_ENV_VAR = 'CP_PROFILER_COORDINATOR';
4-
export const PROFILER_ORIGIN_PID_ENV_VAR = 'CP_PROFILER_ORIGIN_PID';
5-
export const PROFILER_DIRECTORY_ENV_VAR = 'CP_PROFILER_DIR';
6-
export const PROFILER_BASE_NAME = 'trace';
7-
export const PROFILER_DIRECTORY = './tmp/profiles';

0 commit comments

Comments
 (0)