# algoose

> A Collection of Algorithms

Latest version **1.0.4** (published 2019-10-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2019-10-19 |
| First published | 2019-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 35.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sagnik Pradhan |
| Maintainers | markten6321 |

## Links

- npm: https://www.npmjs.com/package/algoose
- npm.io page: https://npm.io/package/algoose

## Recent versions

- 1.0.4 (latest) — 2019-10-19
- 1.0.3 — 2019-10-17
- 1.0.2 — 2019-10-14
- 1.0.1 — 2019-10-14
- 1.0.0 — 2019-10-14

## README

# Algoose

 A collection of Algorithms 🦆

 [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)
 [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
 ![Tests](https://github.com/SagnikPradhan/algoose/workflows/Tests/badge.svg)
 ![Lint Tests](https://github.com/SagnikPradhan/algoose/workflows/ES%20Lint/badge.svg)
 [![TypeScript](https://badges.frapsoft.com/typescript/love/typescript.png?v=101)](https://github.com/ellerbrock/typescript-badges/)

**NOTE:** This library is still in its development, so there might be some breaking changes!

## Algorithms

- [Search Algorithms](https://sagnikpradhan.github.io/algoose/modules/_lib_search_.html)
  - [Linear Search](https://sagnikpradhan.github.io/algoose/modules/_lib_search_.html#linearsearch)
  - [Binary Search](https://sagnikpradhan.github.io/algoose/modules/_lib_search_.html#binarysearch)
  - [Jump Search](https://sagnikpradhan.github.io/algoose/modules/_lib_search_.html#jumpsearch)

## Installation and Usage

1. Add Algoose to your Project

    ```bash
    yarn add algoose
    # or
    npm install algoose
    ```

2. Create `index.js` and Add the following to `index.js`

    ```js
    const {binarySearch} = require('algoose');
    const result = binarySearch([0, 2, 3, 5, 7, 8], 5);
    console.log(result)
    // Output: 4
    ```

## Contribute

1. Fork on Github and Clone the repository

    ```bash
    git clone https://github.com/YourProfileName/algoose.git
    ```

2. Install Dev Dependencies

    ``` bash
    yarn install
    # or
    npm install
    ```

3. Make changes

4. Run tests

    ```bash
    yarn run tests
    ```

5. Pull Request

## Contributors

- [Sagnik Pradhan](https://github.com/SagnikPradhan)

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