cobalt/js_profiler/profiler.idl

// Copyright 2023 The Cobalt Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// https://wicg.github.io/js-self-profiling/#the-profiler-interface

[
  Exposed=Window,
  Constructor(ProfilerInitOptions options),
  ConstructorCallWith=EnvironmentSettings,
  RaisesException = Constructor,
]
interface Profiler {
  readonly attribute DOMHighResTimeStamp sampleInterval;
  readonly attribute boolean stopped;

  // TODO(b/326337485): This function mocks but does not fully emulate the EventTarget interface. It can
  // take and call many callbacks as listeners. However, note that this class does not remove listeners
  // or dispatch events. Use with caution.
  [CallWith=EnvironmentSettings] void addEventListener(DOMString token, SampleBufferFullCallback listener);

  [CallWith=EnvironmentSettings] Promise<ProfilerTraceWrapper> stop();
};

callback SampleBufferFullCallback = void();