idlefy v1.1.1

idlefy

Defer non-critical tasks to execute when the main thread is idle

The idlefy library is a collection of JavaScript tools designed to help you improve website performance by strategically scheduling tasks to run during the browser's idle periods. This adheres to the idle-until-urgent pattern.

Inspired by the idilize library, idlefy not only retains all the original features but also introduces enhanced TypeScript support, a reduced bundle size, and a more adaptable API. Moreover, it seamlessly serves as a drop-in replacement for idilize, passing all the tests from the original library.

• TypeScript Precision: Enjoy the benefits of type safety, better code structure, and improved developer productivity.
• SSR Compatibility: Our library seamlessly integrates with server-side rendering.
• Light on Disk: An optimized bundle ensures minimal overhead and maximum impact and you can leverage tree shaking to remove unused code by using module level imports.

Installation

npm install idlefy

Usage

// imports all helpers methods and classes from idlefy library
import { IdleQueue, IdleValue } from 'idlefy'
// import only methods and classes you need
import { IdleQueue } from 'idlefy/idleQueue.js'
// import methods from minified build
import { IdleQueue } from 'idlefy/min'

IdleQueue

idlefy/idleQueue

Overview

It's useful for apps that want to split up their logic into a sequence of functions and schedule them to run idly.

This class offers a few benefits over the regular usage of requestIdleCallback():

• The queue can be configured so all queued functions are guaranteed to run before the page is unloaded.
• Queued tasks can be run immediately at any time.
• Queued tasks can pass a minimum time budget, below which they won't attempt to run (this minimum time budget can also be configured per queue).
• Queued tasks store the time/visibilityState when they were added to the queue, and are invoked with this data when run.

Exports

• IdleQueue

Usage

import { IdleQueue } from 'idlefy/idleQueue.js'

const queue = new IdleQueue()

queue.pushTask(() => {
  // Some expensive function that can run idly...
})

queue.pushTask(() => {
  // Some other task that depends on the above
  // expensive function having already run...
})

Methods

IdleValue

idlefy/idleValue

Overview

It's useful when you want to initialize a value during an idle period but ensure it can be initialized immediately as soon as it's needed.

Exports

• IdleValue

Usage

import { IdleValue } from 'idlefy/idleValue.js'

class MyClass {
  constructor() {
    // Create an IdleValue instance for `this.data`. It's value is
    // initialized in an idle callback (or immediately as soon as
    // `this.data.getValue()` is called).
    this.data = new IdleValue(() => {
      // Run expensive code and return the result...
    })
  }
}

Methods

idle-callback-with-polyfills

idlefy/idleCbWithPolyfill

Overview

Small polyfills that allow developers to use requestIdleCallback and cancelIdleCallback() in all browsers.

These are not full polyfills (since the native APIs cannot be fully polyfilled), but they offer the basic benefits of idle tasks via setTimeout() and clearTimeout().

Exports

• rIC
• cIC

Usage

import { cIC, rIC } from 'idlefy/idleCbWithPolyfill.js'

// To run a task when idle.
const handle = rIC(() => {
  // Do something here...
})

// To cancel the idle callback.
cIC(handle)

rIC

Uses the native requestIdleCallback() function in browsers that support it, or a small polyfill (based on setTimeout()) in browsers that don't.

See the requestIdleCallback() docs on MDN for details.

cIC

Uses the native cancelIdleCallback() function in browsers that support it, or a small polyfill (based on clearTimeout()) in browsers that don't.

See the cancelIdleCallback() docs on MDN for details.

defineIdleProperty

idlefy/defineIdleProperty

Overview

It's useful when you want to initialize a property value during an idle period but ensure it can be initialized immediately as soon as it's referenced.

Exports

• defineIdleProperty

Usage

import { defineIdleProperty } from 'idlefy/defineIdleProperty.js'

class MyClass {
  constructor() {
    // Define a getter for `this.data` whose value is initialized
    // in an idle callback (or immediately if referenced).
    defineIdleProperty(this, 'data', () => {
      // Run expensive code and return the result...
    })
  }
}

Syntax

defineIdleProperty(obj, prop, init)

Parameters

defineIdleProperties

idlefy/defineIdleProperties

Overview

It's useful when you want to initialize one or more property values during an idle period but ensure they can be initialized immediately as soon as they're referenced.

Exports

• defineIdleProperties

Usage

import { defineIdleProperties } from 'idlefy/defineIdleProperties.js'

class MyClass {
  constructor() {
    // Define a getter for `this.data` whose value is initialized
    // in an idle callback (or immediately if referenced).
    defineIdleProperties(this, {
      data: () => {
        // Run expensive code and return the result...
      },
    })
  }
}

Syntax

defineIdleProperties(obj, props)

Parameters