@livelybone/request-idle-callback
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

@livelybone/request-idle-callback

NPM Version Download Month gzip with dependencies: 1.1kb typescript

中文文档

A polyfill for window.requestIdleCallback, support NodeJs. It can be used for time slicing.

The behavior of this module is closer to window.requestIdleCallback than requestidlecallback, see the details in the example below

repository

https://github.com/livelybone/request-idle-callback.git

Demo

https://github.com/livelybone/request-idle-callback#readme

Run Example

you can see the usage by run the example of the module, here is the step:

  1. Clone the library git clone https://github.com/livelybone/request-idle-callback.git
  2. Go to the directory cd your-module-directory
  3. Install npm dependencies npm i(use taobao registry: npm i --registry=http://registry.npm.taobao.org)
  4. Open service npm run dev
  5. See the example(usually is http://127.0.0.1:3000/examples/test.html) in your browser

Installation

npm i -S @livelybone/request-idle-callback

Global name - The variable the module exported in umd bundle

RIC

Interface

See what method or params you can use in index.d.ts

Usage

import * as RIC from '@livelybone/request-idle-callback'

const id = RIC.requestIdleCallback(() => {
  // ... do something
})

RIC.cancelIdleCallback(id)

use as a polyfill:

in js:

import '@livelybone/request-idle-callback/lib/umd/polyfill';

in html(CDN):

<script src="https://cdn.jsdelivr.net/npm/@livelybone/request-idle-callback/lib/umd/polyfill.js"></script>

CDN

Use in html, see what you can use in CDN: unpkg

<-- use what you want -->
<script src="https://unpkg.com/@livelybone/request-idle-callback/lib/umd/<--module-->.js"></script>

Or,see what you can use in CDN: jsdelivr

<script src="https://cdn.jsdelivr.net/npm/@livelybone/request-idle-callback/lib/umd/<--module-->.js"></script>

Package Sidebar

Install

npm i @livelybone/request-idle-callback

Weekly Downloads

11

Version

1.1.0

License

MIT

Unpacked Size

17.7 kB

Total Files

8

Last publish

Collaborators

  • livelybone