Logo for jsDocs.io

rollup-plugin-livereload

  • Version 2.0.5
  • Published
  • 14.4 kB
  • 1 dependency
  • MIT license

Install

npm i rollup-plugin-livereload
yarn add rollup-plugin-livereload
pnpm add rollup-plugin-livereload

Overview

Rollup plugin for LiveReload that watches the bundle and reloads the page on change

Index

Functions

Interfaces

Functions

function livereload

livereload: (options?: RollupLivereloadOptions | string) => Plugin;

  • 🔄 A Rollup plugin for including livereload in your web app.

Interfaces

interface RollupLivereloadOptions

interface RollupLivereloadOptions {}

    property delay

    delay?: number;

    • Add a delay (in milliseconds) between when livereload detects a change to the filesystem and when it notifies the browser. Useful if the browser is reloading/refreshing before a file has been compiled.

    property inject

    inject?: boolean;

    • Inject the livereload snippet into the bundle which will enable livereload in your web app. Defaults to true

    property port

    port?: number;

    • The listening port. It defaults to 35729 which is what the LiveReload extensions use currently.

    property verbose

    verbose?: boolean;

    • Log a message to console when livereload is ready Defaults to true

    property watch

    watch?: string | string[];

    • Defaults to current directory

    index signature

    [livereloadOption: string]: any;

    • Livereload options, improvements welcome

    Package Files (1)

    Dependencies (1)

    Dev Dependencies (4)

    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/rollup-plugin-livereload.

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