@babel/helper-wrap-function

What is @babel/helper-wrap-function?

The @babel/helper-wrap-function package is a utility within the Babel ecosystem designed to assist in wrapping functions. This package is particularly useful when transforming code during the build process, allowing developers to modify function behavior or inject additional functionality seamlessly.

What are @babel/helper-wrap-function's main functionalities?

Function Wrapping

This feature allows developers to wrap any given function with additional behavior. In the provided code sample, the original function is wrapped to include a console log statement that outputs the arguments with which the function is called.

import wrapFunction from '@babel/helper-wrap-function';

const myFunction = function (a, b) {
  return a + b;
};

const wrappedFunction = wrapFunction(myFunction, function (fn, args, context) {
  console.log('Function is called with arguments:', args);
  return fn.apply(context, args);
});

wrappedFunction(1, 2);

Other packages similar to @babel/helper-wrap-function

lodash.wrap

Lodash provides a utility method 'wrap' which serves a similar purpose to @babel/helper-wrap-function. It allows you to wrap a function with a custom wrapper, enabling you to modify arguments, outputs, or behavior. Compared to @babel/helper-wrap-function, lodash.wrap is part of a larger utility library and may be preferred for projects that already use Lodash for other utilities.

core-decorators

The core-decorators package offers a variety of decorators for class properties and methods. While not a direct analog to function wrapping, decorators can be used to achieve similar outcomes in terms of modifying or enhancing function behavior. This package is more suited for use with ES6 classes and may offer a more declarative approach compared to @babel/helper-wrap-function.

README

@babel/helper-wrap-function

Helper to wrap functions inside a function call.

See our website @babel/helper-wrap-function for more information.

Install

Using npm:

npm install --save @babel/helper-wrap-function

or using yarn:

yarn add @babel/helper-wrap-function

Changelog

v7.22.17 (2023-09-08)

:bug: Bug Fix

• babel-core
  • #15947 Fix compatibility with Node.js 20.6 (@nicolo-ribaudo)
• babel-helper-module-transforms, babel-plugin-transform-modules-commonjs
  • #15941 Fix compiling duplicate ns imports to lazy CommonJS (@nicolo-ribaudo)
• babel-types
  • #15920 Make ClassDeclaration["id"] optional in babel-types (@jordanbtucker)

:microscope: Output optimization

• babel-helper-remap-async-to-generator, babel-helper-wrap-function, babel-plugin-proposal-explicit-resource-management, babel-plugin-proposal-function-sent, babel-plugin-transform-async-generator-functions, babel-plugin-transform-async-to-generator, babel-plugin-transform-block-scoping, babel-plugin-transform-class-properties, babel-plugin-transform-classes, babel-plugin-transform-parameters, babel-plugin-transform-runtime, babel-preset-env
  • #15922 Improve output when wrapping functions (e.g. async functions) (@liuxingbaoyu)