@technobuddha/library
Version:
A large library of useful functions
78 lines (57 loc) • 3.61 kB
Markdown
<!--
🚨
🚨 CHANGES TO THIS FILE WILL BE OVERRIDDEN
🚨
-->
<!-- markdownlint-disable -->
## Introduction
This is a large library of many things that the
[Technobuddha](https://technobuddha.com)
has found useful over the years. There is a plethora of functions and classes for working with
arrays, strings, numbers, dates, objects, and more. Ranging from the simple
([clamp](https://doc.technobuddha.com/library/clamp.html))
to the complex
([largestInscribedRectangle](https://doc.technobuddha.com/library/largestInscribedRectangle.html)),
this library has something for everyone.
## Contents
| Group | Entities |
| ----- | -------- |
| [Array](https://doc.technobuddha.com/library/index_array.html) | 7 Functions and 6 Types |
| [Binary](https://doc.technobuddha.com/library/index_binary.html) | 8 Classes, 13 Functions, and 2 Types |
| [Geometry](https://doc.technobuddha.com/library/index_geometry.html) | 2 Constants, 43 Functions, and 12 Types |
| [JSON](https://doc.technobuddha.com/library/index_json.html) | 2 Classes, 2 Constants, 2 Functions, and 4 Types |
| [Math](https://doc.technobuddha.com/library/index_math.html) | 5 Constants, 32 Functions, and 12 Types |
| [Object](https://doc.technobuddha.com/library/index_object.html) | 25 Functions and 1 Type |
| [Programming](https://doc.technobuddha.com/library/index_programming.html) | 20 Functions and 4 Types |
| [Random](https://doc.technobuddha.com/library/index_random.html) | 1 Class, 4 Functions, and 1 Type |
| [RegExp](https://doc.technobuddha.com/library/index_regExp.html) | 8 Constants and 7 Functions |
| [String](https://doc.technobuddha.com/library/index_string.html) | 58 Functions and 21 Types |
| [Time](https://doc.technobuddha.com/library/index_time.html) | 1 Class, 17 Constants, 28 Functions, and 12 Types |
| [Unicode](https://doc.technobuddha.com/library/index_unicode.html) | 16 Constants, 5 Functions, and 2 Types |
| [Utility](https://doc.technobuddha.com/library/index_utility.html) | 1 Class |
## Installation
Using npm:
```shell
npm install @technobuddha/library
```
## Usage
Most modern build systems will now do proper tree-shaking, so you can import only the functions you need:
```ts
import { plural, summarize } from '@technobuddha/library';
plural('mouse'); // 'mice'
summarize(Number.MAX_SAFE_INTEGER); // '9.01 quadrillion'
```
## License
The Technobuddha Library is released under the [MIT license](LICENSE).
## Documentation
[Dive into the Technobuddha Library documentation](https://doc.technobuddha.com/library.html)
The documentation is written by the `Technobuddha` assisted by AI. Some of what the AI has written is good, some not so much. If you find something that is incorrect or could be improved, please [raise an issue](https://github.com/technobuddha/library/issues) or [make a pull request](https://github.com/technobuddha/library/pulls).
## History
In one form or another, this library has been around since the later part of the 20th century. I ported my library to `Typescript` in 2021, version 2 brings many improvements and new features, as well as a complete rewrite of the documentation.