@sapphire/timer-manager 1.0.1-next.ef08c69.0 → 1.0.1-next.ef27abe.0

package/README.md

@@ -37,6 +37,28 @@ You can use the following command to install this package, or replace `npm insta
 npm install @sapphire/timer-manager
 ```
 
+## Usage
+
+**Note:** While this section uses `require`, the imports match 1:1 with ESM imports. For example `const { TimerManager } = require('@sapphire/timer-manager')` equals `import { TimerManager } from '@sapphire/timer-manager'`.
+
+### Basic Usage
+
+```typescript
+// Import the TimerManager class
+const { TimerManager } = require('@sapphire/timer-manager');
+
+// Use the class for timeouts
+const timeout = TimerManager.setTimeout(() => console.log('Hello, world!'), 1000);
+TimerManager.clearTimeout(timeout);
+
+// Use the class for intervals
+const interval = TimerManager.setInterval(() => console.log('Hello, world!'), 1000);
+TimerManager.clearInterval(interval);
+
+// Destroy all running timeouts and intervals so that NodeJS can gracefully exit
+TimerManager.destroy();
+```
+
 ## Buy us some doughnuts
 
 Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/timer-manager",
-  "version": "1.0.1-next.ef08c69.0",
+  "version": "1.0.1-next.ef27abe.0",
   "description": "A timer manager utility library for JavaScript.",
   "author": "@sapphire",
   "license": "MIT",
@@ -58,11 +58,11 @@
   },
   "devDependencies": {
     "@favware/cliff-jumper": "^1.8.8",
-    "@vitest/coverage-c8": "^0.23.4",
-    "tsup": "^6.2.3",
-    "typedoc": "^0.23.15",
-    "typedoc-json-parser": "^5.0.1",
+    "@vitest/coverage-c8": "^0.24.3",
+    "tsup": "^6.3.0",
+    "typedoc": "^0.23.17",
+    "typedoc-json-parser": "^6.0.2",
     "typescript": "^4.8.4",
-    "vitest": "^0.23.4"
+    "vitest": "^0.24.3"
   }
 }