task-handler - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "task-handler",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Handle Javascript Timers in a manageable way",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -105,2 +105,49 @@ # task-handler
 
+Documentation coming soon...
+
+```js
+// public interface for TaskHandler
+class TaskHandler {
+  // how many scheduled tasks of any type do we have?
+  get size(): number
+
+  // create a timeout, cancelling any timeouts
+  // currently scheduled with the given id if any
+  after(
+    id: TaskID,
+    delay: number,
+    fn: CallbackFn,
+    ...args: Array<any>
+  ): CallbackRef
+
+  defer(id: TaskID, fn: CallbackFn, ...args: Array<any>): CallbackRef
+
+  every(
+    id: TaskID,
+    interval: number,
+    fn: CallbackFn,
+    ...args: Array<any>
+  ): CallbackRef
+
+  everyNow(
+    id: TaskID,
+    interval: number,
+    fn: CallbackFn,
+    ...args: Array<any>
+  ): CallbackRef
+
+  // cancel the given timeout (optionally provide a type if it should only
+  // be cancelled if its of the given type).
+  // returns true if a task was cancelled.
+  cancel(id: TaskID, type?: TaskTypes): boolean
+
+  // cancel all of a given type (or all if no argument provided)
+  clear(...types: Array<TaskTypes>): void
+
+  // are the given tasks currently scheduled? returns true if all tasks
+  // given are present.
+  has(...ids: Array<TaskID>): boolean
+}
+```
+
 ### `TaskRef` (Object)
@@ -107,0 +154,0 @@

No alert changes

Improved metrics

Total package byte prevSize

19187

increased by6.22%

Number of lines in readme file

168

increased by38.84%

No dependency changes