idlefy
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

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

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

Name Description
constructor(options)

Parameters:

  • options.ensureTasksRun (boolean) Adds Page Lifecycle callbacks to ensure the queue is run before the user leaves the page (default: false).
  • options.defaultMinTaskTime: (number) The default amount of idle time remaining in order for a task to be run (default: 0).
pushTask(task, options)

Parameters:

  • task: (function(Object)) The task to add to the end of the queue.
  • options.minTaskTime: (number) The minimum amount of idle time remaining in order for a task to be run. If no value is passed, the queue default is used.

Adds a task to the end of the queue and schedules the queue to be run when next idle (if not already scheduled).

When the task is run, it's invoked with an object containing the following properties:

  • time: (number) The time (epoch time in milliseconds) when the task was added to the queue.
  • visibilityState: (string) The visibility state of the document when the task was added to the queue.
unshiftTask(task, options)

Parameters:

  • task: (function(Object<{{time: number, visibilityState: string}}>)) The task to add to the beginning of the queue.
  • options.minTaskTime: (number) The minimum amount of idle time remaining in order for a task to be run. If no value is passed, the queue default is used.

Adds a task to the beginning of the queue and schedules the queue to be run when next idle (if not already scheduled).

When the task is run, it's invoked with an object containing the following properties:

  • time: (number) The time (epoch time in milliseconds) when the task was added to the queue.
  • visibilityState: (string) The visibility state of the document when the task was added to the queue.
runTasksImmediately()

Runs all queued tasks immediately (synchronously).

hasPendingTasks()

Returns: (boolean)

True if the queue has any tasks not yet run.

clearPendingTasks()

Unschedules all pending tasks in the queue.

getState()

Returns: (Object)

  • {time}: (number) The time (milliseconds, in epoch time) the task was added to the queue.
  • {visibilityState}: (string) The document's visibility state when the task was added to the queue.

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

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

Name Description
constructor(init)

Parameters:

  • init (Function) An initialization function (typically something expensive to compute) that returns a value.

The initialization function is scheduled to run in an idle callback as soon as the instance is created.

getValue()

Returns: (*)

Returns the value returned by the initialization function passed to the constructor. If the initialization function has already been run, the value is returned immediately. If the initialization function is still scheduled for an idle callback, that callback is cancelled, the initialization function is run synchronously, and the result is returned.

setValue(newValue)

Parameters:

  • newValue (*)

Assigns a new value. If the initialization function passed to the constructor has not yet run, it is cancelled.

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

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

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

Name Type Description
obj Object The object on which to define the property.
prop string The name of the property.
init Function An function (typically something expensive to compute) that returns a value. The function is scheduled to run in an idle callback as soon as the property is defined. If the property is referenced before the function can be run in an idle callback, the idle callback is canceled, the function is run immediately, and the return value of the function is set as the value of the property.

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

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

Name Type Description
obj Object The object on which to define the property.
props Object A dictionary of property names and initialization functions. See the defineIdleProperty documentation for prop and init.

Package Sidebar

Install

npm i idlefy

Weekly Downloads

1,623

Version

1.1.1

License

MIT

Unpacked Size

60.3 kB

Total Files

24

Last publish

Collaborators

  • harshkc