https://github.com/kevindmorris/matician

Shorthand for a specialist or expert in mathematics.
https://github.com/kevindmorris/matician

babel javascript jest tsup typescript

Last synced: 26 days ago
JSON representation

Shorthand for a specialist or expert in mathematics.

• Host: GitHub
• URL: https://github.com/kevindmorris/matician
• Owner: kevindmorris
• License: mit
• Created: 2024-05-16T21:45:34.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-05-18T12:37:57.000Z (6 months ago)
• Last Synced: 2024-05-22T06:05:11.039Z (6 months ago)
• Topics: babel, javascript, jest, tsup, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/matician
• Size: 74.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


**[Matician](https://kevindmorris.github.io/matician/): (/məˈtiSH(ə)n/) Shorthand for a specialist or expert in mathematics.**



A modern JavaScript utility library for arithmetic, mathematics, proability, statistics, and more.





[![npm version](https://img.shields.io/npm/v/matician.svg?label=version)](https://www.npmjs.com/package/matician)

[![npm downloads](https://img.shields.io/npm/dm/matician.svg)](https://www.npmjs.com/package/matician)

[![package license](https://img.shields.io/npm/l/matician.svg)](https://www.npmjs.com/package/matician)





📋[Docs](https://kevindmorris.github.io/matician/) | 🧪[GitHub](https://github.com/kevindmorris/matician) | 📦[Package](https://www.npmjs.com/package/matician)





# Table of Contents

- [Getting Started](#getting-started)

- [Usage](#usage)

- [Run the Test Suite](#run-the-test-suite)

- [Why Matician?](#why-matician)

- [Contributors](#contributors)

- [Author](#author)

# Getting Started

Use your preferred package manager:

```

npm install matician

yarn add matician

```

# Usage

With CommonJS,

```js

const { add } = require("matician");

const sum = add(1, 2);

console.log(sum);

// => 3

```

With ES modules,

```js

import { add } from "matician";

const sum = add(1, 2);

console.log(sum);

// => 3

```

# Run the Test Suite

```bash

git clone https://github.com/kevindmorris/matician.git

npm install

npm test # Run the entire test suite

npm test -- add.test.ts # Run an individual test suite

```

# Why Matician?

Matician takes the hassle out of writing custom JavaScript functions for mathematical, statistical, and probabilistic methods.

# Contributors

Open an [issue](https://github.com/kevindmorris/matician/issues) to address bugs or suggest new modules!

# Author

Kevin Morris