Simple Math Operations

A lightweight and easy-to-use npm module for performing basic arithmetic operations like addition, subtraction, multiplication, and division. Perfect for beginners and developers who need a simple utility for basic math operations.

Table of Contents

• Installation
• Usage
• API Documentation
  • add(a, b)
  • subtract(a, b)
  • multiply(a, b)
  • divide(a, b)
• Examples
  • Basic Usage
  • Chaining Operations
  • Error Handling
• Contributing
• License
• Support
• Author

Installation

You can install the module using npm or yarn:

Using npm

npm install simple-math-operations

Using yarn

yarn add simple-math-operations

Usage

The module provides four basic arithmetic operations:

1. Addition
2. Subtraction
3. Multiplication
4. Division

Here’s how you can use it in your project:

const mathOps = require('simple-math-operations');

// Addition
console.log(mathOps.add(5, 3)); // Output: 8

// Subtraction
console.log(mathOps.subtract(5, 3)); // Output: 2

// Multiplication
console.log(mathOps.multiply(5, 3)); // Output: 15

// Division
console.log(mathOps.divide(5, 3)); // Output: 1.666...
console.log(mathOps.divide(5, 0)); // Output: Cannot divide by zero

API Documentation

add(a, b)

• Description: Adds two numbers a and b.
• Parameters:
  • a (Number): The first number.
  • b (Number): The second number.
• Returns: The sum of a and b.

subtract(a, b)

• Description: Subtracts b from a.
• Parameters:
  • a (Number): The first number.
  • b (Number): The second number.
• Returns: The difference between a and b.

multiply(a, b)

• Description: Multiplies two numbers a and b.
• Parameters:
  • a (Number): The first number.
  • b (Number): The second number.
• Returns: The product of a and b.

divide(a, b)

• Description: Divides a by b.
• Parameters:
  • a (Number): The numerator.
  • b (Number): The denominator.
• Returns: The quotient of a divided by b.
• Note: If b is 0, it returns "Cannot divide by zero".

Examples

Basic Usage

Here’s a simple example demonstrating how to use the module:

const mathOps = require('simple-math-operations');

const num1 = 10;
const num2 = 5;

console.log(`Addition: ${mathOps.add(num1, num2)}`); // Output: 15
console.log(`Subtraction: ${mathOps.subtract(num1, num2)}`); // Output: 5
console.log(`Multiplication: ${mathOps.multiply(num1, num2)}`); // Output: 50
console.log(`Division: ${mathOps.divide(num1, num2)}`); // Output: 2

Chaining Operations

You can chain multiple operations together for more complex calculations:

const mathOps = require('simple-math-operations');

const result = mathOps.add(
  mathOps.multiply(2, 3),
  mathOps.divide(10, 2)
);

console.log(`Result: ${result}`); // Output: 11

Error Handling

The divide function handles division by zero gracefully:

const mathOps = require('simple-math-operations');

const result = mathOps.divide(10, 0);
console.log(result); // Output: Cannot divide by zero

Contributing

Contributions are welcome! If you’d like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and write tests if applicable.
4. Submit a pull request.

For major changes, please open an issue first to discuss what you’d like to change.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you find this module useful, please consider giving it a ⭐️ on GitHub or supporting the author.

Author

👤 Your Name

• GitHub: @lakshay-goyal
• Email: [email protected]