math-helper-functions

v3.2.0

Helper with misc. math functions such as sums, averages, max, min, etc For more information about how to use this package see README

Latest version published 17 days ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.2.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.2	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.3.0	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.4	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.2	\|	11/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (285)

GitHub Stars: 0
Forks: 1
Contributors: 3

Direct Usage Popularity

The npm package math-helper-functions receives a total of 285 downloads a week. As such, we scored math-helper-functions popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package math-helper-functions, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like math-helper-functions is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 17 days ago
Last Commit: 17 days ago

Further analysis of the maintenance status of math-helper-functions based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that math-helper-functions demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 3 Direct
Versions: 36
Install Size: 66.5 kB
Dist-tags: 1
# of Files: 15
Maintainers: 1
TS Typings: Yes

math-helper-functions has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

math-helper-functions

Installation

Using npm, npm i math-helper-functions.

Using yarn, yarn add math-helper-functions.

Usage

Using import

import { calcSum } from 'math-helper-functions';

const input = [
  { item: 'bookA', count: 3 },
  { item: 'bookB', count: 4 },
];

const totalBooks = calcSum(input, 'count'); // totalBooks is 7

In a CommonJS environment

const { calcDomain } = require('math-helper-functions');

const input = [
  { item: 'bookA', count: 3 },
  { item: 'bookB', count: 10 },
  { item: 'bookC', count: 1 },
];

const domain = calcDomain(input, 'count'); // domain is [1, 10]

Functions

calcBuckets

▸ calcBuckets(array, strict?, numOfBins?): IBucket[]

Calculate the buckets given a data array and an amount

Parameters

Name	Type	Default value	Description
`array`	`number`[]	`undefined`	The data array
`strict?`	`boolean`	`false`	Whether to use real or pretty domain
`numOfBins?`	`number`	`undefined`	Amount of desired buckets

Returns

IBucket[]

The buckets

Export

Defined in

modules/distributions.ts:58

calcDiff

▸ calcDiff(array, property?): number

Gets the absolute difference between the max and min value in an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

number

Absolute difference between the max and min of an array

Export

Defined in

modules/domain.ts:48

calcDistribution

▸ calcDistribution(array, strict?, numOfBins?): IDistribution

Calculates the distribution of an arrays values

Parameters

Name	Type	Default value	Description
`array`	`number`[]	`undefined`	Input array
`strict`	`boolean`	`false`
`numOfBins?`	`number`	`undefined`	Number of bins to use

Returns

IDistribution

The distribution

Export

Defined in

modules/distributions.ts:105

calcDistributionAsArray

▸ calcDistributionAsArray(array, binsStrict?, numOfBins?): IDistributionArrayItem[]

Calculates the distribution of an arrays values and outputs an array

Parameters

Name	Type	Default value	Description
`array`	`number`[]	`undefined`	Array to calc distribution of
`binsStrict?`	`boolean`	`false`	If false, buckets may be rounded [floor, ceil]
`numOfBins?`	`number`	`undefined`	Number of bins to use

Returns

IDistributionArrayItem[]

The distribution as an array of objects

Export

Defined in

modules/distributions.ts:196

calcDistributionWithSeries

▸ calcDistributionWithSeries(buckets, dataGrouped, distributionProp): ISerieDistribution

Calculates the distribution of an array of grouped objects

Parameters

Name	Type
`buckets`	`IBucket`[]
`dataGrouped`	`Record`<`string`, `unknown`[]>
`distributionProp`	`string`

Returns

ISerieDistribution

The distribution with labels and data

Export

Defined in

modules/distributions.ts:140

calcDomain

▸ calcDomain(array, property?): [number, number] | [any, any]

Gets the [min, max] value in an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

[number, number] | [any, any]

The domain

Export

Defined in

modules/domain.ts:36

calcHistogram

▸ calcHistogram(array, numberOfBins?, property?): number[]

Calculates a histogram from array values

Parameters

Name	Type	Default value	Description
`array`	`any`[]	`undefined`	Input array
`numberOfBins?`	`number`	`4`	Number of bins to use
`property?`	`string`	`undefined`	Property to map by

Returns

number[]

The histogram

Export

Defined in

modules/distributions.ts:251

calcMax

▸ calcMax(array, property?): number

Gets the max value in an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

number

The maximum value in the array

Export

Defined in

modules/domain.ts:12

calcMean

▸ calcMean(array, property?): number | undefined

Gets the mean value for an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

number | undefined

The mean value

Export

Defined in

modules/averages.ts:100

calcMedian

▸ calcMedian(array, property?): number | undefined

Gets an array median

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	The property to map by

Returns

number | undefined

The resulting median

Export

Defined in

modules/averages.ts:16

calcMin

▸ calcMin(array, property?): number

Gets the min value in an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map

Returns

number

The minimum value in the array

Export

