-
What is this?
Radashi, pronounced /raw-dash-ee/, is a modern, zero-dependency JavaScript utility toolkit built with TypeScript for type-safe, readable, and maintainable code. Radashi omits functions that have become obsolete in Lodash and introduces innovative tools for improved error handling, asynchronous operations, and data manipulation. With a focus on readability and maintainability, Radashi ensures that its source code is easy to understand and use, making it simple for developers to copy individual functions directly from GitHub if needed. Radashi is the go-to toolkit for cleaner, more efficient code in today's JavaScript ecosystem. -
Is this related to Radash?
Yes! This is a fork of the renownedradash
library by Ray Epps @sodiray. This fork aims to be a more consistently maintained version of the library, with bug fixes and improvements. -
Is there official documentation?
Currently, there is no documentation beyond this page. I will get to it eventually, but for now, you can refer to the originalradash
documentation. -
Are my contributions welcome?
Yes! Pull requests are encouraged, but please keep them small and focused. Sweeping changes are discouraged and won't be merged (unless the rationale's been thoroughly discussed).Please review “The ethos of Radashi” before submitting a pull request:
-
Can I help you maintain this?
Yes! I'll add you as a contributor to the repository. You can review pull requests and even merge them. You can help with closing issues, too. Committing directly to the main branch is a privilege you can earn, as is publishing versions to NPM. -
Is backwards compatibility a goal?
Yes! We want the transition fromradash
to this library to be smooth. We'll make sure to avoid breaking changes. If any are made, they will be clearly documented at the bottom of this page. -
Automatic releases
To ensure contributions are quickly rolled out, we have the following automatic processes:-
Beta releases
Whenever themain
branch receives a fix or feature, a beta release is automatically published to NPM. Installingradashi@beta
will always fetch the latest beta release. Beta releases are always audited by the Radashi team. -
Preview releases
When the owner of a PR comments/publish
(and nothing more), the PR is published to NPM under a version like1.0.0-pr123.f7a9c3b
(i.e.<latest version>-pr<PR number>.<commit SHA>
) and a tag likepr123
. This allows the community to use the changes in the PR without waiting for the PR to be merged.⚠️ Beware: Preview releases are not audited by the Radashi team. Always look at their changes in the PR to ensure no malicious code was introduced.
-
pnpm add radashi
yarn add radashi
npm install radashi
Contributions are welcome and appreciated! Check out the contributing guide before you dive in:
This section documents the changes between the original radash
library and this fork.
- Initial release. No differences.