with-ease-progress 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +9 -3
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +5 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 matthieupinte
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
# with-ease-progress
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/with-ease-progress)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/with-ease-progress)
|
|
6
|
+
|
|
3
7
|
Smooth progress tracking for async tasks in JavaScript/TypeScript.
|
|
4
8
|
|
|
9
|
+
This small utility ensures a minimum progress duration and smooth updates, perfect for tracking task progress in a user-friendly way.
|
|
10
|
+
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
7
13
|
```bash
|
|
@@ -15,10 +21,10 @@ yarn add with-ease-progress
|
|
|
15
21
|
### Direct
|
|
16
22
|
|
|
17
23
|
```typescript
|
|
18
|
-
import {
|
|
24
|
+
import { withEaseProgress } from "with-ease-progress";
|
|
19
25
|
|
|
20
26
|
// Simulate an async task
|
|
21
|
-
await
|
|
27
|
+
await withEaseProgress(
|
|
22
28
|
async (update) => {
|
|
23
29
|
for (let i = 0; i <= 100; i += 10) {
|
|
24
30
|
await new Promise(r => setTimeout(r, 100));
|
|
@@ -45,7 +51,7 @@ await withProgress(
|
|
|
45
51
|
### Curryable (functional-friendly)
|
|
46
52
|
|
|
47
53
|
```typescript
|
|
48
|
-
const uploadWithProgress =
|
|
54
|
+
const uploadWithProgress = withEaseProgress({
|
|
49
55
|
minDuration: 1500,
|
|
50
56
|
onProgress: p => console.log(p),
|
|
51
57
|
});
|
package/dist/index.d.mts
CHANGED
|
@@ -8,7 +8,7 @@ interface ProgressOptions {
|
|
|
8
8
|
minDuration?: number;
|
|
9
9
|
onProgress?: (percent: number) => void;
|
|
10
10
|
}
|
|
11
|
-
declare function
|
|
12
|
-
declare function
|
|
11
|
+
declare function withEaseProgress<T>(task: Task<T>, options?: ProgressOptions): Promise<T>;
|
|
12
|
+
declare function withEaseProgress(options: ProgressOptions): <T>(task: Task<T>) => Promise<T>;
|
|
13
13
|
|
|
14
|
-
export { type ProgressEventLike, type ProgressHandler, type ProgressOptions, type Task,
|
|
14
|
+
export { type ProgressEventLike, type ProgressHandler, type ProgressOptions, type Task, withEaseProgress };
|
package/dist/index.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ interface ProgressOptions {
|
|
|
8
8
|
minDuration?: number;
|
|
9
9
|
onProgress?: (percent: number) => void;
|
|
10
10
|
}
|
|
11
|
-
declare function
|
|
12
|
-
declare function
|
|
11
|
+
declare function withEaseProgress<T>(task: Task<T>, options?: ProgressOptions): Promise<T>;
|
|
12
|
+
declare function withEaseProgress(options: ProgressOptions): <T>(task: Task<T>) => Promise<T>;
|
|
13
13
|
|
|
14
|
-
export { type ProgressEventLike, type ProgressHandler, type ProgressOptions, type Task,
|
|
14
|
+
export { type ProgressEventLike, type ProgressHandler, type ProgressOptions, type Task, withEaseProgress };
|
package/dist/index.js
CHANGED
|
@@ -19,17 +19,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
19
19
|
// src/index.ts
|
|
20
20
|
var index_exports = {};
|
|
21
21
|
__export(index_exports, {
|
|
22
|
-
|
|
22
|
+
withEaseProgress: () => withEaseProgress
|
|
23
23
|
});
|
|
24
24
|
module.exports = __toCommonJS(index_exports);
|
|
25
25
|
var DEFAULT_MIN_DURATION = 2e3;
|
|
26
|
-
function
|
|
26
|
+
function withEaseProgress(arg1, arg2) {
|
|
27
27
|
if (typeof arg1 === "function") {
|
|
28
|
-
return
|
|
28
|
+
return runWithEaseProgress(arg1, arg2);
|
|
29
29
|
}
|
|
30
|
-
return (task) =>
|
|
30
|
+
return (task) => runWithEaseProgress(task, arg1);
|
|
31
31
|
}
|
|
32
|
-
async function
|
|
32
|
+
async function runWithEaseProgress(task, options = {}) {
|
|
33
33
|
const {
|
|
34
34
|
minDuration = DEFAULT_MIN_DURATION,
|
|
35
35
|
onProgress
|
|
@@ -86,6 +86,6 @@ function noop() {
|
|
|
86
86
|
}
|
|
87
87
|
// Annotate the CommonJS export names for ESM import in node:
|
|
88
88
|
0 && (module.exports = {
|
|
89
|
-
|
|
89
|
+
withEaseProgress
|
|
90
90
|
});
|
|
91
91
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ProgressEventLike = {\n loaded?: number;\n total?: number;\n};\n\nexport type ProgressHandler = (e: ProgressEventLike) => void;\n\nexport type Task<T> = (update: ProgressHandler) => Promise<T>;\n\nexport interface ProgressOptions {\n minDuration?: number;\n onProgress?: (percent: number) => void;\n}\n\nconst DEFAULT_MIN_DURATION = 2000;\n\nexport function
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ProgressEventLike = {\n loaded?: number;\n total?: number;\n};\n\nexport type ProgressHandler = (e: ProgressEventLike) => void;\n\nexport type Task<T> = (update: ProgressHandler) => Promise<T>;\n\nexport interface ProgressOptions {\n minDuration?: number;\n onProgress?: (percent: number) => void;\n}\n\nconst DEFAULT_MIN_DURATION = 2000;\n\nexport function withEaseProgress<T>(\n task: Task<T>,\n options?: ProgressOptions,\n): Promise<T>;\n\nexport function withEaseProgress(\n options: ProgressOptions,\n): <T>(task: Task<T>) => Promise<T>;\n\nexport function withEaseProgress<T>(\n arg1: Task<T> | ProgressOptions,\n arg2?: ProgressOptions,\n) {\n if (typeof arg1 === \"function\") {\n return runWithEaseProgress(arg1, arg2);\n }\n\n return <T>(task: Task<T>) => runWithEaseProgress(task, arg1);\n}\n\nasync function runWithEaseProgress<T>(\n task: Task<T>,\n options: ProgressOptions = {},\n): Promise<T> {\n const {\n minDuration = DEFAULT_MIN_DURATION,\n onProgress,\n } = options;\n\n const controller = onProgress\n ? createProgressController(minDuration, onProgress)\n : null;\n\n const startTime = Date.now();\n let result: T | undefined;\n let error: unknown;\n\n try {\n result = await task(controller?.updateReal ?? noop);\n } catch (e) {\n error = e;\n }\n\n const elapsed = Date.now() - startTime;\n const remaining = minDuration - elapsed;\n\n if (remaining > 0) {\n await sleep(remaining);\n }\n\n controller?.stop();\n\n if (error) throw error;\n return result as T;\n}\n\nfunction createProgressController(\n minDuration: number,\n onProgress: (p: number) => void,\n) {\n const start = Date.now();\n let lastPercent = 0;\n\n const update = (realPercent = 0) => {\n const elapsed = Date.now() - start;\n\n const easedPercent = Math.min(\n 99,\n Math.round((elapsed / minDuration) * 100),\n );\n\n const percent = Math.max(easedPercent, realPercent);\n\n if (percent > lastPercent && percent < 100) {\n lastPercent = percent;\n onProgress(percent);\n }\n };\n\n const interval = setInterval(update, 50);\n\n return {\n updateReal(event: ProgressEventLike) {\n const real = event.total\n ? Math.round((event.loaded! * 100) / event.total)\n : 0;\n\n update(real);\n },\n\n stop() {\n clearInterval(interval);\n onProgress(100);\n },\n };\n}\n\nfunction sleep(ms: number) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\n\nfunction noop() { }\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,IAAM,uBAAuB;AAWtB,SAAS,iBACd,MACA,MACA;AACA,MAAI,OAAO,SAAS,YAAY;AAC9B,WAAO,oBAAoB,MAAM,IAAI;AAAA,EACvC;AAEA,SAAO,CAAI,SAAkB,oBAAoB,MAAM,IAAI;AAC7D;AAEA,eAAe,oBACb,MACA,UAA2B,CAAC,GAChB;AACZ,QAAM;AAAA,IACJ,cAAc;AAAA,IACd;AAAA,EACF,IAAI;AAEJ,QAAM,aAAa,aACf,yBAAyB,aAAa,UAAU,IAChD;AAEJ,QAAM,YAAY,KAAK,IAAI;AAC3B,MAAI;AACJ,MAAI;AAEJ,MAAI;AACF,aAAS,MAAM,MAAK,yCAAY,eAAc,IAAI;AAAA,EACpD,SAAS,GAAG;AACV,YAAQ;AAAA,EACV;AAEA,QAAM,UAAU,KAAK,IAAI,IAAI;AAC7B,QAAM,YAAY,cAAc;AAEhC,MAAI,YAAY,GAAG;AACjB,UAAM,MAAM,SAAS;AAAA,EACvB;AAEA,2CAAY;AAEZ,MAAI,MAAO,OAAM;AACjB,SAAO;AACT;AAEA,SAAS,yBACP,aACA,YACA;AACA,QAAM,QAAQ,KAAK,IAAI;AACvB,MAAI,cAAc;AAElB,QAAM,SAAS,CAAC,cAAc,MAAM;AAClC,UAAM,UAAU,KAAK,IAAI,IAAI;AAE7B,UAAM,eAAe,KAAK;AAAA,MACxB;AAAA,MACA,KAAK,MAAO,UAAU,cAAe,GAAG;AAAA,IAC1C;AAEA,UAAM,UAAU,KAAK,IAAI,cAAc,WAAW;AAElD,QAAI,UAAU,eAAe,UAAU,KAAK;AAC1C,oBAAc;AACd,iBAAW,OAAO;AAAA,IACpB;AAAA,EACF;AAEA,QAAM,WAAW,YAAY,QAAQ,EAAE;AAEvC,SAAO;AAAA,IACL,WAAW,OAA0B;AACnC,YAAM,OAAO,MAAM,QACf,KAAK,MAAO,MAAM,SAAU,MAAO,MAAM,KAAK,IAC9C;AAEJ,aAAO,IAAI;AAAA,IACb;AAAA,IAEA,OAAO;AACL,oBAAc,QAAQ;AACtB,iBAAW,GAAG;AAAA,IAChB;AAAA,EACF;AACF;AAEA,SAAS,MAAM,IAAY;AACzB,SAAO,IAAI,QAAQ,aAAW,WAAW,SAAS,EAAE,CAAC;AACvD;AAEA,SAAS,OAAO;AAAE;","names":[]}
|
package/dist/index.mjs
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
// src/index.ts
|
|
2
2
|
var DEFAULT_MIN_DURATION = 2e3;
|
|
3
|
-
function
|
|
3
|
+
function withEaseProgress(arg1, arg2) {
|
|
4
4
|
if (typeof arg1 === "function") {
|
|
5
|
-
return
|
|
5
|
+
return runWithEaseProgress(arg1, arg2);
|
|
6
6
|
}
|
|
7
|
-
return (task) =>
|
|
7
|
+
return (task) => runWithEaseProgress(task, arg1);
|
|
8
8
|
}
|
|
9
|
-
async function
|
|
9
|
+
async function runWithEaseProgress(task, options = {}) {
|
|
10
10
|
const {
|
|
11
11
|
minDuration = DEFAULT_MIN_DURATION,
|
|
12
12
|
onProgress
|
|
@@ -62,6 +62,6 @@ function sleep(ms) {
|
|
|
62
62
|
function noop() {
|
|
63
63
|
}
|
|
64
64
|
export {
|
|
65
|
-
|
|
65
|
+
withEaseProgress
|
|
66
66
|
};
|
|
67
67
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ProgressEventLike = {\n loaded?: number;\n total?: number;\n};\n\nexport type ProgressHandler = (e: ProgressEventLike) => void;\n\nexport type Task<T> = (update: ProgressHandler) => Promise<T>;\n\nexport interface ProgressOptions {\n minDuration?: number;\n onProgress?: (percent: number) => void;\n}\n\nconst DEFAULT_MIN_DURATION = 2000;\n\nexport function
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ProgressEventLike = {\n loaded?: number;\n total?: number;\n};\n\nexport type ProgressHandler = (e: ProgressEventLike) => void;\n\nexport type Task<T> = (update: ProgressHandler) => Promise<T>;\n\nexport interface ProgressOptions {\n minDuration?: number;\n onProgress?: (percent: number) => void;\n}\n\nconst DEFAULT_MIN_DURATION = 2000;\n\nexport function withEaseProgress<T>(\n task: Task<T>,\n options?: ProgressOptions,\n): Promise<T>;\n\nexport function withEaseProgress(\n options: ProgressOptions,\n): <T>(task: Task<T>) => Promise<T>;\n\nexport function withEaseProgress<T>(\n arg1: Task<T> | ProgressOptions,\n arg2?: ProgressOptions,\n) {\n if (typeof arg1 === \"function\") {\n return runWithEaseProgress(arg1, arg2);\n }\n\n return <T>(task: Task<T>) => runWithEaseProgress(task, arg1);\n}\n\nasync function runWithEaseProgress<T>(\n task: Task<T>,\n options: ProgressOptions = {},\n): Promise<T> {\n const {\n minDuration = DEFAULT_MIN_DURATION,\n onProgress,\n } = options;\n\n const controller = onProgress\n ? createProgressController(minDuration, onProgress)\n : null;\n\n const startTime = Date.now();\n let result: T | undefined;\n let error: unknown;\n\n try {\n result = await task(controller?.updateReal ?? noop);\n } catch (e) {\n error = e;\n }\n\n const elapsed = Date.now() - startTime;\n const remaining = minDuration - elapsed;\n\n if (remaining > 0) {\n await sleep(remaining);\n }\n\n controller?.stop();\n\n if (error) throw error;\n return result as T;\n}\n\nfunction createProgressController(\n minDuration: number,\n onProgress: (p: number) => void,\n) {\n const start = Date.now();\n let lastPercent = 0;\n\n const update = (realPercent = 0) => {\n const elapsed = Date.now() - start;\n\n const easedPercent = Math.min(\n 99,\n Math.round((elapsed / minDuration) * 100),\n );\n\n const percent = Math.max(easedPercent, realPercent);\n\n if (percent > lastPercent && percent < 100) {\n lastPercent = percent;\n onProgress(percent);\n }\n };\n\n const interval = setInterval(update, 50);\n\n return {\n updateReal(event: ProgressEventLike) {\n const real = event.total\n ? Math.round((event.loaded! * 100) / event.total)\n : 0;\n\n update(real);\n },\n\n stop() {\n clearInterval(interval);\n onProgress(100);\n },\n };\n}\n\nfunction sleep(ms: number) {\n return new Promise(resolve => setTimeout(resolve, ms));\n}\n\nfunction noop() { }\n"],"mappings":";AAcA,IAAM,uBAAuB;AAWtB,SAAS,iBACd,MACA,MACA;AACA,MAAI,OAAO,SAAS,YAAY;AAC9B,WAAO,oBAAoB,MAAM,IAAI;AAAA,EACvC;AAEA,SAAO,CAAI,SAAkB,oBAAoB,MAAM,IAAI;AAC7D;AAEA,eAAe,oBACb,MACA,UAA2B,CAAC,GAChB;AACZ,QAAM;AAAA,IACJ,cAAc;AAAA,IACd;AAAA,EACF,IAAI;AAEJ,QAAM,aAAa,aACf,yBAAyB,aAAa,UAAU,IAChD;AAEJ,QAAM,YAAY,KAAK,IAAI;AAC3B,MAAI;AACJ,MAAI;AAEJ,MAAI;AACF,aAAS,MAAM,MAAK,yCAAY,eAAc,IAAI;AAAA,EACpD,SAAS,GAAG;AACV,YAAQ;AAAA,EACV;AAEA,QAAM,UAAU,KAAK,IAAI,IAAI;AAC7B,QAAM,YAAY,cAAc;AAEhC,MAAI,YAAY,GAAG;AACjB,UAAM,MAAM,SAAS;AAAA,EACvB;AAEA,2CAAY;AAEZ,MAAI,MAAO,OAAM;AACjB,SAAO;AACT;AAEA,SAAS,yBACP,aACA,YACA;AACA,QAAM,QAAQ,KAAK,IAAI;AACvB,MAAI,cAAc;AAElB,QAAM,SAAS,CAAC,cAAc,MAAM;AAClC,UAAM,UAAU,KAAK,IAAI,IAAI;AAE7B,UAAM,eAAe,KAAK;AAAA,MACxB;AAAA,MACA,KAAK,MAAO,UAAU,cAAe,GAAG;AAAA,IAC1C;AAEA,UAAM,UAAU,KAAK,IAAI,cAAc,WAAW;AAElD,QAAI,UAAU,eAAe,UAAU,KAAK;AAC1C,oBAAc;AACd,iBAAW,OAAO;AAAA,IACpB;AAAA,EACF;AAEA,QAAM,WAAW,YAAY,QAAQ,EAAE;AAEvC,SAAO;AAAA,IACL,WAAW,OAA0B;AACnC,YAAM,OAAO,MAAM,QACf,KAAK,MAAO,MAAM,SAAU,MAAO,MAAM,KAAK,IAC9C;AAEJ,aAAO,IAAI;AAAA,IACb;AAAA,IAEA,OAAO;AACL,oBAAc,QAAQ;AACtB,iBAAW,GAAG;AAAA,IAChB;AAAA,EACF;AACF;AAEA,SAAS,MAAM,IAAY;AACzB,SAAO,IAAI,QAAQ,aAAW,WAAW,SAAS,EAAE,CAAC;AACvD;AAEA,SAAS,OAAO;AAAE;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "with-ease-progress",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Smooth progress tracking for async tasks",
|
|
5
5
|
"main": "dist/index.cjs",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
8
|
-
"files": [
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
9
11
|
"scripts": {
|
|
10
12
|
"build": "tsup",
|
|
11
13
|
"dev": "tsup --watch"
|