# @types/gc-stats

> TypeScript definitions for gc-stats

Latest version **1.4.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/gc-stats
pnpm add @types/gc-stats
yarn add @types/gc-stats
bun add @types/gc-stats
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.3 |
| Published | 2023-11-07 |
| First published | 2018-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/gc-stats
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gc-stats
- npm.io page: https://npm.io/package/@types/gc-stats

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.4.3 (latest) — 2023-11-07
- 1.4.1 (ts3.6) — 2021-07-08
- 1.4.0 (ts2.0) — 2019-07-10
- 1.4.2 — 2023-10-18
- 1.2.0 — 2018-08-23

## README

# Installation
> `npm install --save @types/gc-stats`

# Summary
This package contains type definitions for gc-stats (https://github.com/dainis/node-gcstats#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gc-stats.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gc-stats/index.d.ts)
````ts
/// <reference types="node" />

import { EventEmitter } from "events";

declare namespace GCStats {
    interface MemoryStatistics {
        totalHeapSize: number;
        totalHeapExecutableSize: number;
        usedHeapSize: number;
        heapSizeLimit: number;
        totalPhysicalSize: number;
        totalAvailableSize: number;
        mallocedMemory?: number | undefined; // became available with node 7+
        peakMallocedMemory?: number | undefined; // became available with node 7+
        numberOfNativeContexts?: number | undefined; // became available with node 10+
        numberOfDetachedContexts?: number | undefined; // became available with node 10+
    }

    interface GCStatistics {
        startTime: number;
        endTime: number;
        pause: number;
        pauseMS: number;
        gctype: 1 | 2 | 4 | 8 | 15;
        before: MemoryStatistics;
        after: MemoryStatistics;
        diff: MemoryStatistics;
    }

    type GCStatsListener = (stats: GCStatistics) => void;

    interface GCStatsEventEmitter extends EventEmitter {
        on(event: "stats", listener: GCStatsListener): this;
        addListener(event: "stats", listener: GCStatsListener): this;
        once(event: "stats", listener: GCStatsListener): this;
    }
}

declare function GCStats(): GCStats.GCStatsEventEmitter;

export = GCStats;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Vitor Fernandes](https://github.com/vfernandestoptal).

---
_Source: https://npm.io/package/@types/gc-stats · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._