fast-equals 5.0.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +2 -1
  3. package/index.d.ts +4 -4
  4. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # fast-equals CHANGELOG
2
2
 
3
+ ## 5.0.1
4
+
5
+ ### Bugfixes
6
+
7
+ - Fix reference to `metaOverride` in typings and documentation (holdover from temporary API in v5 beta)
8
+
3
9
  ## 5.0.0
4
10
 
5
11
  ### Breaking changes
package/README.md CHANGED
@@ -310,7 +310,7 @@ function createCustomEqual<Meta>(options: {
310
310
  ) => boolean;
311
311
  createState?: () => { cache?: Cache; meta?: Meta };
312
312
  strict?: boolean;
313
- }): <A, B>(a: A, b: B, metaOverride?: Meta) => boolean;
313
+ }): <A, B>(a: A, b: B) => boolean;
314
314
  ```
315
315
 
316
316
  Create a custom equality comparator. This allows complete control over building a bespoke equality method, in case your use-case requires a higher degree of performance, legacy environment support, or any other non-standard usage. The [recipes](#recipes) provide examples of use in different use-cases, but if you have a specific goal in mind and would like assistance feel free to [file an issue](https://github.com/planttheidea/fast-equals/issues).
@@ -381,6 +381,7 @@ Testing mixed objects not equal...
381
381
  Caveats that impact the benchmark (and accuracy of comparison):
382
382
 
383
383
  - `Map`s, `Promise`s, and `Set`s were excluded from the benchmark entirely because no library other than `deep-eql` fully supported their comparison
384
+ - `fast-deep-equal`, `react-fast-compare` and `nano-equal` throw on objects with `null` as prototype (`Object.create(null)`)
384
385
  - `assert.deepStrictEqual` does not support `NaN` or `SameValueZero` equality for dates
385
386
  - `deep-eql` does not support `SameValueZero` equality for zero equality (positive and negative zero are not equal)
386
387
  - `deep-equal` does not support `NaN` and does not strictly compare object type, or date / regexp values, nor uses `SameValueZero` equality for dates
package/index.d.ts CHANGED
@@ -46,9 +46,9 @@ export declare const strictCircularShallowEqual: <A, B>(a: A, b: B) => boolean;
46
46
  *
47
47
  * This can be done to create very targeted comparisons in extreme hot-path scenarios
48
48
  * where the standard methods are not performant enough, but can also be used to provide
49
- * support for legacy environments that do not support expected features like
50
- * `RegExp.prototype.flags` out of the box.
49
+ * support for legacy environments that cannot polyfill for modern features expected by
50
+ * `fast-equals`, such as `WeakMap` or `RegExp.prototype.flags`.
51
51
  */
52
- export declare function createCustomEqual<Meta>(
52
+ export declare function createCustomEqual<Meta = undefined>(
53
53
  options?: CustomEqualCreatorOptions<Meta>,
54
- ): <A, B>(a: A, b: B, metaOverride?: Meta) => boolean;
54
+ ): <A, B>(a: A, b: B) => boolean;
package/package.json CHANGED
@@ -11,43 +11,43 @@
11
11
  "@rollup/plugin-replace": "^5.0.2",
12
12
  "@rollup/plugin-terser": "^0.4.0",
13
13
  "@rollup/plugin-typescript": "^11.0.0",
14
- "@types/jest": "^29.2.5",
14
+ "@types/jest": "^29.5.0",
15
15
  "@types/lodash": "^4.14.184",
16
- "@types/node": "^18.14.6",
16
+ "@types/node": "^18.15.3",
17
17
  "@types/ramda": "^0.28.23",
18
18
  "@types/react": "^18.0.28",
19
19
  "@types/react-dom": "^18.0.11",
20
- "@typescript-eslint/eslint-plugin": "^5.54.0",
21
- "@typescript-eslint/parser": "^5.54.0",
20
+ "@typescript-eslint/eslint-plugin": "^5.55.0",
21
+ "@typescript-eslint/parser": "^5.55.0",
22
22
  "decircularize": "^1.0.0",
23
23
  "deep-eql": "^4.1.0",
24
24
  "deep-equal": "^2.0.5",
25
- "eslint": "^8.35.0",
25
+ "eslint": "^8.36.0",
26
26
  "eslint-friendly-formatter": "^4.0.1",
27
27
  "eslint-webpack-plugin": "^4.0.0",
28
28
  "fast-deep-equal": "^3.1.3",
29
29
  "html-webpack-plugin": "^5.5.0",
30
30
  "in-publish": "^2.0.0",
31
- "jest": "^29.4.3",
32
- "jest-environment-jsdom": "^29.4.3",
31
+ "jest": "^29.5.0",
32
+ "jest-environment-jsdom": "^29.5.0",
33
33
  "jest-expect-message": "^1.1.3",
34
34
  "lodash": "^4.17.21",
35
35
  "nano-equal": "^2.0.2",
36
36
  "prettier": "^2.8.4",
37
37
  "react": "^18.2.0",
38
38
  "react-dom": "^18.2.0",
39
- "react-fast-compare": "^3.2.0",
40
- "release-it": "^15.7.0",
41
- "rollup": "^3.18.0",
39
+ "react-fast-compare": "^3.2.1",
40
+ "release-it": "^15.9.0",
41
+ "rollup": "^3.19.1",
42
42
  "shallow-equal-fuzzy": "^0.0.2",
43
43
  "tinybench": "^2.4.0",
44
44
  "ts-jest": "^29.0.3",
45
45
  "ts-loader": "^9.4.2",
46
46
  "typescript": "^4.9.5",
47
47
  "underscore": "^1.13.4",
48
- "webpack": "^5.75.0",
48
+ "webpack": "^5.76.2",
49
49
  "webpack-cli": "^5.0.1",
50
- "webpack-dev-server": "^4.11.1"
50
+ "webpack-dev-server": "^4.13.0"
51
51
  },
52
52
  "engines": {
53
53
  "node": ">=6.0.0"
@@ -109,5 +109,5 @@
109
109
  "sideEffects": false,
110
110
  "type": "module",
111
111
  "types": "./index.d.ts",
112
- "version": "5.0.0"
112
+ "version": "5.0.1"
113
113
  }