Logo for jsDocs.io

@types/live-server

  • Version 1.2.3
  • Published
  • 5.19 kB
  • No dependencies
  • MIT license

Install

npm i @types/live-server
yarn add @types/live-server
pnpm add @types/live-server

Overview

TypeScript definitions for live-server

Index

Functions

Interfaces

Functions

function shutdown

shutdown: () => void;

  • Shutdown live-server.

function start

start: (params: LiveServerParams) => void;

  • Start live-server.

Interfaces

interface LiveServerParams

interface LiveServerParams {}

  • The live-server start params.

property file

file?: string | undefined;

  • When set, serve this file (server root relative) for every 404 (useful for single-page applications).

property host

host?: string | undefined;

  • Set the address to bind to. Defaults to 0.0.0.0 or process.env.IP.

property ignore

ignore?: string | undefined;

  • Comma-separated string for paths to ignore.

property logLevel

logLevel?: 0 | 1 | 2 | undefined;

  • 0 = errors only, 1 = some, 2 = lots

property middleware

middleware?: Array<(req: any, res: any, next: any) => void> | undefined;

  • Takes an array of Connect-compatible middleware that are injected into the server middleware stack.

property mount

mount?: string[][] | undefined;

  • Mount a directory to a route.

property open

open?: boolean | undefined;

  • When false, it won't load your browser by default.

property port

port?: number | undefined;

  • Set the server port. Defaults to 8080.

property root

root?: string | undefined;

  • Set root directory that's being served. Defaults to cwd.

property wait

wait?: number | undefined;

  • Waits for all changes, before reloading. Defaults to 0 sec.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/live-server.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/live-server)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/live-server"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>