# ss-comparator

> [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php) [![npm version](https://badge.fury.io/js/ss-comparator.svg)](https://badge.fury.io/js/ss-comparator)

Latest version **1.0.1** (published 2018-10-24) · 0 weekly downloads

## Install

```sh
npm install ss-comparator
pnpm add ss-comparator
yarn add ss-comparator
bun add ss-comparator
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-10-24 |
| First published | 2018-10-22 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | boycgit |
| Maintainers | jscon |

## Links

- npm: https://www.npmjs.com/package/ss-comparator
- Repository: https://github.com/boycgit/ss-comparator
- Homepage: https://github.com/boycgit/ss-comparator#readme
- Issues: https://github.com/boycgit/ss-comparator/issues
- npm.io page: https://npm.io/package/ss-comparator

## Dependencies (1)

- [ss-linked-list](https://npm.io/package/ss-linked-list.md) ^1.1.2

## Recent versions

- 1.0.1 (latest) — 2018-10-24
- 1.0.0 — 2018-10-22

## README

# ss-comparator

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php) [![npm version](https://badge.fury.io/js/ss-comparator.svg)](https://badge.fury.io/js/ss-comparator)

General Comparator 

 - written in Typescript
 - migrated from [javascript-algorithms/Comparator.js](https://github.com/trekhleb/javascript-algorithms/blob/master/src/utils/comparator/Comparator.js)
 - be required by Data-Structure Serial library, such as [ss-linked-list](https://github.com/boycgit/ss-linked-list)、[ss-heap](https://github.com/boycgit/ss-heap)、[ss-tree](https://github.com/boycgit/ss-tree) and so on;

## Installation

### Node.js / Browserify

```bash
npm install ss-comparator --save
```

```javascript
var Comparator = require('ss-comparator');
```

### Global object

Include the pre-built script.

```html
<script src="./dist/index.umd.min.js"></script>

```

## Build & test

```bash
npm run build
```

```bash
npm test
```

## document

```bash
npm run doc
```

then open the generated `out/index.html` file in your browser.

## License

[MIT](LICENSE).

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