@gilbarbara/deep-equal/README.md

Tiny deep equal comparator

# @gilbarbara/deep-equal

[![npm version](https://badge.fury.io/js/%40gilbarbara%2Fdeep-equal.svg)](https://badge.fury.io/js/%40gilbarbara%2Fdeep-equal) [![CI](https://github.com/gilbarbara/deep-equal/actions/workflows/main.yml/badge.svg)](https://github.com/gilbarbara/deep-equal/actions/workflows/main.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_deep-equal&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gilbarbara_deep-equal)

Lightweight deep equal comparator.

## Features
- Written in TypeScript
- ESM ready
- Works with Map, Set, and Typed Arrays
- Works with React component (avoid circular references)

## Usage

```shell
npm i @gilbarbara/deep-equal
```

```typescript
import equal from '@gilbarbara/deep-equal';

equal({ a: 1 }, { a: 1 }); // true

```

## Credits

Inspired by [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal) package. Thanks! ❤️

## License

MIT