# @types/livereload

> TypeScript definitions for livereload

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

## Install

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

## 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.9.5 |
| Published | 2023-11-07 |
| First published | 2021-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.9.5 (latest) — 2023-11-07
- 0.9.3 (ts4.3) — 2023-08-30
- 0.9.2 (ts3.9) — 2022-03-24
- 0.9.1 (ts3.6) — 2021-07-08
- 0.9.0 (ts3.4) — 2021-02-06
- 0.9.4 — 2023-10-18

## README

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

# Summary
This package contains type definitions for livereload (https://github.com/napcs/node-livereload).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/livereload.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/livereload/index.d.ts)
````ts
import { EventEmitter } from "events";
import { FSWatcher } from "fs";
import { Server as httpServer } from "http";
import { Server as httpsServer, ServerOptions } from "https";
import { Server as WebSocketServer, WebSocket } from "ws";

export interface ServerConfig {
    /** Protocol Version defaults to "7" */
    version?: string | undefined;
    /** Sets server port number: Defaults to 35729 */
    port?: number | undefined;

    /** File Extensions to watch */
    exts?: string[] | undefined;

    extraExts?: string[] | undefined;

    /** Extensions to not watch */
    exclusions?: RegExp[] | undefined;
    applyCSSLive?: boolean | undefined;
    applyImgLive?: boolean | undefined;
    originalPath?: string | undefined;
    overrideURL?: string | undefined;
    usePolling?: boolean | undefined;
    server?: httpServer | httpsServer | undefined;

    /** ms to delay browser refresh */
    delay?: number | undefined;

    /** Logs debug messages to console */
    debug?: boolean | undefined;
}

/** Create Server Parameters */
export interface CreateServerConfig extends ServerConfig {
    https?: ServerOptions | undefined;
    server?: httpServer | httpsServer | undefined;
    noListen?: boolean | undefined;
}

/** Live Reload Server object, provides main functionality */
export class LiveReloadServer extends EventEmitter {
    config: ServerConfig;
    watcher: FSWatcher;
    server: WebSocketServer;
    constructor(config?: ServerConfig);

    listen(callback?: () => void): void;
    onError(err: Error): void;
    onConnection(socket?: WebSocket): void;
    onClose(socket?: WebSocket): void;

    /** Specify path(s) to watch */
    watch(paths: string | string[]): void;
    filterRefresh(filepath: string): void;
    refresh(filepath: string): void;
    alert(message: string): void;
    sendAllClients(data: string): void;
    close(): void;
    debug(message: string): void;
}

export {};

export function createServer(config?: CreateServerConfig, callback?: () => void): LiveReloadServer;

````

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

# Credits
These definitions were written by [Hector Osuna](https://github.com/FanGoH).

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