# @types/live-server

> TypeScript definitions for live-server

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

## Install

```sh
npm install @types/live-server
pnpm add @types/live-server
yarn add @types/live-server
bun add @types/live-server
```

## 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.2.3 |
| Published | 2023-11-07 |
| First published | 2020-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.2.3 (latest) — 2023-11-07
- 1.2.1 (ts3.6) — 2021-07-08
- 1.2.0 (ts3.0) — 2020-06-23
- 1.2.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/live-server`

# Summary
This package contains type definitions for live-server (https://github.com/tapio/live-server#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/live-server.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/live-server/index.d.ts)
````ts
/**
 * The live-server start params.
 */
export interface LiveServerParams {
    /** Set the server port. Defaults to 8080. */
    port?: number | undefined;
    /**  Set the address to bind to. Defaults to 0.0.0.0 or process.env.IP. */
    host?: string | undefined;
    /** Set root directory that's being served. Defaults to cwd. */
    root?: string | undefined;
    /** When false, it won't load your browser by default. */
    open?: boolean | undefined;
    /** Comma-separated string for paths to ignore. */
    ignore?: string | undefined;
    /** When set, serve this file (server root relative) for every 404 (useful for single-page applications). */
    file?: string | undefined;
    /** Waits for all changes, before reloading. Defaults to 0 sec. */
    wait?: number | undefined;
    /** Mount a directory to a route. */
    mount?: string[][] | undefined;
    /** 0 = errors only, 1 = some, 2 = lots */
    logLevel?: 0 | 1 | 2 | undefined;
    /** Takes an array of Connect-compatible middleware that are injected into the server middleware stack. */
    middleware?: Array<(req: any, res: any, next: any) => void> | undefined;
}

/**
 * Start live-server.
 */
export function start(params: LiveServerParams): void;

/**
 * Shutdown live-server.
 */
export function shutdown(): void;

````

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

# Credits
These definitions were written by [Josh Cummings](https://github.com/joshcummingsdesign).

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