# @types/nprogress

> TypeScript definitions for nprogress

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

## Install

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

## 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; pre 1.0.

Negative: abandoned.

## Facts

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

## Links

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

## Recent versions

- 0.2.3 (latest) — 2023-11-07
- 0.2.0 (ts2.1) — 2019-05-31
- 0.0.29 (ts2.0) — 2016-10-05
- 0.2.2 — 2023-10-18
- 0.2.1 — 2023-09-23
- 0.0.28 — 2016-09-19
- 0.0.27 — 2016-07-14
- 0.0.26-alpha — 2016-07-12
- 100.0.26-alpha — 2016-07-08
- 100.0.25-alpha — 2016-07-04
- 100.0.24-alpha — 2016-07-02
- 100.0.23-alpha — 2016-07-01
- 100.0.22-alpha — 2016-07-01
- 100.0.21-alpha — 2016-05-25
- 100.0.20-alpha — 2016-05-20
- … 2 more at https://npm.io/package/@types/nprogress/versions

## README

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

# Summary
This package contains type definitions for nprogress (https://github.com/rstacruz/nprogress).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nprogress.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nprogress/index.d.ts)
````ts
declare namespace nProgress {
    interface NProgressOptions {
        minimum: number;
        template: string;
        easing: string;
        speed: number;
        trickle: boolean;
        trickleSpeed: number;
        showSpinner: boolean;
        parent: string;
        positionUsing: string;
        barSelector: string;
        spinnerSelector: string;
    }

    interface NProgress {
        version: string;
        settings: NProgressOptions;
        status: number | null;

        configure(options: Partial<NProgressOptions>): NProgress;
        set(number: number): NProgress;
        isStarted(): boolean;
        start(): NProgress;
        done(force?: boolean): NProgress;
        inc(amount?: number): NProgress;
        trickle(): NProgress;

        /* Internal */

        render(fromStart?: boolean): HTMLDivElement;
        remove(): void;
        isRendered(): boolean;
        getPositioningCSS(): "translate3d" | "translate" | "margin";
    }
}

declare const nProgress: nProgress.NProgress;
export = nProgress;

````

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

# Credits
These definitions were written by [Judah Gabriel Himango](https://github.com/JudahGabriel), and [Ovyerus](https://github.com/Ovyerus).

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