Interface UpdateSession

Session for recording a single update cycle

interface UpdateSession {
    begin(name: string): UpdateSession;
    end(): void;
    setMetadata(meta: Partial<TimingMetadata>): void;
    markSkipped(reason: string): void;
}

Index

Methods

begin end setMetadata markSkipped

Methods

begin

begin(name: string): UpdateSession
Begin a child timing entry
Parameters
- name: string
Returns UpdateSession
- Defined in src/profiling/update-profiler.ts:211

end

end(): void
End this timing entry

Returns void
- Defined in src/profiling/update-profiler.ts:213

setMetadata

setMetadata(meta: Partial<TimingMetadata>): void
Set metadata on this entry
Parameters
- meta: Partial<TimingMetadata>
Returns void
- Defined in src/profiling/update-profiler.ts:215

markSkipped

markSkipped(reason: string): void
Mark this entry as skipped
Parameters
- reason: string
Returns void
- Defined in src/profiling/update-profiler.ts:217