https://github.com/mjancarik/idle-tasks

The idle-tasks module is for optimization tasks which it can be running lazy. It may be useful for boost your page loading time.
https://github.com/mjancarik/idle-tasks

idle javascript performance requestidle

Last synced: 3 months ago
JSON representation

The idle-tasks module is for optimization tasks which it can be running lazy. It may be useful for boost your page loading time.

• Host: GitHub
• URL: https://github.com/mjancarik/idle-tasks
• Owner: mjancarik
• License: mit
• Created: 2019-02-03T20:54:43.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:37:55.000Z (almost 2 years ago)
• Last Synced: 2024-10-06T12:02:22.819Z (3 months ago)
• Topics: idle, javascript, performance, requestidle
• Language: TypeScript
• Homepage:
• Size: 772 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# idle-tasks

[![Version](https://img.shields.io/github/package-json/v/mjancarik/idle-tasks/master.svg)](https://www.npmjs.com/package/idle-tasks)

[![Build Status](https://travis-ci.org/mjancarik/idle-tasks.svg?branch=master)](https://travis-ci.org/mjancarik/idle-tasks)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Coverage Status](https://coveralls.io/repos/github/mjancarik/idle-tasks/badge.svg?branch=master)](https://coveralls.io/github/mjancarik/idle-tasks?branch=master)

![npm bundle size](https://img.shields.io/bundlephobia/minzip/idle-tasks.svg)

![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/idle-tasks.svg)

[![dependencies Status](https://david-dm.org/mjancarik/idle-tasks/status.svg)](https://david-dm.org/mjancarik/idle-tasks)

The common web apps use lot's of javascript today. The javascript on your web is not only own but also third party's. So you need define priority for better performance and some less important code evaluate lazy. The idle-tasks module allow you define queue of tasks which will be evaluated after browser is idle. It use [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) under the hood. If requestIdleCallback was not support in browser it would use setTimeout.

## Installation

``` shell

npm i idle-tasks --save

```

## Usage

``` javascript

import { createIdleQueue, Event } from 'idle-tasks';

function createTask() {

  return (deadline) => {

    return new Promise((resolve) => {

      setTimeout(resolve, 100 + time);

    })

  }

}

const idleQueue = createIdleQueue({

  ensureTasks: true,

  timeout: 1000

});

idleQueue.addTask(createTask());

idleQueue.addTask(createTask());

idleQueue.addTask(createTask());

idleQueue.addTask(createTask());

idleQueue.addTask(createTask());

idleQueue.on(Event.Start, () => console.log('start tasks'));

idleQueue.on(Event.Finish, ({ results }) => console.log('finish tasks', ...results));

idleQueue.on(Event.Error, ({ error }) => console.error(error));

// for running tasks immediately

// idleQueue.run();

// for scheduling tasks

idleQueue.schedule();

```