atomic-fns
Read the Docs
Like Lodash, but in TypeScript and for ESnext.
Stop shipping code built for browsers from 2015. Really though, look at all the issues.
You may prefer this because it's:
- TypeScript & docs: Includes type declaration files and js with JSDocs for best in class experience.
- Zero deps: Built from scratch with no runtime dependencies or polyfills.
- ESnext: Uses modern idiomatic syntax, data structures, and control flow techniques.
- Modular: Pick what you need. Supports tree-shaking, no side effects and works with all bundlers.
- Lazy: Leverage generators, iterators, and functional composition.
- Well tested: All modules have comprehensive test suites and public apis are 100% coverage.
Docs
📖 Available at atomic-fns.dev
Get Started
This library is available as an npm package.
To install the package you need to have npm (or yarn) installed and then run:
npm install atomic-fns
How to use
Just import any function or class you need.
import { sorted, times, uniqueId } from 'atomic-fns'
times(5, (i) => i)
// -> [0, 1, 2, 3, 4]
sorted([4, 3, 2, 1])
// -> [1, 2, 3, 4]
uniqueId('user_')
// -> 'user_101225005'
...
See the full list of modules.
Data model
This library features a data model similar to Python but not always. Only the missing parts have been implemented, while respecting the JS standards.
For example in Python collections size() is a method while in JS its just a property. So this library uses size property instead of methods. Similarly, the len function implementation checks for both length and size since many JS objects have a length property.
Special method names
This library adds support for operators using object methods such as:
obj.eq(other) adds custom obj == other.obj.lt(other) adds custom obj < other.obj.lte(other) adds custom obj <= other.obj.gt(other) adds custom obj > other.obj.gte(other) adds custom obj >= other.obj.compare(other) overloads sorting operations.
When you implement those, you can also apply operators to values like eq(x, y), lte(x, y), compare(x, y), etc. to get the result of x.<operator>(y).
New Types
Introduces some common base interfaces and typing patterns you may have seen like Optional, Result, Comparable, Iterator, and others.
Sorted Containers
Other Containers
Contributing
If you want to contribute to the project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request. You will be listed as a Champion on the official site as well.
License
Apache License 2.0
