Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Mat Taylor authored and Mat Taylor committed Oct 22, 2022
1 parent 7c15773 commit 5986467
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Objix is a delightfully convienient, high performance, zero dependency, lightwei

The functions are all non enumerable and include copies of Object class methods and Array prototype methods applied to the values of the object as well others to delete keys, stringify, promisify, memoize, compare, split and join objects, check types, log messages and trapping/observing property assignments.

This library is highly optimised with zero copy operations where possible. The un-minified source is only 3.6kb (2.7kb minified) which allows for fast loading and easy integration without additonal compilation or tree shaking. There is however limited type checking to guard against unwanted side effects, and there may be some undiscovered edge case that do not behave as expected. Performance in most cases is signifantly faster than `lodash` equivalents especially when working with small objects. For example `ob.map(fn)` is typically over 65% faster than `_.mapValues(ob, fn)` and some operations such as `filter` can be several thousand times quicker according to simple [benchmarks](docs/bench.md).
This library is highly optimised with zero copy operations where possible. The un-minified source is only 3.6kb (2.7kb minified) which allows for fast loading and easy integration without additonal compilation or tree shaking. There is however limited type checking to guard against unwanted side effects, and there may be some undiscovered edge case that do not behave as expected. Performance in most cases is significantly faster than `lodash` equivalents especially when working with small objects. For example `ob.map(fn)` is typically over 65% faster than `_.mapValues(ob, fn)` and some operations such as `filter` can be several thousand times quicker according to simple [benchmarks](docs/bench.md).

Interactive docs and demos are availble on https://objix.dev/#/api.

Expand Down

0 comments on commit 5986467

Please sign in to comment.