@x-oasis/is-clamped 0.2.5 → 0.4.0
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/.turbo/turbo-build.log +6 -4
- package/CHANGELOG.md +16 -0
- package/docs/index.md +103 -0
- package/package.json +1 -1
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
|
|
2
|
-
> @x-oasis/is-clamped@0.
|
|
2
|
+
> @x-oasis/is-clamped@0.4.0 build /home/runner/work/x-oasis/x-oasis/packages/comparison/is-clamped
|
|
3
3
|
> tsdx build --tsconfig tsconfig.build.json
|
|
4
4
|
|
|
5
5
|
@rollup/plugin-replace: 'preventAssignment' currently defaults to false. It is recommended to set this option to `true`, as the next major version will default this option to `true`.
|
|
6
6
|
@rollup/plugin-replace: 'preventAssignment' currently defaults to false. It is recommended to set this option to `true`, as the next major version will default this option to `true`.
|
|
7
7
|
⠙ Creating entry file
|
|
8
|
-
[2K[1A[2K[G✓ Creating entry file
|
|
8
|
+
[2K[1A[2K[G✓ Creating entry file 3.9 secs
|
|
9
9
|
⠙ Building modules
|
|
10
10
|
[2K[1A[2K[G⠹ Building modules
|
|
11
11
|
[2K[1A[2K[G⠸ Building modules
|
|
12
12
|
[2K[1A[2K[G⠼ Building modules
|
|
13
13
|
[2K[1A[2K[G⠴ Building modules
|
|
14
14
|
[2K[1A[2K[G⠦ Building modules
|
|
15
|
+
[2K[1A[2K[G⠧ Building modules
|
|
16
|
+
[2K[1A[2K[G⠇ Building modules
|
|
17
|
+
[2K[1A[2K[G⠏ Building modules
|
|
15
18
|
[tsdx]: Your rootDir is currently set to "./". Please change your rootDir to "./src".
|
|
16
19
|
TSDX has deprecated setting tsconfig.compilerOptions.rootDir to "./" as it caused buggy output for declarationMaps and more.
|
|
17
20
|
You may also need to change your include to remove "test", which also caused declarations to be unnecessarily created for test files.
|
|
18
|
-
[2K[1A[2K[G
|
|
19
|
-
[2K[1A[2K[G✓ Building modules 8.2 secs
|
|
21
|
+
[2K[1A[2K[G✓ Building modules 8.8 secs
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @x-oasis/is-clamped
|
|
2
2
|
|
|
3
|
+
## 0.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 6d79ee1: feat: bump version
|
|
8
|
+
|
|
9
|
+
## 0.3.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 2f68e5c: feat: bump version
|
|
14
|
+
- 71159c0: feat: bump version
|
|
15
|
+
- 6784c72: feat: bump
|
|
16
|
+
- 04f5045: feat: bump version
|
|
17
|
+
- 208592f: feat: bump version
|
|
18
|
+
|
|
3
19
|
## 0.2.5
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
package/docs/index.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# @x-oasis/is-clamped
|
|
2
|
+
|
|
3
|
+
Check if a value is within bounds
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @x-oasis/is-clamped
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { /* exports */ } from '@x-oasis/is-clamped';
|
|
15
|
+
|
|
16
|
+
// Your code here
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Key Features
|
|
20
|
+
|
|
21
|
+
- High performance
|
|
22
|
+
- TypeScript support
|
|
23
|
+
- No external dependencies
|
|
24
|
+
- Well-tested and stable
|
|
25
|
+
|
|
26
|
+
## API Reference
|
|
27
|
+
|
|
28
|
+
### Main Exports
|
|
29
|
+
|
|
30
|
+
See the source code on [GitHub](https://github.com/red-armor/x-oasis/tree/main/packages/comparison/is-clamped)
|
|
31
|
+
|
|
32
|
+
## Usage Examples
|
|
33
|
+
|
|
34
|
+
### Basic Example
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
// See package documentation for detailed examples
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Advanced Usage
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
// Advanced patterns and use cases
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## TypeScript Support
|
|
47
|
+
|
|
48
|
+
Full TypeScript definitions are included:
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import { /* types */ } from '@x-oasis/is-clamped';
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Performance
|
|
55
|
+
|
|
56
|
+
This package is optimized for:
|
|
57
|
+
- Small bundle size
|
|
58
|
+
- Fast execution
|
|
59
|
+
- Memory efficiency
|
|
60
|
+
|
|
61
|
+
## Browser Support
|
|
62
|
+
|
|
63
|
+
- Modern browsers (ES2015+)
|
|
64
|
+
- Node.js 12.0+
|
|
65
|
+
|
|
66
|
+
## Best Practices
|
|
67
|
+
|
|
68
|
+
✅ **Do:**
|
|
69
|
+
- Use according to documentation
|
|
70
|
+
- Check types before use
|
|
71
|
+
- Handle edge cases
|
|
72
|
+
|
|
73
|
+
❌ **Don't:**
|
|
74
|
+
- Misuse the API
|
|
75
|
+
- Ignore error handling
|
|
76
|
+
- Forget null checks
|
|
77
|
+
|
|
78
|
+
## Common Pitfalls
|
|
79
|
+
|
|
80
|
+
1. **Pitfall** - Description and solution
|
|
81
|
+
2. **Pitfall** - Description and solution
|
|
82
|
+
|
|
83
|
+
## Troubleshooting
|
|
84
|
+
|
|
85
|
+
**Problem**: Issue description
|
|
86
|
+
|
|
87
|
+
**Solution**: How to fix it
|
|
88
|
+
|
|
89
|
+
## Related Packages
|
|
90
|
+
|
|
91
|
+
- Other packages in [comparison](/packages/comparison/)
|
|
92
|
+
- Similar functionality in other categories
|
|
93
|
+
|
|
94
|
+
## See Also
|
|
95
|
+
|
|
96
|
+
- [Package Category](/packages/comparison/)
|
|
97
|
+
- [All Packages](/packages/)
|
|
98
|
+
- [GitHub Issues](https://github.com/red-armor/x-oasis/issues)
|
|
99
|
+
- [Discussions](https://github.com/red-armor/x-oasis/discussions)
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
MIT
|