@wixc3/mostly-equal on Github

Home > @wixc3/mostly-equal

mostly-equal package

Adds chai matches for partial equality of JSONs

Example

import chai, { expect } from 'chai';
import { mostlyEqlChaiPlugin, notImportant } from '@wixc3/mostly-equal';
chai.use(mostlyEqlChaiPlugin);
expect({ a: 1 }).to.mostlyEqual({
  a: 1,
  b: notImportant,
});

Functions

| Function | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | allowMarkersInFactory(f) | | | checkExpectValues(input, formatters) | | | clearMatchedValues(subMatcher) | | | defineSame(name, skipUndefined) | Creates a symbol for usage in mostlyEqual, Comparing the resulting value in any place it is used as the value | | defineUnique(name, skipUndefined) | Creates a symbol for usage in expect.mostlyEqual, Comparing the resulting value in any place it is used as the value | | equal(value, thumbsUpOnSuccess) | Strict equality of a field | | errorString(expected, actual, maxDepth, formatters, depth, path, passedMap, passedSet) | | | expectValue(expectMethod) | Used for adding field matchers to mostlyEqual Creates a symbol used for field matching | | expectValues(expectMethod, allowUndefined) | Similar to expectValue(), but called for all the matches at once. This way a matcher can compare different values defineUnique() | | getMatchedValues(expectValues) | | | HTMLFormatter(Element) | | | isExpectVal(val) | | | isExpectValues(val) | | | isGetter(target, key) | | | isPlainObj(value) | | | printPath(p) | | | registerChildSet(target, path, passedMap, passedSet) | | | safePrint(target, maxDepth, formatters, depth, passedMap, passedSet, path) | | | setGlobalOptions(maxDepth, formatters) | | | setSuiteOptions(before, after, options) | | | spaces(indent) | |

Interfaces

| Interface | Description | | ----------------------------------------------------------------------------------------------- | ----------- | | ExpectValue | | | ExpectValues | | | ExpectValuesInfo | | | Formatter | | | MostlyEqualOptions | | | PseudoElement | |

Variables

| Variable | Description | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | defined | Field must be defined (null is considered define) | | expectValuesSymb | | | expectValueSymb | | | mostlyEqlChaiPlugin | | | notImportant | | | thumbsUp | |

Type Aliases

| Type Alias | Description | | ----------------------------------------------------------------------------------------------------------- | ----------- | | AllowMarkers | | | AllowMarkersObj | | | ErrorOrText | | | ErrorOrTextOrExpect | | | ExpandedValues | | | ExpectMultiMatcher | | | ExpectSingleMatcher | | | LookupPath | | | MarkerSymbol | | | PseudoElementConstructor | | | UnknownObjectRecord | |