@x-oasis/throttle 0.3.0 → 0.4.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @x-oasis/throttle@0.3.0 build /home/runner/work/x-oasis/x-oasis/packages/schedule/throttle
+> @x-oasis/throttle@0.4.0 build /home/runner/work/x-oasis/x-oasis/packages/schedule/throttle
 > tsdx build --tsconfig tsconfig.build.json
 
 @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`.
@@ -13,5 +13,4 @@
 [tsdx]: Your rootDir is currently set to "./". Please change your rootDir to "./src".
 TSDX has deprecated setting tsconfig.compilerOptions.rootDir to "./" as it caused buggy output for declarationMaps and more.
 You may also need to change your include to remove "test", which also caused declarations to be unnecessarily created for test files.
-⠴ Building modules
-✓ Building modules 4.1 secs
+✓ Building modules 4.2 secs

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @x-oasis/throttle
 
+## 0.4.0
+
+### Minor Changes
+
+- 6d79ee1: feat: bump version
+
+### Patch Changes
+
+- Updated dependencies [6d79ee1]
+  - @x-oasis/default-boolean-value@0.4.0
+  - @x-oasis/debounce@0.4.0
+
 ## 0.3.0
 
 ### Minor Changes

package/docs/index.md

@@ -0,0 +1,103 @@
+# @x-oasis/throttle
+
+Throttle function calls at intervals
+
+## Installation
+
+```bash
+npm install @x-oasis/throttle
+```
+
+## Quick Start
+
+```typescript
+import { /* exports */ } from '@x-oasis/throttle';
+
+// Your code here
+```
+
+## Key Features
+
+- High performance
+- TypeScript support
+- No external dependencies
+- Well-tested and stable
+
+## API Reference
+
+### Main Exports
+
+See the source code on [GitHub](https://github.com/red-armor/x-oasis/tree/main/packages/schedule/throttle)
+
+## Usage Examples
+
+### Basic Example
+
+```typescript
+// See package documentation for detailed examples
+```
+
+### Advanced Usage
+
+```typescript
+// Advanced patterns and use cases
+```
+
+## TypeScript Support
+
+Full TypeScript definitions are included:
+
+```typescript
+import { /* types */ } from '@x-oasis/throttle';
+```
+
+## Performance
+
+This package is optimized for:
+- Small bundle size
+- Fast execution
+- Memory efficiency
+
+## Browser Support
+
+- Modern browsers (ES2015+)
+- Node.js 12.0+
+
+## Best Practices
+
+✅ **Do:**
+- Use according to documentation
+- Check types before use
+- Handle edge cases
+
+❌ **Don't:**
+- Misuse the API
+- Ignore error handling
+- Forget null checks
+
+## Common Pitfalls
+
+1. **Pitfall** - Description and solution
+2. **Pitfall** - Description and solution
+
+## Troubleshooting
+
+**Problem**: Issue description
+
+**Solution**: How to fix it
+
+## Related Packages
+
+- Other packages in [schedule](/packages/schedule/)
+- Similar functionality in other categories
+
+## See Also
+
+- [Package Category](/packages/schedule/)
+- [All Packages](/packages/)
+- [GitHub Issues](https://github.com/red-armor/x-oasis/issues)
+- [Discussions](https://github.com/red-armor/x-oasis/discussions)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x-oasis/throttle",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "throttle function",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,8 +14,8 @@
     "tsdx": "^0.14.1"
   },
   "dependencies": {
-    "@x-oasis/default-boolean-value": "0.3.0",
-    "@x-oasis/debounce": "0.3.0"
+    "@x-oasis/default-boolean-value": "0.4.0",
+    "@x-oasis/debounce": "0.4.0"
   },
   "scripts": {
     "build": "tsdx build --tsconfig tsconfig.build.json",