equal

Deep comparison between two values to determine if they are equivalent

bundle size npm download

npm type definitions

🔖 Table of Contents

Features
Example
API
Supports
Usage
Contributing
Show your support
License

✨ Features

⚡ Multi runtime support (Deno, Node.js and Browsers)
📚 Pure TypeScript and provides type definition
:white_check_mark: Rambda's all test case is passed
:earth_americas: Universal module, providing ES modules and UMD
:package: Optimized, super slim size
📄 TSDoc-style comments

Package name

Deno: equal (deno.land, nest.land)

Node.js: lauqe (npm)

⚡ Example

equal('', '') // true
equal(NaN, NaN) // true
equal(0, 0) // true
equal(+0, 0) // true
equal(-0, 0) // true
equal(+0, -0) // true
equal(0n, 0n) // true
equal(undefined, undefined) // true
equal(null, null) // true
equal(undefined, null) // false
equal(true, false) // false
const symbol = Symbol("hello");
equal(symbol, symbol) // true
equal(Symbol('hello'), Symbol('hello')) // false

equal({}, {}) // true
equal({ "": undefined }, { "": undefined }) // true
equal({ "": undefined }, { "": undefined, a: 1 }) // false
equal({ a: 1, b: undefined}, { b: undefined, a: 1}) // true
equal([], []) // true
equal([[[]]], [[[]]]) // true
equal([[{ a: [] }]], [{ a: [] }]) // true
equal(new Date("2000/1/1"), new Date("2000/1/1")) // true
equal(new Date("2000/1/1"), new Date("2000/1/1 00:00:01")) // false
equal(() => true, () => true) // true
equal(() => true, () => false) // false
equal(Error('hoge'), Error('hoge')) // true
equal(Error('hoge'), Error('huga')) // false
equal(TypeError('hoge'), TypeError('hoge')) // true
equal(Error('hoge'), TypeError('hoge')) // false
equal(RangeError('error'), ReferenceError('error')) // false
equal(SyntaxError('error'), URIError('error')) // false
equal(/s/, /s/) // true
equal(/s/, /t/) // false
equal(/s/gi, /s/gi) // true
equal(/s/gi, /s/gim) // false
equal(new String('hello'), new String('hello')) // true
equal(new Number(0), new Number(0)) // true
equal(new Boolean(true), new Boolean(true)) // true
equal(new Map([[1, 2], [3, 4]]), new Map([[3, 4], [1, 2]]) // true
equal(new Map([[new Map(), { a: 1 } ]), new Map([[new Map(), { a: 1 } ]) // true
equal(new Set(), new Set()) // true
equal(new Set([[], {}, new Map(), new Set()]), new Set([[], {}, new Map(), new Set()])) // true

📝 API

Type definition

declare const equal: <T, U extends T>(a: T, b: U) => boolean

Parameter	Description
`a`	Any value
`b`	Any value

=> Return true if the reference memory is the same or the property members and their values are the same

Definition of Equality

Equality is defined as the data structure and property values are equivalent.

Same-value-zero

Numerical equivalence is based on Same-value-zero.
That is, all of the following comparisons are considered equivalent.

equal(NaN, NaN) // true
equal(0, 0) // true
equal(+0, 0) // true
equal(-0, 0) // true
equal(+0, -0) // true

Built-in objects

The following objects work correctly.

Array
Object
Date
Error ( EvalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError )
RegExp
Map
Set
String
Number
Boolean

Do not guarantee the behavior of objects not on this list.

💚 Supports

The TypeScript version must be 4.1.0 or higher.

This project provide ES modules and UMD. The range supported by both is different.

ES modules

Limit support to the latest environment to reduce the bundle size.

Deno	Node.js	Edge	Firefox	Chrome	Safari	iOS Safari	Samsung	Opera
^1.6.0	^14.16.0	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions

UMD

Browser is supporting since IE11.

Node.js	IE / Edge	Firefox	Chrome	Safari	iOS Safari	Samsung	Opera
^6.17.0	IE11 / ^16	^60	^61	^10.1	^10.3	^8.2	^48

Compared to ES modules, UMD has a bundle size increase of about 2.5x. Recommend using ES modules as much as possible.

💫 Usage

equal provides multi platform modules.

🦕 Deno

deno.land

import { equal } from "https://deno.land/x/equal/mod.ts";

equal([1, 2, 3], [1, 2, 3]); // true

nest.land

import { equal } from "https://x.nest.land/equal/mod.ts";

equal([1, ['hello', ['world']], [1, ['hello', ['world']]); // true

:package: Node.js

NPM package name is lauqe .

Install

npm i lauqe
or
yarn add lauqe

ES modules

import { equal } from "lauqe";

equal(new Date('2000/1/1'), new Date('2000/1/1')); // true

UMD

const { equal } = require("lauqe");

equal(/hello/g, /hello/g); // true

:globe_with_meridians: Browser

ES modules

<script type="module">
  import { equal } from "https://unpkg.com/lauqe?module";
  console.log(equal(() => {}, () => {}); // true
</script>

UMD

The global object is E.

<script src="https://unpkg.com/lauqe"></script>

<script>
  console.log(E.equal(NaN, NaN)); // true
</script>

:handshake: Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues.

Contributing guide

🌱 Show your support

Give a ⭐️ if this project helped you!

💡 License

Released under the MIT license