# @types/reload

> TypeScript definitions for reload

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

## Install

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

## 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 | 3.2.3 |
| Published | 2023-11-07 |
| First published | 2023-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 3.2.3 (latest) — 2023-11-07
- 3.2.0 (ts4.3) — 2023-04-04
- 3.2.2 — 2023-10-18
- 3.2.1 — 2023-09-27

## README

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

# Summary
This package contains type definitions for reload (https://github.com/alallier/reload#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/reload.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/reload/index.d.ts)
````ts
import express = require("express");
import ws = require("ws");

declare function reload(
    app: express.Express,
    opts: reload.OptionsWaitToStartWebSocketServer,
): Promise<reload.ReloadWithWebSocketServer>;
declare function reload(app: express.Express, opts?: reload.Options): Promise<reload.Reload>;

declare namespace reload {
    interface Options {
        port?: number;
        https?: {
            p12?: {
                p12Path: string;
            };
            certAndKey?: {
                key: string;
                cert: string;
            };
            passphrase?: string;
        };
        forceWss?: boolean;
        verbose?: boolean;
        route?: string;
    }

    interface OptionsWaitToStartWebSocketServer extends Options {
        webSocketServerWaitStart: true;
    }

    interface Reload {
        reload(): void;
        wss: ws.Server;
        closeServer(): Promise<Error | undefined>;
    }

    interface ReloadWithWebSocketServer extends Reload {
        startWebSocketServer(): Promise<Reload>;
    }
}

export = reload;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/ws](https://npmjs.com/package/@types/ws)

# Credits
These definitions were written by [Victor Nascimento Bakke](https://github.com/Gipphe).

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