CSSNumericValue: equals() method

{{APIRef("CSS Typed OM")}}

The equals() method of the {{domxref("CSSNumericValue")}} interface returns a boolean indicating whether the passed value are strictly equal. To return a value of true, all passed values must be of the same type and value and must be in the same order. This allows structural equality to be tested quickly.

Syntax

equals(number)

Parameters

• number
  • : Either a number or a {{domxref('CSSNumericValue')}}.

Return value

A boolean value.

Exceptions

None.

Examples

As stated earlier, all passed values must be of the same type and value and must be in the same order. Some of the following examples illustrate what happens when they are not.

let cssMathSum = new CSSMathSum(CSS.px(1), CSS.px(2));
let matchingCssMathSum = new CSSMathSum(CSS.px(1), CSS.px(2));
// Prints true
console.log(cssMathSum.equals(matchingCssMathSum));

let otherCssMathSum = CSSMathSum(CSS.px(2), CSS.px(1));
// Prints false
console.log(cssMathSum.equals(otherCssMathSum));

// Also prints false
console.log(CSS.cm("1").equal(CSS.in("0.393701")));

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}