Skip to content

Docs: Add QUnit.equiv() extension documentation#1833

Open
xxiaoxiong wants to merge 1 commit into
qunitjs:mainfrom
xxiaoxiong:main
Open

Docs: Add QUnit.equiv() extension documentation#1833
xxiaoxiong wants to merge 1 commit into
qunitjs:mainfrom
xxiaoxiong:main

Conversation

@xxiaoxiong
Copy link
Copy Markdown

Closes #1778

QUnit.equiv() has been available since QUnit 1.0.0 as the underlying engine for assert.deepEqual(), but was never officially documented in the extension interface.

This adds:

  • docs/api/extension/QUnit.equiv.md — Complete documentation covering:
    • All supported types (primitives, boxed primitives, objects, arrays, Date, RegExp, Set, Map, functions, circular references)
    • Multiple argument comparison behavior
    • Usage examples including integration with assert.deepEqual()

The documentation follows the same structure and style as existing extension docs like QUnit.stack.md and QUnit.dump.parse.md.

Closes qunitjs#1778.

QUnit.equiv() has been a public API since QUnit 1.0.0 as the
underlying engine for assert.deepEqual(), but was never
documented. This adds proper documentation covering all
supported types and edge cases.
@linux-foundation-easycla
Copy link
Copy Markdown

CLA Not Signed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Document QUnit.equiv()

1 participant