Defined in

modules/domain.ts:24

calcPercent

▸ calcPercent(toCalc, total): number

Calculates the percentage of a value, given a total

Parameters

Name	Type	Description
`toCalc`	`number`	Number to get percentage of
`total`	`number`	Total

Returns

number

Percentage of the total

Export

Defined in

modules/percentages.ts:22

calcQuartiles

▸ calcQuartiles(array, property?): [number, number, number]

Gets the quartiles of an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

[number, number, number]

The quartiles

Export

Defined in

modules/distributions.ts:227

calcStdDeviation

▸ calcStdDeviation<T>(array, property?): number | undefined

Calculates the standard deviation in an array of numbers

Type parameters

Name
`T`

Parameters

Name	Type
`array`	`T`[]
`property?`	`string`

Returns

number | undefined

Export

Defined in

modules/averages.ts:155

calcSum

▸ calcSum(array, property?): number

Gets the sum of the values in an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`property?`	`string`	Property to map by

Returns

number

The sum

Export

Defined in

modules/operations.ts:12

calcVariance

▸ calcVariance<T>(array, property?): number | undefined

Calculates the variance in an array of numbers

Type parameters

Name
`T`

Parameters

Name	Type
`array`	`T`[]
`property?`	`string`

Returns

number | undefined

Export

Defined in

modules/averages.ts:142

calcWeightedMean

▸ calcWeightedMean(array, valueProperty, weightProperty): number

Gets the weighted mean for an array

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`valueProperty`	`string`	Property to use for value
`weightProperty`	`string`	Property to use for weight

Returns

number

The weighted mean

Export

Defined in

modules/averages.ts:113

calcWeightedMedian

▸ calcWeightedMedian(array, valueProperty, weightProperty): number

Gets an array weighted median

Parameters

Name	Type	Description
`array`	`any`[]	Input array
`valueProperty`	`string`	The property to use as value
`weightProperty`	`string`	The property to use as weight

Returns

number

The resulting median

Export

Defined in

modules/averages.ts:45

getMinMaxFromBucket

▸ getMinMaxFromBucket(bucketLabel): number[]

Gets the min and max values for a calcDistribution bucket

Parameters

Name	Type	Description
`bucketLabel`	`string`	The bucket label

Returns

number[]

[min, max]

Export

Defined in

modules/distributions.ts:125

getPercentile

▸ getPercentile(array, percentile): number | undefined

Gets the percentile of an array of values

Parameters

Name	Type	Description
`array`	(`null` \| `number`)[]	Array to find percentile of
`percentile`	`number`	Amount between 0 and 1

Returns

number | undefined

Percentile

Defined in

modules/percentiles.ts:11

ruleOfThree

▸ ruleOfThree(ifThis, isThis, thenThat): number

Performs a simple rule of three

Parameters

Name	Type	Description
`ifThis`	`number`	First param
`isThis`	`number`	First result
`thenThat`	`number`	Second param

Returns

number

Second result

Export

Defined in

modules/percentages.ts:10

math-helper-functions dependencies

d3-array dlv number-helper-functions

math-helper-functions development dependencies

@types/d3-array @types/dlv @typescript-eslint/eslint-plugin @typescript-eslint/parser coveralls eslint eslint-config-airbnb-base eslint-config-airbnb-typescript eslint-plugin-import tsup typedoc typedoc-plugin-markdown typescript vitest

FAQs

What is math-helper-functions?

Helper with misc. math functions such as sums, averages, max, min, etc. Visit Snyk Advisor to see a full health score report for math-helper-functions, including popularity, security, maintenance & community analysis.

Is math-helper-functions popular?

The npm package math-helper-functions receives a total of 285 weekly downloads. As such, math-helper-functions popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is math-helper-functions well maintained?

We found that math-helper-functions demonstrated a healthy version release cadence and project activity. It has a community of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is math-helper-functions safe to use?

The npm package math-helper-functions was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 November-2024, at 07:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (285)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

math-helper-functions

Installation

Usage

Table of contents

Functions

Functions

calcBuckets

Parameters

Returns

Defined in

calcDiff

Parameters

Returns

Defined in

calcDistribution

Parameters

Returns

Defined in

calcDistributionAsArray

Parameters

Returns

Defined in

calcDistributionWithSeries

Parameters

Returns

Defined in

calcDomain

Parameters

Returns

Defined in

calcHistogram

Parameters

Returns

Defined in

calcMax

Parameters

Returns

Defined in

calcMean

Parameters

Returns

Defined in

calcMedian

Parameters

Returns

Defined in

calcMin

Parameters

Returns

Defined in

calcPercent

Parameters

Returns

Defined in

calcQuartiles

Parameters

Returns

Defined in

calcStdDeviation

Type parameters

Parameters

Returns

Defined in

calcSum

Parameters

Returns

Defined in

calcVariance