Skip to content

Commit

Permalink
Fix references to metaOverride (#100)
Browse files Browse the repository at this point in the history
* fix legacy types and documentation which refer to `metaOverride`

* update changelog

* update dependencies
  • Loading branch information
planttheidea authored Mar 18, 2023
1 parent 0698037 commit 19327e5
Show file tree
Hide file tree
Showing 5 changed files with 615 additions and 571 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# fast-equals CHANGELOG

## 5.0.1

### Bugfixes

- Fix reference to `metaOverride` in typings and documentation (holdover from temporary API in v5 beta)

## 5.0.0

### Breaking changes
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ function createCustomEqual<Meta>(options: {
) => boolean;
createState?: () => { cache?: Cache; meta?: Meta };
strict?: boolean;
}): <A, B>(a: A, b: B, metaOverride?: Meta) => boolean;
}): <A, B>(a: A, b: B) => boolean;
```

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).
Expand Down
8 changes: 4 additions & 4 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ export declare const strictCircularShallowEqual: <A, B>(a: A, b: B) => boolean;
*
* This can be done to create very targeted comparisons in extreme hot-path scenarios
* where the standard methods are not performant enough, but can also be used to provide
* support for legacy environments that do not support expected features like
* `RegExp.prototype.flags` out of the box.
* support for legacy environments that cannot polyfill for modern features expected by
* `fast-equals`, such as `WeakMap` or `RegExp.prototype.flags`.
*/
export declare function createCustomEqual<Meta>(
export declare function createCustomEqual<Meta = undefined>(
options?: CustomEqualCreatorOptions<Meta>,
): <A, B>(a: A, b: B, metaOverride?: Meta) => boolean;
): <A, B>(a: A, b: B) => boolean;
24 changes: 12 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,43 @@
"@rollup/plugin-replace": "^5.0.2",
"@rollup/plugin-terser": "^0.4.0",
"@rollup/plugin-typescript": "^11.0.0",
"@types/jest": "^29.2.5",
"@types/jest": "^29.5.0",
"@types/lodash": "^4.14.184",
"@types/node": "^18.14.6",
"@types/node": "^18.15.3",
"@types/ramda": "^0.28.23",
"@types/react": "^18.0.28",
"@types/react-dom": "^18.0.11",
"@typescript-eslint/eslint-plugin": "^5.54.0",
"@typescript-eslint/parser": "^5.54.0",
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"decircularize": "^1.0.0",
"deep-eql": "^4.1.0",
"deep-equal": "^2.0.5",
"eslint": "^8.35.0",
"eslint": "^8.36.0",
"eslint-friendly-formatter": "^4.0.1",
"eslint-webpack-plugin": "^4.0.0",
"fast-deep-equal": "^3.1.3",
"html-webpack-plugin": "^5.5.0",
"in-publish": "^2.0.0",
"jest": "^29.4.3",
"jest-environment-jsdom": "^29.4.3",
"jest": "^29.5.0",
"jest-environment-jsdom": "^29.5.0",
"jest-expect-message": "^1.1.3",
"lodash": "^4.17.21",
"nano-equal": "^2.0.2",
"prettier": "^2.8.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-fast-compare": "^3.2.0",
"release-it": "^15.7.0",
"rollup": "^3.18.0",
"react-fast-compare": "^3.2.1",
"release-it": "^15.9.0",
"rollup": "^3.19.1",
"shallow-equal-fuzzy": "^0.0.2",
"tinybench": "^2.4.0",
"ts-jest": "^29.0.3",
"ts-loader": "^9.4.2",
"typescript": "^4.9.5",
"underscore": "^1.13.4",
"webpack": "^5.75.0",
"webpack": "^5.76.2",
"webpack-cli": "^5.0.1",
"webpack-dev-server": "^4.11.1"
"webpack-dev-server": "^4.13.0"
},
"engines": {
"node": ">=6.0.0"
Expand Down
Loading

0 comments on commit 19327e5

Please sign in to comment.