Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 885 Bytes

README.md

File metadata and controls

51 lines (36 loc) · 885 Bytes

Idle Preload

Features

Preload something when the page is idle.

Idle detection algorithm：

  • After page loaded, use setTimeout and record the real callback time delay.
  • Compute the variance of multiple callback time delay.
  • The page is considered idle and stable when the variance is low.

Installation

yarn add idle-preload

or

npm i idle-preload --save

Usage

import { idlePreload } from 'idle-preload'

const preload = idlePreload({
  // options
  // debug: true
})
preload.push(() => {
  // use your code to preload something
  // 
})
preload.start()

Options

  • varianceLimit: Integer (default 5),
  • samplingCount: Integer (default 5),
  • afterWindowLoad: Boolean (default true),
  • checkTimeInterval: Integer (default 200) ms,
  • debug: Boolean (default false)

License

MIT