ambush

Overview

Links: Website | Package

Ambush is a minimal library that streamlines and brings plenty of handy utility features to simplify your projects. Ambush is an acronym for which provides Advanced Multi-purpose Benchmark Utility Set Helpers for your code.

In comparison to alternatives such as Lodash and Underscore.js, Ambush prioritizes performance and is tailored to enhance your development experience while keeping things lean and efficient. Ambush also has miscellaneous functions which supports multiple data types.

Get started with Ambush by setting up the environment.

Installation

You will need Node.js 14.0.0 or newer before installing by your preferred package manager (npm, yarn, or pnpm).

Usage

You can import or require() this package by the name of your choice (preferably ab), or object destructure a specific module:

const ab = require('ambush');
import ab from 'ambush';

Now, you can start implementing Ambush in your code! See all the available functions and the full documentation here.

---

Here's a quick example merging two arrays together.

const arr1 = [4, 2, 1];
const arr2 = [2, 1, 3];

ab.merge(arr1, arr2);
// => [4, 2, 1, 2, 1, 3]

You can see that the outputArr array has duplicates in it. Let's try removing duplicates and sorting the array alphabetically:

ab.deduplicate(outputArr);
// => [4, 2, 1, 3]

ab.sort(outputArr);
// => [1, 2, 3, 4]

---

Check out @ambush/image for image processing functions.

We welcome contributions from the community to improve and enhance this project. Whether you're a developer, designer, tester, or have ideas to share, your help is valuable. If you're willing to contribute and get involved, please see the contributing guide file for more details.

We adhere to the Code of Conduct to ensure a respectful and inclusive community. Please review it and follow the guidelines when participating in this project.

If you have any problems, issues or questions please email us at [e-mail]

License

This project is licensed under the Apache License 2.0.

Copyright © 2023 Ambush, Inc.