Interface LangiumProfiler

interface LangiumProfiler {
    createTask(category: ProfilingCategory, taskId: string): ProfilingTask;
    getRecords(...categories: ProfilingCategory[]): Stream<ProfilingRecord>;
    isActive(category: ProfilingCategory): boolean;
    start(...categories: ProfilingCategory[]): void;
    stop(...categories: ProfilingCategory[]): void;
}

Implemented by

DefaultLangiumProfiler

Index

Methods

createTask getRecords isActive start stop

Methods

createTask

createTask(category: ProfilingCategory, taskId: string): ProfilingTask
Creates a new ProfilingTask for the given category.
Parameters
- category: ProfilingCategory
  The category to create the task for.
- taskId: string
  The identifier of the task.
Returns ProfilingTask
- Defined in packages/langium/src/workspace/profiler.ts:38

getRecords

getRecords(...categories: ProfilingCategory[]): Stream<ProfilingRecord>
Gets the ProfilingRecords for the given categories. If none are provided, all records are returned.
Parameters
- ...categories: ProfilingCategory[]
  The categories to get the records for.
Returns Stream<ProfilingRecord>
A stream of profiling records.
- Defined in packages/langium/src/workspace/profiler.ts:45

isActive

isActive(category: ProfilingCategory): boolean
Checks if the given category is active.
Parameters
- category: ProfilingCategory
  The category to check.
Returns boolean
true if the category is active, false otherwise.
- Defined in packages/langium/src/workspace/profiler.ts:19

start

start(...categories: ProfilingCategory[]): void
Starts the profiling for the given categories. If none are provided, all categories are started.
Parameters
- ...categories: ProfilingCategory[]
  The categories to start profiling for.
Returns void
- Defined in packages/langium/src/workspace/profiler.ts:25

stop

stop(...categories: ProfilingCategory[]): void
Stops the profiling for the given categories. If none are provided, all categories are stopped.
Parameters
- ...categories: ProfilingCategory[]
  The categories to stop profiling for.
Returns void
- Defined in packages/langium/src/workspace/profiler.ts:31