Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.56 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.56 KB

hotcake

Version License js-semistandard-style

Bring HMR-like auto refresh functionality without any server (e.g. websocket, socket.io, etc.) and keep it minimal, simple.

Demo

Installation

Add following tag to your html file.

<script src="https://cdn.jsdelivr.net/npm/hotcake"></script>

Or Via GitHub. (Not recommended)

<script src="https://raw.githack.com/Xvezda/hotcake/master/hotcake.js"></script>

Or even with npm... (Also not recommended)

npm install --save-dev hotcake

Usage

After installation, you can explicitly initialize hotcake with options.

<script>
new Hotcake({
    observe: ['./', './app.js'],
    interval: 5000
});
</script>

If hotcake not initialized explicitly, it will automatically initialize with default options when window loaded.

Options

name type description default
observe string[] Path of files to observe. ['./']
interval number Millisecond value of interval between requests. 3000

License

Copyright (C) 2020 Xvezda

MIT License