@egodigital/egoose/lib/system/index.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/>.
 */
/**
 * Result of 'getDiskSpace()' function.
 */
export interface DiskSpaceResult {
    /**
     * The free space, in bytes.
     */
    free: number;
    /**
     * The total space, in bytes.
     */
    total: number;
    /**
     * The used space, in bytes.
     */
    used: number;
}
/**
 * Returns the CPU usage in percentage.
 *
 * @return {Promise<number>} The promise with the CPU usage.
 */
export declare function getCpuUsage(): Promise<number>;
/**
 * Returns the diskspace of a mount point.
 *
 * @param {string} [mountPoint] The custom name / path of the endpoint to check.
 *
 * @return {Promise<DiskSpaceResult>} The promise with the result.
 */
export declare function getDiskSpace(mountPoint?: string): Promise<DiskSpaceResult>;