@egodigital/egoose/lib/diagnostics/stopwatch.d.ts

Helper classes and functions for Node.js 10 or later.

/**
 * This file is part of the @egodigital/egoose distribution.
 * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/)
 *
 * @egodigital/egoose is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * @egodigital/egoose is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
/**
 * A stopwatch.
 */
export declare class StopWatch {
    private _startTime;
    /**
     * Gets if the stop watch is running or not.
     */
    get isRunning(): boolean;
    /**
     * (Re-)Starts the stop watch.
     *
     * @return this
     */
    start(): this;
    /**
     * Stops the watch.
     *
     * @return {number} The number of milliseconds.
     */
    stop(): number;
}
/**
 * Creates and starts a new stop watch.
 *
 * @return {StopWatch} The new, started watch.
 */
export declare function startWatch(): StopWatch;