@villedemontreal/general-utils
Version:
General utilities library
35 lines • 984 B
TypeScript
/**
* A Timer object. Can be used to compute time elapsed
* from its creation to the moment one of its methods
* is called.
*
* For example :
*
* let timer = new Timer();
*
* // ... do something
*
* console.log(timer.getMillisecondsElapsed());
* console.log(timer.toString());
*/
export declare class Timer {
private start;
constructor();
/**
* The number of smilliseconds elapsed since the
* time was started.
*/
getMillisecondsElapsed(): number;
/**
* Computes the amount of time elapsed since the
* timer was started and returns a string to represents
* this duration.
*
* @param format the format to use for the resulting string. The
* default format is "HH:mm:ss.SSS". Have a look at the moment library
* documentation to see how to define a custom format :
* https://momentjs.com/docs/#/displaying/format/
*/
toString(format?: string): string;
}
//# sourceMappingURL=timer.d.ts.map