benchpress/ts/src/metric.ts

Benchpress - a framework for e2e performance tests

import {bind, provide, Provider} from 'angular2/src/core/di';
import {BaseException, WrappedException} from 'angular2/src/facade/exceptions';

/**
 * A metric is measures values
 */
export abstract class Metric {
  static bindTo(delegateToken): Provider[] {
    return [bind(Metric).toFactory((delegate) => delegate, [delegateToken])];
  }

  /**
   * Starts measuring
   */
  beginMeasure(): Promise<any> { throw new BaseException('NYI'); }

  /**
   * Ends measuring and reports the data
   * since the begin call.
   * @param restart: Whether to restart right after this.
   */
  endMeasure(restart: boolean): Promise<{[key: string]: any}> { throw new BaseException('NYI'); }

  /**
   * Describes the metrics provided by this metric implementation.
   * (e.g. units, ...)
   */
  describe(): {[key: string]: any} { throw new BaseException('NYI'); }
}