# numcal

> Basic numeric calculation functions.

Latest version **4.0.0** (published 2018-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install numcal
pnpm add numcal
yarn add numcal
bun add numcal
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-08-14 |
| First published | 2015-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 27.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |

## Links

- npm: https://www.npmjs.com/package/numcal
- Repository: https://github.com/okunishinishi/node-numcal
- Homepage: https://github.com/okunishinishi/node-numcal#readme
- Issues: https://github.com/okunishinishi/node-numcal/issues
- npm.io page: https://npm.io/package/numcal

## Recent versions

- 4.0.0 (latest) — 2018-08-14
- 3.1.4 — 2016-07-27
- 3.1.3 — 2016-07-27
- 3.1.2 — 2016-07-18
- 3.1.1 — 2016-07-17
- 3.1.0 — 2016-07-02
- 3.0.0 — 2016-05-21
- 2.0.1 — 2016-01-17
- 2.0.0 — 2016-01-17
- 1.1.5 — 2015-10-05
- 1.1.4 — 2015-10-05
- 1.1.3 — 2015-09-19
- 1.1.2 — 2015-09-01
- 1.1.1 — 2015-09-01
- 1.1.0 — 2015-08-29
- … 1 more at https://npm.io/package/numcal/versions

## README

numcal
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-numcal
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-numcal
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-numcal.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-numcal
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-numcal.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-numcal/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-numcal
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-numcal.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-numcal.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-numcal
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-numcal.svg
[bd_npm_url]: http://www.npmjs.org/package/numcal
[bd_npm_shield_url]: http://img.shields.io/npm/v/numcal.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Basic numeric calculation functions.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
npm install numcal --save
```

<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
-----

```javascript
'use strict'

const numcal = require('numcal')

//------------------------
// min
//------------------------
console.log(numcal.min(3, 2, 4)) //-> 2
console.log(numcal.min([3, 2, 4])) //-> 2

//------------------------
// max
//------------------------
console.log(numcal.max(3, 2, 4)) //-> 4
console.log(numcal.max([3, 2, 4])) //-> 4

//------------------------
// sum
//------------------------
console.log(numcal.sum(3, 2, 4)) //-> 9
console.log(numcal.sum([3, 2, 4])) //-> 9

//------------------------
// ave
//------------------------
console.log(numcal.ave(3, 2, 4)) //-> 3
console.log(numcal.ave([3, 2, 4])) //-> 3


````


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.API.md.hbs" Start -->

<a name="section-doc-guides-03-a-p-i-md"></a>

API
---

| Signature | Description |
| --------- | ----------- |
| .min(val1, val2...) | Get minimum value. |
| .min([val1, val2...]) | Get minimum value in array. |
| .max(val1, val2...) | Get maximum value. |
| .max([val1, val2...]) | Get maximum value in array. |
| .sum(val1, val2...) | Get sum value. |
| .sum([val1, val2...]) | Get sum  value for array. |
| .ave(val1, val2...) | Get average value. |
| .ave([val1, val2...]) | Get average  value for array. |


<!-- Section from "doc/guides/03.API.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-numcal/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [chopcal][chopcal_url]
+ [veccal][veccal_url]
+ [rangecal][rangecal_url]

[chopcal_url]: https://github.com/okunishinishi/node-chopcal
[veccal_url]: https://github.com/okunishinishi/node-veccal
[rangecal_url]: https://github.com/okunishinishi/node-rangecal

<!-- Links End -->

---
_Source: https://npm.io/package/numcal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._