feat(decorators): replace timeout with delay

#1

README.md

@@ -13,12 +13,12 @@ yarn add helpful-decorators
 ```
 
 ## Usage
-`timeout` - Add `setTimeout` functionality to the method
+`delay` - Add `setTimeout` functionality to the method
 ```ts
-import { timeout } from 'helpful-decorators';
+import { delay } from 'helpful-decorators';
 
 class Test {
- @timeout(1000)
+ @delay(1000)
  method() {
    // ...
  }
@@ -84,7 +84,7 @@ class Test {
 
 ### Roadmap
 
- - ~~timeout~~
+ - ~~delay~~
  - ~~debounce~~
  - ~~throttle~~
  - ~~once~~

package.json

@@ -1,6 +1,6 @@
 {
     "name": "helpful-decorators",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "Helpful decorators for typescript projects",
     "main": "dist/index.js",
     "typings": "./dist/index.d.ts",
@@ -55,7 +55,8 @@
     "dependencies": {
         "conventional-changelog-cli": "^1.3.3",
         "lodash.debounce": "^4.0.8",
+        "lodash.delay": "^4.1.1",
         "lodash.once": "^4.1.1",
         "lodash.throttle": "^4.1.1"
     }
-}
+}

src/delay.ts

@@ -0,0 +1,14 @@
+import * as delayFn from 'lodash.once';
+
+/**
+ * 
+ * @param wait 
+ * @param options 
+ */
+export function delay( wait : number = 0, args ) {
+  return function ( target : any, propertyKey : string, descriptor : PropertyDescriptor ) {
+    const originalMethod = descriptor.value;
+    descriptor.value = delayFn(originalMethod, wait, args);
+    return descriptor;
+  }
+}

src/index.ts

@@ -1,5 +1,6 @@
 export { measure } from './measure';
 export { timeout } from './timeout';
+export { delay } from './delay';
 export { debounce } from './debounce';
 export { throttle } from './throttle';
 export { once } from './once';

src/timeout.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * @deprecated since version 1.5.0
  * @param milliseconds
  * @returns {(target:any, propertyKey:string, descriptor:PropertyDescriptor)=>PropertyDescriptor}
  */