1.0.0 • Published 1 year ago

@ssmidge/nodejs-extensions v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

nodejs-extensions

Utility Prototype Extensions for Nodejs Classes and Types

Features

✔️ Only adds Extensions, if not existing yet. ✔️ Types ✔️ Fast - uses quickest functions for nodejs check how we determined ✔️ Optional Function to extend Prototypes

Why not lodash or underscore?

This package is not ment to replace lodash, nor underscore, indeed, it uses lodash too!

  • It is ment to implement more use-case specific, readable utility functions.

Import it

Typescript and ESM:

import _Utils from "nodejs-extensions";

Common-JS way:

const _Utils = require("nodejs-extensions");

Extend prototype to make your work easier!

import _Utils from "nodejs-extensions";

_Utils.ExtendPrototypes({
    improveForEach: false, //if true, then it will use _Utils.loopOver instead of Array.forEach and overwride it 
});
// then you can do stuff like:

const summed = [1, 2, 3, "a"].sumNumbersOnly();

const cleared = ["a", "a", "b"].removeDuplicates();

Don't wanna extned the prototypes?

Then import "nodejs-extensions/safe" to not overwride the prototypes

import _Utils from "nodejs-extensions/safe";

const summed = _Utils.removeDuplicates(["a", "a", "b"]);

const cleared = _Utils.sumNumbersOnly([1, 2, 3]);

Function-Methods List

If you use it without the Array extension, aka by _Utils.function(), then always add the input (array, object, etc.) upfront!

  • e.g: _Util.shuffle([1, 2, 3, 4, 5, 6]);
  • e.g: _Util.chunks(["a", "b", "c", "d", "e"], 2);

Arrays

Jump to the Arrays overview

Array-Methods

Array-shuffle

Creates a new mixed up (shuffled) array.

  • @Returns
    • (Array): Returns the new mixed array
const shuffled = [1, 2, 3].shuffle();
console.log(shuffled); // [3, 1, 2]