@types/tapable

What is @types/tapable?

The @types/tapable package provides TypeScript type definitions for the Tapable library, which is used primarily in webpack for its plugin architecture. Tapable allows you to add and apply plugins to a JavaScript project. It offers various hooks like SyncHook, AsyncParallelHook, and more, which can be used to handle synchronous and asynchronous operations.

What are @types/tapable's main functionalities?

SyncHook

SyncHook allows for the synchronous execution of functions. The functions attached via `tap` will be executed in the order they were added when `call` is invoked.

import { SyncHook } from 'tapable';

const hook = new SyncHook(['arg1']);
hook.tap('PluginName', (arg1) => {
  console.log(`Value received: ${arg1}`);
});
hook.call('test');

AsyncParallelHook

AsyncParallelHook allows for the parallel execution of asynchronous functions. Functions can be added using `tapPromise` and are executed with `promise`.

import { AsyncParallelHook } from 'tapable';

const asyncHook = new AsyncParallelHook(['arg1']);
asyncHook.tapPromise('PluginName', (arg1) => {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      console.log(`Async value: ${arg1}`);
      resolve();
    }, 1000);
  });
});
asyncHook.promise('test').then(() => {
  console.log('All async plugins have finished');
});

Other packages similar to @types/tapable

mitt

Mitt is a tiny functional event emitter / pubsub library. It offers similar event handling capabilities but lacks the sophisticated hook system and the distinction between synchronous and asynchronous operations found in Tapable.

eventemitter3

EventEmitter3 is a high-performance event emitter. While it provides efficient event handling like Tapable, it does not support the hook-based plugin architecture that allows for ordered execution and lifecycle management in Tapable.

README

Installation

npm install --save @types/tapable

Summary

This package contains type definitions for tapable (https://github.com/webpack/tapable.git).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tapable.

index.d.ts

// Type definitions for tapable 2.2
// Project: https://github.com/webpack/tapable.git
// Definitions by: e-cloud <https://github.com/e-cloud>
//                 John Reilly <https://github.com/johnnyreilly>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/* eslint-disable-next-line @definitelytyped/no-self-import */
import tapable = require('tapable');
export = tapable;

Additional Details

• Last updated: Tue, 22 Aug 2023 18:04:44 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by e-cloud, and John Reilly.