Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luke-zhang-04/utils
Simple but useful utility functions without the bloat of Lodash + an intuitive API for Node Crypto and Web Crypto
https://github.com/luke-zhang-04/utils
Last synced: 7 days ago
JSON representation
Simple but useful utility functions without the bloat of Lodash + an intuitive API for Node Crypto and Web Crypto
- Host: GitHub
- URL: https://github.com/luke-zhang-04/utils
- Owner: Luke-zhang-04
- License: 0bsd
- Created: 2021-07-28T14:53:14.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T03:26:38.000Z (8 months ago)
- Last Synced: 2024-11-07T08:44:26.796Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 963 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Utilities
[](https://codeclimate.com/github/Luke-zhang-04/utils/test_coverage)
[](https://github.com/Luke-zhang-04/utils/actions/workflows/CI.yml)
Useful utility functions without the bloat of Lodash. Lodash contains many unnecessary functions, and have functions which rely on each other, creating massive bundles even if you only used one function. These utilities are tree-shakeable, independent (some exceptions), pure functions and are built with performance in mind. I use these functions in my own projects.
Even though most of these functions are trivial to write, it becomes annoying to have to write them over and over again, so I put them into a repo that can be installed with a package manager.
Included are also wrappers around existing APIs. For example, the Node Crypto API is hard to use, and requires many steps. The functions in `node/crypto` allow for easy hashing and encryption.
## Installation
Install directly from Github.
**To install with semver:**
```
npm i Luke-zhang-04/utils#semver:
pnpm add Luke-zhang-04/utils#semver:
yarn add Luke-zhang-04/utils#semver:
```
E.g
```
npm i Luke-zhang-04/utils#semver:^1.0.0
```
**To install a specific version:**
```
npm i Luke-zhang-04/utils#v
pnpm add Luke-zhang-04/utils#v
yarn add Luke-zhang-04/utils#v
```
Or
```
npm i https://github.com/Luke-zhang-04/utils/releases/download/vutils.tar.gz
pnpm add https://github.com/Luke-zhang-04/utils/releases/download/vutils.tar.gz
yarn add https://github.com/Luke-zhang-04/utils/releases/download/vutils.tar.gz
```
**"Rolling release"**
```
npm i Luke-zhang-04/utils#dist
pnpm add Luke-zhang-04/utils#dist
yarn add Luke-zhang-04/utils#dist
```
**To install a specific commit:**
```
npm i Luke-zhang-04/utils#
pnpm add Luke-zhang-04/utils#
yarn add Luke-zhang-04/utils#
```
Make sure the commits are specifically from the dist branch.
## Usage
Visit the [wiki](https://github.com/Luke-zhang-04/utils/wiki) for documentation
### Importing
It is recommended that either named or star imports are used. Default imports may not be tree-shaken properly.
Imports from the `cjs` directory do not work. Node will automatically map imports to cjs or mjs based on the running program.