Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 2.7 KB

README-CN.md

File metadata and controls

72 lines (55 loc) · 2.7 KB
Raw

@livelybone/request-idle-callback

NPM Version Download Month gzip with dependencies: 1.1kb typescript

English Document

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

你可以通过运行项目的 example 来了解这个组件的使用，以下是启动步骤：

  1. 克隆项目到本地 git clone https://github.com/livelybone/request-idle-callback.git
  2. 进入本地克隆目录 cd your-module-directory
  3. 安装项目依赖 npm i(使用 taobao 源: npm i --registry=http://registry.npm.taobao.org)
  4. 启动服务 npm run dev
  5. 在你的浏览器看 example (地址通常是 http://127.0.0.1:3000/examples/test.html)

Installation

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

Global name - The variable the module exported in umd bundle

RIC

Interface

去 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

在 HTML 文件中直接引用，你可以在 CDN: unpkg 看到你能用到的所有 js 脚本

<-- 然后使用你需要的 -->
<script src="https://unpkg.com/@livelybone/request-idle-callback/lib/umd/<--module-->.js"></script>

或者，你也可以使用 CDN: jsdelivr 看到你能用到的所有 js 脚本

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