云策 WordPress 开发者社区

块编辑器开发文档

@wordpress/priority-queue

查看官方原文 ↗
💡 云策文档标注

概述

@wordpress/priority-queue 是一个 WordPress 模块，用于在浏览器空闲时间运行回调队列，确保高优先级任务优先执行。它提供 createQueue API 来创建上下文感知的队列，每个上下文只执行最后一个任务。

关键要点

  • 模块允许在浏览器空闲时执行回调队列，优化性能。
  • 使用 createQueue 创建队列，支持 add、flush 和 reset 方法。
  • 对于给定上下文，队列只执行最后添加的回调，忽略之前的。
  • 需要 ES2015+ 环境，否则需包含 @wordpress/babel-preset-default 的 polyfill。
  • 作为 Gutenberg 项目的一部分，通过 npm 安装，支持贡献。

代码示例

import { createQueue } from '@wordpress/priority-queue';

const queue = createQueue();

// Context objects.
const ctx1 = {};
const ctx2 = {};

// For a given context in the queue, only the last callback is executed.
queue.add( ctx1, () => console.log( 'This will be printed first' ) );
queue.add( ctx2, () => console.log( "This won't be printed" ) );
queue.add( ctx2, () => console.log( 'This will be printed second' ) );
📄 原文内容

This module allows you to run a queue of callback while on the browser’s idle time making sure the higher-priority work is performed first.

Installation

Install the module

npm install @wordpress/priority-queue --save

This package assumes that your code will run in an ES2015+ environment. If you’re using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

API

createQueue

Creates a context-aware queue that only executes the last task of a given context.

Usage

import { createQueue } from '@wordpress/priority-queue';

const queue = createQueue();

// Context objects.
const ctx1 = {};
const ctx2 = {};

// For a given context in the queue, only the last callback is executed.
queue.add( ctx1, () => console.log( 'This will be printed first' ) );
queue.add( ctx2, () => console.log( "This won't be printed" ) );
queue.add( ctx2, () => console.log( 'This will be printed second' ) );

Returns

  • WPPriorityQueue: Queue object with add, flush and reset methods.

Contributing to this package

This is an individual package that’s part of the Gutenberg project. The project is organized as a monorepo. It’s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.