# @types/fpsmeter

> TypeScript definitions for fpsmeter

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

## Install

```sh
npm install @types/fpsmeter
pnpm add @types/fpsmeter
yarn add @types/fpsmeter
bun add @types/fpsmeter
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.34 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

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

## Recent versions

- 0.3.34 (latest) — 2023-11-07
- 0.3.31 (ts3.6) — 2021-07-08
- 0.3.30 (ts3.0) — 2020-05-15
- 0.3.29 (ts2.0) — 2017-08-21
- 0.3.33 — 2023-10-18
- 0.3.32 — 2023-09-14
- 0.3.28 — 2016-09-19
- 0.3.27 — 2016-07-14
- 0.3.26-alpha — 2016-07-08
- 0.3.25-alpha — 2016-07-04
- 0.3.24-alpha — 2016-07-02
- 0.3.23-alpha — 2016-07-01
- 0.3.22-alpha — 2016-07-01
- 0.3.21-alpha — 2016-05-25
- 0.3.20-alpha — 2016-05-20
- … 2 more at https://npm.io/package/@types/fpsmeter/versions

## README

# Installation
> `npm install --save @types/fpsmeter`

# Summary
This package contains type definitions for fpsmeter (http://darsa.in/fpsmeter/).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fpsmeter.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fpsmeter/index.d.ts)
````ts
interface FPSMeterOptions {
    interval?: number | undefined; // Update interval in milliseconds.
    smoothing?: number | undefined; // Spike smoothing strength. 1 means no smoothing.
    show?: string | undefined; // Whether to show 'fps', or 'ms' = frame duration in milliseconds.
    toggleOn?: string | undefined; // Toggle between show 'fps' and 'ms' on this event.
    decimals?: number | undefined; // Number of decimals in FPS number. 1 = 59.9, 2 = 59.94, ...
    maxFps?: number | undefined; // Max expected FPS value.
    threshold?: number | undefined; // Minimal tick reporting interval in milliseconds.
    position?: string | undefined; // Meter position.
    zIndex?: number | undefined; // Meter Z index.
    left?: string | undefined; // Meter left offset.
    top?: string | undefined; // Meter top offset.
    right?: string | undefined; // Meter right offset.
    bottom?: string | undefined; // Meter bottom offset.
    margin?: string | undefined; // Meter margin. Helps with centering the counter when left: 50%;

    theme?: string | undefined; // Meter theme. Build in: 'dark', 'light', 'transparent', 'colorful'.
    heat?: number | undefined; // Allow themes to use coloring by FPS heat. 0 FPS = red, maxFps = green.

    graph?: number | undefined; // Whether to show history graph.
    history?: number | undefined; // How many history states to show in a graph.
}

declare class FPSMeter {
    constructor(anchor?: HTMLElement, options?: FPSMeterOptions);
    public options: FPSMeterOptions;
    public tick(): void;
    public tickStart(): void;
    public pause(): FPSMeter;
    public resume(): FPSMeter;
    public set(name: string, value: any): FPSMeter;
    public showDuration(): FPSMeter;
    public showFps(): FPSMeter;
    public toggle(): FPSMeter;
    public hide(): FPSMeter;
    public show(): FPSMeter;
    public destroy(): void;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [Aaron Lampros](https://github.com/alampros).

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