GithubHelp home page GithubHelp logo

geometry-shaper's Introduction

Shape Library

Welcome to the Geometry Calculator Shape Library! This library provides classes for different geometric shapes, including Rectangle, Circle, and Triangle. These classes allow you to perform various calculations and retrieve information about the shapes.

Link to library on npm: https://www.npmjs.com/package/geometry-shaper

Table of contents

  1. Installation
  2. Usage
  3. Rectangle
  4. Circle

Installation

To use the library in your project, you can install it using npm:

npm i geometry-shaper

Usage

Rectangle

The Rectangle class represents a rectangle with a specified width and height.

Methods: constructor(width: number, height: number): Initializes a new Rectangle instance with the given width and height.

getArea(): number: Calculates the area of the rectangle.

getPerimeter(): number: Calculates the perimeter of the rectangle.

getDiagonal(): number: Calculates the diagonal length of the rectangle.

getAllData(): rectangleData: Retrieves all data about the rectangle, including width, height, area, perimeter, and diagonal.

import { Rectangle } from 'shapes-library';

const rectangle = new Rectangle(10, 5); const area = rectangle.getArea(); // 50 const perimeter = rectangle.getPerimeter(); // 30 const diagonal = rectangle.getDiagonal(); const allData = rectangle.getAllData(); // {area: 50, perimeter:...}

Circle

The Circle class represents a circle with a specified radius.

Methods: constructor(radius: number): Initializes a new Circle instance with the given radius.

getDiameter(): number: Calculates the diameter of the circle.

getArea(): number: Calculates the area of the circle.

getCircumference(): number: Calculates the circumference (perimeter) of the circle.

getAllData(): circleDataWithExtras: Retrieves all data about the circle, including radius, diameter, area, and circumference.

import { Circle } from 'shapes-library';

const circle = new Circle(5); const area = circle.getArea(); const allData = circle.getAllData();

Triangle

The Triangle class represents a triangle with a specified base and height.

Methods: constructor(base: number, height: number): Initializes a new Triangle instance with the given base and height.

getArea(): number: Calculates the area of the triangle.

getAllData(): triangleData: Retrieves all data about the triangle, including base, height, and area.

import { Triangle } from 'shapes-library';

const triangle = new Triangle(8, 6); // 24 const area = triangle.getArea(); const allData = triangle.getAllData();

geometry-shaper's People

Contributors

harmonyhusher avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.