Skip to content

Latest commit

 

History

History
237 lines (158 loc) · 7.09 KB

README.md

File metadata and controls

237 lines (158 loc) · 7.09 KB
Raw

bignumber-arr-utils

A lightweight utility library designed for efficient manipulation and calculation of large numbers within arrays. Perfect for financial, scientific, and blockchain-related projects, this package provides a set of functions that handle operations on arrays of big numbers with precision and ease.


Install

npm i bignumber-arr-utils

Usage

To get started, import the BigNumberArrUtils class from the package:

import BigNumber from 'bignumber.js';
import { BigNumberArrUtils } from 'bignumber-arr-utils';

Example Usage

Creating an Instance

Creates an instance of BigNumberArrUtils and initializes the array with valid BigNumber instances.

  • Parameters:
    • ...n - A list of values to be converted to BigNumber and added to the array.
const arr = new BigNumberArrUtils(1, '2', new BigNumber(3));

Getting the items on the array

Returns the list of BigNumber instances in the array.

const arr = new BigNumberArrUtils(1, '2', new BigNumber(3));
console.log(arr.items); // [BigNumber(1), BigNumber(2), BigNumber(3)]

Adding Items

Adds a new BigNumber instance to the array. Returns false if the given input is not a valid BigNumber.Value. Returns true if the new BigNumber instance has been added to the array.

  • Parameters:
    • n - The value to be added as a BigNumber.
const arr = new BigNumberArrUtils();
console.log(arr.add(-0.8)); // true
console.log(arr.add('abc')); // false
console.log(arr.add(3e18)); // true
console.log(arr.items); // [BigNumber(-0.8), BigNumber(3e+18)]

Removing Items

Removes an instance of BigNumber from the array. Returns false if the given input is not found in the array. Returns true if the BigNumber has been removed from the array.

  • Parameters:
    • n - The value to be removed from the array.
const arr = new BigNumberArrUtils(-0.8, 3e18, 1.0000000000000001);
console.log(arr.remove(-1)); // false
console.log(arr.remove(3e18)); // true
console.log(arr.items); // [BigNumber(-0.8), BigNumber(1.0000000000000001)]

Calculating the Sum

Returns the sum of all BigNumber instances in the array.

const arr = new BigNumberArrUtils(-0.8, 3e18, 1.0000000000000001);
console.log(arr.sum().toString()); // "3000000000000000001.2"

Determining the Min

Returns the minimum of all BigNumber instances in the array.

const arr = new BigNumberArrUtils(-0.8, 3e18, 1.0000000000000001);
console.log(arr.min().toString()); // "-0.8"

Determining the Max

Returns the maximum of all BigNumber instances in the array.

const arr = new BigNumberArrUtils(-0.8, 3e18, 1.0000000000000001);
console.log(arr.max().toString()); // "3e18"

Checking for an Item in the Array

The includes method checks if a specific BigNumber value is present in the array. It returns true if the value is found, and false otherwise.

  • Parameters:

    • n - The value to check for in the array.

  • Returns:

    • boolean - true if the array contains the specified value; otherwise, false.
const arr = new BigNumberArrUtils(-0.8, 3e18, 1.0000000000000001, 5);
console.log(arr.includes(5)); // true
console.log(arr.includes(new BigNumber(6))); // false
console.log(arr.includes('3e18')); // true
console.log(arr.includes(1.1)); // false

Calculating the product of all Items in the Array

Calculates and returns the product of all BigNumber instances in the array.

const arr = new BigNumberArrUtils('1e+18', '2e+18', '3e+18');
console.log(arr.product().toString()); // "6e+54"

Calculating the average of all Items in the Array

Calculates and returns the average of all BigNumber instances in the array.

const arr = new BigNumberArrUtils(2, 4, 6, 8);
console.log(arr.mean().toString()); // "5"

Filtering for values greater than a given BigNumber

Returns a new array that includes only BigNumber instances greater than the given value.

  • Parameters:

    • n - The value to check against in the array.
const arr = new BigNumberArrUtils(-10, 0.5, 3.5, 10.1);
console.log(arr.isGreaterThan(0)); // [BigNumber(0.5), BigNumber(3.5), BigNumber(10.1)]
console.log(arr.isGreaterThan(new BigNumber(3.5))); // [BigNumber(10.1)]

Filtering for values greater than or equal to a given BigNumber

Returns a new array that includes only BigNumber instances greater than or equal to the given value.

  • Parameters:

    • n - The value to check against in the array.
const arr = new BigNumberArrUtils(-10, 0.5, 3.5, 10.1);
console.log(arr.isGreaterThanOrEqualTo(0)); // [BigNumber(0.5), BigNumber(3.5), BigNumber(10.1)]
console.log(arr.isGreaterThanOrEqualTo(new BigNumber(0.5))); // [BigNumber(0.5), BigNumber(3.5), BigNumber(10.1)]
console.log(arr.isGreaterThanOrEqualTo('10.1')); // [BigNumber(10.1)]

Filtering for values less than a given BigNumber

Returns a new array that includes only BigNumber instances less than the given value.

  • Parameters:

    • n - The value to check against in the array.
const arr = new BigNumberArrUtils(1, 5, 8, 12);
console.log(arr.isLessThan(6)); // [BigNumber(1), BigNumber(5)]
console.log(arr.isLessThan(12)); // [BigNumber(1), BigNumber(5), BigNumber(8)]

Filtering for values less than or equal to a given BigNumber

Returns a new array that includes only BigNumber instances less than or equal to the given value.

  • Parameters:

    • n - The value to check against in the array.
const arr = new BigNumberArrUtils(1, -7, 8, 12);
console.log(arr.isLessThanOrEqualTo(0)); // [BigNumber(-7)]
console.log(arr.isLessThanOrEqualTo(8)); // [BigNumber(1), BigNumber(-7), BigNumber(8)]

Returning Unique BigNumber Values

Returns an array of unique BigNumber values, removing any duplicates.

const arr = new BigNumberArrUtils(1, 2, 2, 3, 4, 4, 4, 5);
console.log(arr.unique()); // [BigNumber(1), BigNumber(2), BigNumber(3), BigNumber(4), BigNumber(5)]

Calculating Cumulative Sum of all Items in the Array

Calculates the cumulative sum of BigNumber instances in the array.

const arr = new BigNumberArrUtils(1, 2, 3);
console.log(arr.cumulativeSum().map(n => n.toString())); // ["1", "3", "6"]

Calculating the median of all Items in the Array

Calculates and returns the median of all BigNumber instances in the array.

const arr = new BigNumberArrUtils(2, 4, 6, 8);
console.log(arr.median().toString()); // "5"

Contributing

If you want to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

Licence

The MIT Licence.

See LICENCE.