47 lines
650 B
TypeScript
47 lines
650 B
TypeScript
|
export interface TimeEndFunction {
|
||
|
|
/**
|
||
|
|
@returns Elapsed milliseconds.
|
||
|
|
*/
|
||
|
|
(): number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
@returns Elapsed milliseconds rounded.
|
||
|
|
*/
|
||
|
|
rounded(): number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
@returns Elapsed seconds.
|
||
|
|
*/
|
||
|
|
seconds(): number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
@returns Elapsed nanoseconds.
|
||
|
|
*/
|
||
|
|
nanoseconds(): bigint;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Simplified high resolution timing.
|
||
|
|
|
||
|
|
@returns A function that returns the time difference.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import timeSpan from 'time-span';
|
||
|
|
|
||
|
|
const end = timeSpan();
|
||
|
|
|
||
|
|
timeConsumingFn();
|
||
|
|
|
||
|
|
console.log(end());
|
||
|
|
//=> 1745.3186
|
||
|
|
|
||
|
|
console.log(end.rounded());
|
||
|
|
//=> 1745
|
||
|
|
|
||
|
|
console.log(end.seconds());
|
||
|
|
//=> 1.7453186
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
export default function timeSpan(): TimeEndFunction;
|