Package Exports
- tiny-essentials
Readme
Tiny Essentials
Tiny Essentials is a collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility. From date calculations to formatting, object manipulations, and array operations, these scripts serve as building blocks for more complex applications.
Features
- Array Manipulations: Functions like
shuffleArrayto randomize elements in place. - Time Calculations: Easily calculate durations, format timers, and more.
- Object Utilities: Perform type checks, count object properties, and calculate percentages.
- Custom Utilities: Includes various helper functions like
ruleOfThreefor proportion calculations andgetAgeto calculate the age based on a given birth date.
Installation
You can install Tiny Essentials via npm:
npm install tiny-essentialsOr download the scripts directly from this repository.
Legacy Code
Some scripts in this repository have been preserved for backwards compatibility. These include modules like:
@tinypudding/firebase-lib@tinypudding/discord-oauth2@tinypudding/mysql-connector@tinypudding/puddy-lib
These modules have been updated to work with modern environments but may not be actively developed further.
Module Versions
The core version of Tiny Essentials (version 1) is located in the folder /src/v1.
A detailed README is available inside the v1 folder, which contains a full description of all utility modules and their functionalities.
We recommend checking it out if you want to see all available tools in this version and how to use them individually or collectively via the index.mjs global module.
Contributions
Feel free to fork, contribute, and create pull requests for improvements! Whether it's a bug fix or an additional feature, contributions are always welcome.
License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
Credits
This project was inspired by the need for lightweight, reusable code that can be used across many different kinds of applications. Contributions and suggestions are always appreciated!
Note: This documentation was written by ChatGPT, an AI assistant developed by OpenAI, based on the project structure and descriptions provided by the repository author.
If you find any inaccuracies or need improvements, feel free to contribute or open an issue!
