@inglorious/utils 3.6.0 → 3.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,16 +5,22 @@
|
|
|
5
5
|
|
|
6
6
|
A set of general-purpose utility functions designed with functional programming principles in mind. This package is part of the [Inglorious Engine](https://github.com/IngloriousCoderz/inglorious-engine) monorepo.
|
|
7
7
|
|
|
8
|
+
---
|
|
9
|
+
|
|
8
10
|
## Overview
|
|
9
11
|
|
|
10
12
|
This package provides a collection of pure, composable helper functions to streamline development in any JavaScript or TypeScript project. It embraces a data-oriented and functional approach, operating on plain data structures like objects and arrays.
|
|
11
13
|
|
|
14
|
+
---
|
|
15
|
+
|
|
12
16
|
## Installation
|
|
13
17
|
|
|
14
18
|
```bash
|
|
15
19
|
npm install @inglorious/utils
|
|
16
20
|
```
|
|
17
21
|
|
|
22
|
+
---
|
|
23
|
+
|
|
18
24
|
## Usage
|
|
19
25
|
|
|
20
26
|
Here are a few examples of how you can use the utilities in this package.
|
|
@@ -52,6 +58,8 @@ const newPosition = add(position, velocity)
|
|
|
52
58
|
// => [12, 19]
|
|
53
59
|
```
|
|
54
60
|
|
|
61
|
+
---
|
|
62
|
+
|
|
55
63
|
## API
|
|
56
64
|
|
|
57
65
|
This package is designed to be used with subpath imports, which helps with tree-shaking.
|
|
@@ -61,10 +69,18 @@ This package is designed to be used with subpath imports, which helps with tree-
|
|
|
61
69
|
- **`@inglorious/utils/math`**: Utilities for math operations.
|
|
62
70
|
- **`@inglorious/utils/physics`**: Utilities for calculations on friction, acceleration, and gravity.
|
|
63
71
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
We welcome contributions! Please see the root `CONTRIBUTING.md` file for more details.
|
|
72
|
+
---
|
|
67
73
|
|
|
68
74
|
## License
|
|
69
75
|
|
|
70
|
-
|
|
76
|
+
**MIT License - Free and open source**
|
|
77
|
+
|
|
78
|
+
Created by [Matteo Antony Mistretta](https://github.com/IngloriousCoderz)
|
|
79
|
+
|
|
80
|
+
You're free to use, modify, and distribute this software. See [LICENSE](./LICENSE) for details.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Contributing
|
|
85
|
+
|
|
86
|
+
We welcome contributions! Please see the root `CONTRIBUTING.md` file for more details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inglorious/utils",
|
|
3
|
-
"version": "3.6.
|
|
3
|
+
"version": "3.6.2",
|
|
4
4
|
"description": "A set of general-purpose utility functions designed with functional programming principles in mind.",
|
|
5
5
|
"author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
|
|
6
6
|
"license": "MIT",
|