LumeWeb
/
p-timeout
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc

This commit is contained in:
İlker Yıldırım 2020-12-20 13:04:45 +03:00
parent 1211b407a8
commit 3d47f35f61
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
index.d.ts vendored
View File

@ -42,7 +42,7 @@ declare namespace pTimeout {
interface ClearablePromise<T> extends Promise<T>{
/**
* .clear() method that clears the timeout.
* Clear the timeout.
*/
clear: () => void;
}
@ -81,7 +81,7 @@ declare const pTimeout: {
): ClearablePromise<ValueType>;
/**
Timeout a promise after a specified amount of time. It returns a decorated promise having `.clear()` method to be able to clear timeout.
Timeout a promise after a specified amount of time.
If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
@ -100,7 +100,6 @@ declare const pTimeout: {
pTimeout(delayedPromise(), 50, () => {
return pTimeout(delayedPromise(), 300);
});
promise.clear(); //Clear timeout
```
*/
<ValueType, ReturnType>(