Common Utils

This package provides utility methods for common operations which cover a wide range of use cases and helps in avoiding writing boilerplate code.

Install

npm install @b613/utils

Install Peer Dependencies by needed modules

| Module | Peer Dependencies | | --------------------- | -------------------------------------------------- | | @b613/utils/color | npm install cli-color (only for Node.js usage) | | @b613/utils/image | npm install image-downloader sharp | | @b613/utils/server | npm install body-parser express morgan |

Libraries

| Module | Browser | Node.js | Documentation | | --------------------- | ------- | ------- | ------------------------------------------------------------------------------------------ | | @b613/utils/array | 🗸 | 🗸 | array.d.ts | | @b613/utils/clist | 🗸 | 🗸 | CircularList.d.ts | | @b613/utils/client | 🗸 | 🗸 | client.d.ts | | @b613/utils/color | 🗸 | 🗸 | color.d.ts | | @b613/utils/http | 🗸 | 🗸 | color.d.ts | | @b613/utils/image | 🗸 | 🗸 | image.d.ts | | @b613/utils/number | 🗸 | 🗸 | number.d.ts | | @b613/utils/object | 🗸 | 🗸 | object.d.ts | | @b613/utils/ping | | 🗸 | ping.d.ts | | @b613/utils/promise | 🗸 | 🗸 | promise.d.ts | | @b613/utils/qs | 🗸 | 🗸 | qs.d.ts | | @b613/utils/regex | 🗸 | 🗸 | regex.d.ts | | @b613/utils/schema | 🗸 | 🗸 | schema.d.ts | | @b613/utils/server | | 🗸 | Server.d.ts | | @b613/utils/string | 🗸 | 🗸 | string.d.ts | | @b613/utils/trace | 🗸 | 🗸 | trace.d.ts |

Development Setup

1. Install Devbox

2. Install direnv with your OS package manager

3. Hook it direnv into your shell

4. Load environment

   At the top-level of your project run:

   direnv allow

5. Install dependencies

   make install

6. Start dev environment

   make env

   This will starts a preconfigured Tmux session. Please see the .tmuxinator.yml file.

License

Under the MIT license. See LICENSE file for more details.