task-handler - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

package.json

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

README.md

@@ -77,2 +77,36 @@ # task-handler
 
+## Common Type Signatures
+
+Below are a few of the common type signatures describing the values which are
+used throughout the API for `task-handler`.
+
+```js
+type TaskID = string;
+
+type TaskCancelFunction = () => boolean;
+
+type TaskTypes =
+  | 'timeout'
+  | 'timeouts'
+  | 'intervals'
+  | 'interval'
+  | 'defer'
+  | 'defers';
+
+type TaskID = string;
+
+type TaskCancelFunction = () => boolean;
+
+type WhileConditionFn = (ref: CallbackRef, ...args: Array<*>) => boolean;
+
+type CallbackRef = {|
+  +task: TaskHandler,
+  +id: TaskID,
+  +cancel: TaskCancelFunction,
+  +while: (condition: WhileConditionFn) => void,
+|};
+
+type CallbackFn = (ref: CallbackRef, ...args: Array<*>) => mixed;
+```
+
 ## API Reference
@@ -152,18 +186,1 @@
 ```
-
-### `TaskRef` (Object)
-
-```js
-type TaskID = string;
-
-type TaskCancelFunction = () => boolean;
-
-type WhileConditionFn = (ref: CallbackRef, ...args: Array<*>) => boolean;
-
-type CallbackRef = {|
-  +task: TaskHandler,
-  +id: TaskID,
-  +cancel: TaskCancelFunction,
-  +while: (condition: WhileConditionFn) => void,
-|};
-```

No alert changes

Improved metrics

Total package byte prevSize

19549

increased by1.89%

Number of lines in readme file

185

increased by10.12%

No dependency changes