@randajan/pulse 0.0.2 → 0.1.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/README.md +6 -3
- package/dist/cjs/index.cjs +31 -10
- package/dist/cjs/index.cjs.map +3 -3
- package/dist/esm/index.mjs +31 -10
- package/dist/esm/index.mjs.map +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,12 +60,15 @@ interface PulseMeta {
|
|
|
60
60
|
|
|
61
61
|
| Option | Type | Required | Default | Description |
|
|
62
62
|
| ----------- | ---------- | -------- | ------------------ | ------------------------------------------------------------------ |
|
|
63
|
-
| `
|
|
64
|
-
| `interval` | `number` | ✔︎ | — | Period in ms. Min **50 ms**, max **2 147 483 647 ms** (\~24 days). |
|
|
63
|
+
| `interval` | `number` | ✔︎ | — | Period in ms. Min **10 ms**, max **2 147 483 647 ms** (\~24 days). |
|
|
65
64
|
| `offset` | `number` | | `0` | Fixed shift applied to every pulse (0 ≤ offset < interval). |
|
|
66
65
|
| `getNow` | `function` | | `() => Date.now()` | Custom clock—handy for deterministic tests or time travel. |
|
|
67
|
-
| `onError` | `function` | | `() => {}` | Called when `onPulse` throws or rejects. |
|
|
68
66
|
| `autoStart` | `boolean` | | `false` | If `true`, the scheduler starts right after construction. |
|
|
67
|
+
| `noMeta` | `boolean` | | `false` | If `false`, the scheduler creates metadata `PuleMeta` at runtime |
|
|
68
|
+
| `onPulse` | `function` | ✔︎ | — | Async/sync callback executed on each pulse. Receives `PulseMeta`. |
|
|
69
|
+
| `onError` | `function` | | `() => {}` | Called when `onPulse` throws or rejects. |
|
|
70
|
+
| `afterPulse` | `function` | | `() => {}` | Async/sync callback executed after each pulse even if the onPulse raises an error. Receives `PulseMeta`. |
|
|
71
|
+
|
|
69
72
|
|
|
70
73
|
---
|
|
71
74
|
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -62,12 +62,12 @@ var validRange = (min, max, any, req = false, msg = "argument") => {
|
|
|
62
62
|
};
|
|
63
63
|
|
|
64
64
|
// src/Pulse.js
|
|
65
|
-
var createMetaData = (
|
|
65
|
+
var createMetaData = (getNow) => {
|
|
66
66
|
const p = {};
|
|
67
67
|
const w = [];
|
|
68
|
-
(0, import_props.solid)(p, "started",
|
|
69
|
-
(0, import_props.virtual)(p, "warnings", (
|
|
70
|
-
(0, import_props.virtual)(p, "runtime", (
|
|
68
|
+
(0, import_props.solid)(p, "started", getNow());
|
|
69
|
+
(0, import_props.virtual)(p, "warnings", (_) => [...w]);
|
|
70
|
+
(0, import_props.virtual)(p, "runtime", (_) => (p.ended ? p.ended : getNow()) - p.started);
|
|
71
71
|
(0, import_props.solid)(p, "warn", (warning) => w.push(warning), false);
|
|
72
72
|
return p;
|
|
73
73
|
};
|
|
@@ -82,11 +82,13 @@ var Pulse = class {
|
|
|
82
82
|
state: false
|
|
83
83
|
};
|
|
84
84
|
const onPulse = valid("function", options.onPulse, true, "options.onPulse");
|
|
85
|
-
const interval = validRange(
|
|
85
|
+
const interval = validRange(10, 2147483647, options.interval, true, "options.interval");
|
|
86
86
|
const offset = validRange(0, interval, options.offset, false, "options.offset") || 0;
|
|
87
87
|
const getNow = valid("function", options.getNow, false, "options.getNow") || ((_) => Date.now());
|
|
88
88
|
const onError = valid("function", options.onError, false, "options.onError") || blankFn;
|
|
89
|
+
const afterPulse = valid("function", options.afterPulse, false, "options.afterPulse") || blankFn;
|
|
89
90
|
const autoStart = valid("boolean", options.autoStart, false, "options.autoStart") || false;
|
|
91
|
+
const noMeta = valid("boolean", options.noMeta, false, "option.noMeta") || false;
|
|
90
92
|
_p.plan = async (_) => {
|
|
91
93
|
if (!_p.state || _p.metaData) {
|
|
92
94
|
return;
|
|
@@ -99,14 +101,33 @@ var Pulse = class {
|
|
|
99
101
|
if (!_p.state || _p.metaData) {
|
|
100
102
|
return;
|
|
101
103
|
}
|
|
102
|
-
_p.metaData = createMetaData();
|
|
104
|
+
const md = _p.metaData = noMeta ? void 0 : createMetaData(getNow);
|
|
105
|
+
let error;
|
|
103
106
|
try {
|
|
104
|
-
await onPulse(
|
|
107
|
+
const result = await onPulse(md);
|
|
108
|
+
if (md) {
|
|
109
|
+
(0, import_props.solid)(md, "result", result);
|
|
110
|
+
}
|
|
105
111
|
} catch (err) {
|
|
106
|
-
|
|
112
|
+
error = err;
|
|
113
|
+
if (md) {
|
|
114
|
+
(0, import_props.solid)(md, "error", err);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
if (md) {
|
|
118
|
+
(0, import_props.solid)(md, "ended", getNow());
|
|
119
|
+
}
|
|
120
|
+
if (error) {
|
|
121
|
+
onError(error, md);
|
|
122
|
+
}
|
|
123
|
+
try {
|
|
124
|
+
await afterPulse(md);
|
|
125
|
+
delete _p.metaData;
|
|
126
|
+
_p.plan();
|
|
127
|
+
} catch (err) {
|
|
128
|
+
_p.state = false;
|
|
129
|
+
throw err;
|
|
107
130
|
}
|
|
108
|
-
delete _p.metaData;
|
|
109
|
-
_p.plan();
|
|
110
131
|
};
|
|
111
132
|
(0, import_props.virtual)(this, "state", (_) => _p.state);
|
|
112
133
|
(0, import_props.solids)(this, {
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/index.js", "../../src/Pulse.js", "../../src/const.js", "../../src/tools.js"],
|
|
4
|
-
"sourcesContent": ["import { createPulse, Pulse } from \"./Pulse\";\n\nexport default createPulse;\n\nexport { createPulse, Pulse }\n", "import { solid, solids, virtual } from \"@randajan/props\";\r\nimport { blankFn, vault } from \"./const\";\r\nimport { valid, validRange } from \"./tools\";\r\n\r\n/**\r\n * Metadata object passed to every pulse callback.\r\n * @typedef {Object} PulseMeta\r\n * @property {Date} started Timestamp when this pulse began.\r\n * @property {string[]} warnings Snapshot of all warnings collected so far.\r\n * @property {number} runtime Milliseconds elapsed since `started`.\r\n * @property {(warning: string|Error) => void} warn Push a warning into the internal list.\r\n */\r\nconst createMetaData =
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAuC;;;ACGhC,IAAM,QAAQ,oBAAI,QAAQ;AAE1B,IAAM,UAAU,MAAI;AAAC;;;ACHrB,IAAM,KAAK,CAAC,MAAM,QAAM,OAAO,QAAQ;AAEvC,IAAM,QAAQ,CAAC,MAAM,KAAK,MAAI,OAAO,MAAI,eAAa;AACzD,MAAI,OAAO,MAAM;AACb,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,UAAM,IAAI,MAAM,GAAG,GAAG,oBAAoB,IAAI,GAAG;AAAA,EACrD;AACA,MAAI,GAAG,MAAM,GAAG,GAAG;AAAE,WAAO;AAAA,EAAK;AACjC,QAAM,IAAI,MAAM,GAAG,GAAG,mBAAmB,IAAI,GAAG;AACpD;AAEO,IAAM,aAAa,CAAC,KAAK,KAAK,KAAK,MAAI,OAAO,MAAI,eAAa;AAClE,QAAM,MAAM,MAAM,UAAU,KAAK,KAAK,GAAG;AACzC,MAAI,OAAO,MAAM;AAAE;AAAA,EAAQ;AAC3B,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,yBAAyB,GAAG,EAAE;AAAA,EAAG;AACxE,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,sBAAsB,GAAG,EAAE;AAAA,EAAG;AACrE,SAAO;AACX;;;AFPA,IAAM,iBAAiB,
|
|
6
|
-
"names": [
|
|
4
|
+
"sourcesContent": ["import { createPulse, Pulse } from \"./Pulse\";\n\nexport default createPulse;\n\nexport { createPulse, Pulse }\n", "import { solid, solids, virtual } from \"@randajan/props\";\r\nimport { blankFn, vault } from \"./const\";\r\nimport { valid, validRange } from \"./tools\";\r\n\r\n/**\r\n * Metadata object passed to every pulse callback.\r\n * @typedef {Object} PulseMeta\r\n * @property {Date} started Timestamp when this pulse began.\r\n * @property {string[]} warnings Snapshot of all warnings collected so far.\r\n * @property {number} runtime Milliseconds elapsed since `started`.\r\n * @property {(warning: string|Error) => void} warn Push a warning into the internal list.\r\n */\r\nconst createMetaData = (getNow) => {\r\n const p = {};\r\n const w = [];\r\n solid(p, \"started\", getNow());\r\n virtual(p, \"warnings\", _ => [...w]);\r\n virtual(p, \"runtime\", _ => (p.ended ? p.ended : getNow()) - p.started);\r\n solid(p, \"warn\", warning => w.push(warning), false);\r\n return p;\r\n}\r\n\r\n/**\r\n * Configuration object for {@link Pulse}.\r\n * @typedef {Object} PulseOptions\r\n * @property {(meta: PulseMeta) => (void|Promise<void>)} onPulse **required** \u2013 user callback invoked on every pulse.\r\n * @property {number} interval **required** \u2013 period length in ms (50 \u2013 2 147 483 647).\r\n * @property {number} [offset=0] Shift in ms applied to the start of each interval (0 \u2264 offset < interval).\r\n * @property {() => number} [getNow=() => Date.now()] Custom time source, useful for tests or time travel.\r\n * @property {(err: unknown) => void} [onError=blankFn] Error handler for exceptions or rejected `onPulse` promises.\r\n * @property {boolean} [autoStart=false] If true, the loop starts immediately after construction.\r\n */\r\n\r\n/**\r\n * Factory helper \u2013 simply calls `new Pulse(options)`.\r\n * @param {PulseOptions} [options={}] See {@link PulseOptions}.\r\n * @returns {Pulse}\r\n */\r\nexport const createPulse = (options = {}) => new Pulse(options);\r\n\r\n/**\r\n * Periodic scheduler that aligns each callback to exact multiples\r\n * of the given interval (optionally shifted by `offset`).\r\n */\r\nexport class Pulse {\r\n\r\n /**\r\n * Create a new Pulse instance.\r\n * @param {PulseOptions} [options={}] See {@link PulseOptions}.\r\n */\r\n constructor(options = {}) {\r\n const _p = {\r\n state: false,\r\n }\r\n\r\n const onPulse = valid(\"function\", options.onPulse, true, \"options.onPulse\");\r\n const interval = validRange(10, 2_147_483_647, options.interval, true, \"options.interval\");\r\n const offset = (validRange(0, interval, options.offset, false, \"options.offset\") || 0);\r\n const getNow = valid(\"function\", options.getNow, false, \"options.getNow\") || (_ => Date.now());\r\n const onError = valid(\"function\", options.onError, false, \"options.onError\") || blankFn;\r\n const afterPulse = valid(\"function\", options.afterPulse, false, \"options.afterPulse\") || blankFn;\r\n const autoStart = valid(\"boolean\", options.autoStart, false, \"options.autoStart\") || false;\r\n const noMeta = valid(\"boolean\", options.noMeta, false, \"option.noMeta\") || false;\r\n\r\n _p.plan = async _ => {\r\n if (!_p.state || _p.metaData) { return; }\r\n const now = getNow();\r\n const runIn = (interval - now % interval) + offset;\r\n _p.timeoutId = setTimeout(_p.run, runIn);\r\n }\r\n\r\n _p.run = async _ => {\r\n if (!_p.state || _p.metaData) { return; }\r\n\r\n const md = _p.metaData = noMeta ? undefined : createMetaData(getNow);\r\n let error;\r\n\r\n try {\r\n const result = await onPulse(md);\r\n if (md) { solid(md, \"result\", result); }\r\n }\r\n catch (err) {\r\n error = err;\r\n if (md) { solid(md, \"error\", err); }\r\n }\r\n\r\n if (md) { solid(md, \"ended\", getNow()); }\r\n if (error) { onError(error, md); }\r\n\r\n try {\r\n await afterPulse(md);\r\n delete _p.metaData;\r\n _p.plan();\r\n }\r\n catch(err) {\r\n _p.state = false;\r\n throw err;\r\n }\r\n }\r\n\r\n virtual(this, \"state\", _ => _p.state);\r\n solids(this, {\r\n interval,\r\n offset\r\n });\r\n\r\n vault.set(this, _p);\r\n\r\n process.on(\"exit\", _ => this.stop());\r\n if (autoStart) { this.start(); }\r\n }\r\n\r\n /**\r\n * Start the pulse loop (no-op if already running).\r\n * @returns {boolean} `true` if it started now, `false` if it was already running.\r\n */\r\n start() {\r\n const { state } = this;\r\n if (state) { return false; }\r\n const _p = vault.get(this);\r\n _p.state = true;\r\n _p.plan();\r\n return true;\r\n }\r\n\r\n /**\r\n * Stop the pulse loop (no-op if already stopped).\r\n * @returns {boolean} `true` if it stopped now, `false` if it was already stopped.\r\n */\r\n stop() {\r\n const { state } = this;\r\n if (!state) { return false; }\r\n const _p = vault.get(this);\r\n _p.state = false;\r\n clearTimeout(_p.timeoutId);\r\n return true;\r\n }\r\n\r\n\r\n}", "\r\n\r\n\r\nexport const vault = new WeakMap();\r\n\r\nexport const blankFn = ()=>{};", "\r\n\r\nexport const is = (type, any)=>typeof any === type;\r\n\r\nexport const valid = (type, any, req=false, msg=\"argument\")=>{\r\n if (any == null) {\r\n if (!req) { return; }\r\n throw new Error(`${msg} require typeof '${type}'`);\r\n }\r\n if (is(type, any)) { return any; }\r\n throw new Error(`${msg} is not typeof '${type}'`);\r\n}\r\n\r\nexport const validRange = (min, max, any, req=false, msg=\"argument\")=>{\r\n const num = valid(\"number\", any, req, msg);\r\n if (num == null) { return; }\r\n if (num < min) { throw new Error(`${msg} must be greater than ${min}`); }\r\n if (num > max) { throw new Error(`${msg} must be less than ${max}`); }\r\n return num;\r\n}"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAuC;;;ACGhC,IAAM,QAAQ,oBAAI,QAAQ;AAE1B,IAAM,UAAU,MAAI;AAAC;;;ACHrB,IAAM,KAAK,CAAC,MAAM,QAAM,OAAO,QAAQ;AAEvC,IAAM,QAAQ,CAAC,MAAM,KAAK,MAAI,OAAO,MAAI,eAAa;AACzD,MAAI,OAAO,MAAM;AACb,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,UAAM,IAAI,MAAM,GAAG,GAAG,oBAAoB,IAAI,GAAG;AAAA,EACrD;AACA,MAAI,GAAG,MAAM,GAAG,GAAG;AAAE,WAAO;AAAA,EAAK;AACjC,QAAM,IAAI,MAAM,GAAG,GAAG,mBAAmB,IAAI,GAAG;AACpD;AAEO,IAAM,aAAa,CAAC,KAAK,KAAK,KAAK,MAAI,OAAO,MAAI,eAAa;AAClE,QAAM,MAAM,MAAM,UAAU,KAAK,KAAK,GAAG;AACzC,MAAI,OAAO,MAAM;AAAE;AAAA,EAAQ;AAC3B,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,yBAAyB,GAAG,EAAE;AAAA,EAAG;AACxE,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,sBAAsB,GAAG,EAAE;AAAA,EAAG;AACrE,SAAO;AACX;;;AFPA,IAAM,iBAAiB,CAAC,WAAW;AAC/B,QAAM,IAAI,CAAC;AACX,QAAM,IAAI,CAAC;AACX,0BAAM,GAAG,WAAW,OAAO,CAAC;AAC5B,4BAAQ,GAAG,YAAY,OAAK,CAAC,GAAG,CAAC,CAAC;AAClC,4BAAQ,GAAG,WAAW,QAAM,EAAE,QAAQ,EAAE,QAAQ,OAAO,KAAK,EAAE,OAAO;AACrE,0BAAM,GAAG,QAAQ,aAAW,EAAE,KAAK,OAAO,GAAG,KAAK;AAClD,SAAO;AACX;AAkBO,IAAM,cAAc,CAAC,UAAU,CAAC,MAAM,IAAI,MAAM,OAAO;AAMvD,IAAM,QAAN,MAAY;AAAA;AAAA;AAAA;AAAA;AAAA,EAMf,YAAY,UAAU,CAAC,GAAG;AACtB,UAAM,KAAK;AAAA,MACP,OAAO;AAAA,IACX;AAEA,UAAM,UAAU,MAAM,YAAY,QAAQ,SAAS,MAAM,iBAAiB;AAC1E,UAAM,WAAW,WAAW,IAAI,YAAe,QAAQ,UAAU,MAAM,kBAAkB;AACzF,UAAM,SAAU,WAAW,GAAG,UAAU,QAAQ,QAAQ,OAAO,gBAAgB,KAAK;AACpF,UAAM,SAAS,MAAM,YAAY,QAAQ,QAAQ,OAAO,gBAAgB,MAAM,OAAK,KAAK,IAAI;AAC5F,UAAM,UAAU,MAAM,YAAY,QAAQ,SAAS,OAAO,iBAAiB,KAAK;AAChF,UAAM,aAAa,MAAM,YAAY,QAAQ,YAAY,OAAO,oBAAoB,KAAK;AACzF,UAAM,YAAY,MAAM,WAAW,QAAQ,WAAW,OAAO,mBAAmB,KAAK;AACrF,UAAM,SAAS,MAAM,WAAW,QAAQ,QAAQ,OAAO,eAAe,KAAK;AAE3E,OAAG,OAAO,OAAM,MAAK;AACjB,UAAI,CAAC,GAAG,SAAS,GAAG,UAAU;AAAE;AAAA,MAAQ;AACxC,YAAM,MAAM,OAAO;AACnB,YAAM,QAAS,WAAW,MAAM,WAAY;AAC5C,SAAG,YAAY,WAAW,GAAG,KAAK,KAAK;AAAA,IAC3C;AAEA,OAAG,MAAM,OAAM,MAAK;AAChB,UAAI,CAAC,GAAG,SAAS,GAAG,UAAU;AAAE;AAAA,MAAQ;AAExC,YAAM,KAAK,GAAG,WAAW,SAAS,SAAY,eAAe,MAAM;AACnE,UAAI;AAEJ,UAAI;AACA,cAAM,SAAS,MAAM,QAAQ,EAAE;AAC/B,YAAI,IAAI;AAAE,kCAAM,IAAI,UAAU,MAAM;AAAA,QAAG;AAAA,MAC3C,SACO,KAAK;AACR,gBAAQ;AACR,YAAI,IAAI;AAAE,kCAAM,IAAI,SAAS,GAAG;AAAA,QAAG;AAAA,MACvC;AAEA,UAAI,IAAI;AAAE,gCAAM,IAAI,SAAS,OAAO,CAAC;AAAA,MAAG;AACxC,UAAI,OAAO;AAAE,gBAAQ,OAAO,EAAE;AAAA,MAAG;AAEjC,UAAI;AACA,cAAM,WAAW,EAAE;AACnB,eAAO,GAAG;AACV,WAAG,KAAK;AAAA,MACZ,SACM,KAAK;AACP,WAAG,QAAQ;AACX,cAAM;AAAA,MACV;AAAA,IACJ;AAEA,8BAAQ,MAAM,SAAS,OAAK,GAAG,KAAK;AACpC,6BAAO,MAAM;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAED,UAAM,IAAI,MAAM,EAAE;AAElB,YAAQ,GAAG,QAAQ,OAAK,KAAK,KAAK,CAAC;AACnC,QAAI,WAAW;AAAE,WAAK,MAAM;AAAA,IAAG;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,QAAQ;AACJ,UAAM,EAAE,MAAM,IAAI;AAClB,QAAI,OAAO;AAAE,aAAO;AAAA,IAAO;AAC3B,UAAM,KAAK,MAAM,IAAI,IAAI;AACzB,OAAG,QAAQ;AACX,OAAG,KAAK;AACR,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO;AACH,UAAM,EAAE,MAAM,IAAI;AAClB,QAAI,CAAC,OAAO;AAAE,aAAO;AAAA,IAAO;AAC5B,UAAM,KAAK,MAAM,IAAI,IAAI;AACzB,OAAG,QAAQ;AACX,iBAAa,GAAG,SAAS;AACzB,WAAO;AAAA,EACX;AAGJ;;;ADzIA,IAAO,gBAAQ;",
|
|
6
|
+
"names": []
|
|
7
7
|
}
|
package/dist/esm/index.mjs
CHANGED
|
@@ -35,12 +35,12 @@ var validRange = (min, max, any, req = false, msg = "argument") => {
|
|
|
35
35
|
};
|
|
36
36
|
|
|
37
37
|
// src/Pulse.js
|
|
38
|
-
var createMetaData = (
|
|
38
|
+
var createMetaData = (getNow) => {
|
|
39
39
|
const p = {};
|
|
40
40
|
const w = [];
|
|
41
|
-
solid(p, "started",
|
|
42
|
-
virtual(p, "warnings", (
|
|
43
|
-
virtual(p, "runtime", (
|
|
41
|
+
solid(p, "started", getNow());
|
|
42
|
+
virtual(p, "warnings", (_) => [...w]);
|
|
43
|
+
virtual(p, "runtime", (_) => (p.ended ? p.ended : getNow()) - p.started);
|
|
44
44
|
solid(p, "warn", (warning) => w.push(warning), false);
|
|
45
45
|
return p;
|
|
46
46
|
};
|
|
@@ -55,11 +55,13 @@ var Pulse = class {
|
|
|
55
55
|
state: false
|
|
56
56
|
};
|
|
57
57
|
const onPulse = valid("function", options.onPulse, true, "options.onPulse");
|
|
58
|
-
const interval = validRange(
|
|
58
|
+
const interval = validRange(10, 2147483647, options.interval, true, "options.interval");
|
|
59
59
|
const offset = validRange(0, interval, options.offset, false, "options.offset") || 0;
|
|
60
60
|
const getNow = valid("function", options.getNow, false, "options.getNow") || ((_) => Date.now());
|
|
61
61
|
const onError = valid("function", options.onError, false, "options.onError") || blankFn;
|
|
62
|
+
const afterPulse = valid("function", options.afterPulse, false, "options.afterPulse") || blankFn;
|
|
62
63
|
const autoStart = valid("boolean", options.autoStart, false, "options.autoStart") || false;
|
|
64
|
+
const noMeta = valid("boolean", options.noMeta, false, "option.noMeta") || false;
|
|
63
65
|
_p.plan = async (_) => {
|
|
64
66
|
if (!_p.state || _p.metaData) {
|
|
65
67
|
return;
|
|
@@ -72,14 +74,33 @@ var Pulse = class {
|
|
|
72
74
|
if (!_p.state || _p.metaData) {
|
|
73
75
|
return;
|
|
74
76
|
}
|
|
75
|
-
_p.metaData = createMetaData();
|
|
77
|
+
const md = _p.metaData = noMeta ? void 0 : createMetaData(getNow);
|
|
78
|
+
let error;
|
|
76
79
|
try {
|
|
77
|
-
await onPulse(
|
|
80
|
+
const result = await onPulse(md);
|
|
81
|
+
if (md) {
|
|
82
|
+
solid(md, "result", result);
|
|
83
|
+
}
|
|
78
84
|
} catch (err) {
|
|
79
|
-
|
|
85
|
+
error = err;
|
|
86
|
+
if (md) {
|
|
87
|
+
solid(md, "error", err);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
if (md) {
|
|
91
|
+
solid(md, "ended", getNow());
|
|
92
|
+
}
|
|
93
|
+
if (error) {
|
|
94
|
+
onError(error, md);
|
|
95
|
+
}
|
|
96
|
+
try {
|
|
97
|
+
await afterPulse(md);
|
|
98
|
+
delete _p.metaData;
|
|
99
|
+
_p.plan();
|
|
100
|
+
} catch (err) {
|
|
101
|
+
_p.state = false;
|
|
102
|
+
throw err;
|
|
80
103
|
}
|
|
81
|
-
delete _p.metaData;
|
|
82
|
-
_p.plan();
|
|
83
104
|
};
|
|
84
105
|
virtual(this, "state", (_) => _p.state);
|
|
85
106
|
solids(this, {
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/Pulse.js", "../../src/const.js", "../../src/tools.js", "../../src/index.js"],
|
|
4
|
-
"sourcesContent": ["import { solid, solids, virtual } from \"@randajan/props\";\r\nimport { blankFn, vault } from \"./const\";\r\nimport { valid, validRange } from \"./tools\";\r\n\r\n/**\r\n * Metadata object passed to every pulse callback.\r\n * @typedef {Object} PulseMeta\r\n * @property {Date} started Timestamp when this pulse began.\r\n * @property {string[]} warnings Snapshot of all warnings collected so far.\r\n * @property {number} runtime Milliseconds elapsed since `started`.\r\n * @property {(warning: string|Error) => void} warn Push a warning into the internal list.\r\n */\r\nconst createMetaData =
|
|
5
|
-
"mappings": ";AAAA,SAAS,OAAO,QAAQ,eAAe;;;ACGhC,IAAM,QAAQ,oBAAI,QAAQ;AAE1B,IAAM,UAAU,MAAI;AAAC;;;ACHrB,IAAM,KAAK,CAAC,MAAM,QAAM,OAAO,QAAQ;AAEvC,IAAM,QAAQ,CAAC,MAAM,KAAK,MAAI,OAAO,MAAI,eAAa;AACzD,MAAI,OAAO,MAAM;AACb,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,UAAM,IAAI,MAAM,GAAG,GAAG,oBAAoB,IAAI,GAAG;AAAA,EACrD;AACA,MAAI,GAAG,MAAM,GAAG,GAAG;AAAE,WAAO;AAAA,EAAK;AACjC,QAAM,IAAI,MAAM,GAAG,GAAG,mBAAmB,IAAI,GAAG;AACpD;AAEO,IAAM,aAAa,CAAC,KAAK,KAAK,KAAK,MAAI,OAAO,MAAI,eAAa;AAClE,QAAM,MAAM,MAAM,UAAU,KAAK,KAAK,GAAG;AACzC,MAAI,OAAO,MAAM;AAAE;AAAA,EAAQ;AAC3B,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,yBAAyB,GAAG,EAAE;AAAA,EAAG;AACxE,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,sBAAsB,GAAG,EAAE;AAAA,EAAG;AACrE,SAAO;AACX;;;AFPA,IAAM,iBAAiB,
|
|
6
|
-
"names": [
|
|
4
|
+
"sourcesContent": ["import { solid, solids, virtual } from \"@randajan/props\";\r\nimport { blankFn, vault } from \"./const\";\r\nimport { valid, validRange } from \"./tools\";\r\n\r\n/**\r\n * Metadata object passed to every pulse callback.\r\n * @typedef {Object} PulseMeta\r\n * @property {Date} started Timestamp when this pulse began.\r\n * @property {string[]} warnings Snapshot of all warnings collected so far.\r\n * @property {number} runtime Milliseconds elapsed since `started`.\r\n * @property {(warning: string|Error) => void} warn Push a warning into the internal list.\r\n */\r\nconst createMetaData = (getNow) => {\r\n const p = {};\r\n const w = [];\r\n solid(p, \"started\", getNow());\r\n virtual(p, \"warnings\", _ => [...w]);\r\n virtual(p, \"runtime\", _ => (p.ended ? p.ended : getNow()) - p.started);\r\n solid(p, \"warn\", warning => w.push(warning), false);\r\n return p;\r\n}\r\n\r\n/**\r\n * Configuration object for {@link Pulse}.\r\n * @typedef {Object} PulseOptions\r\n * @property {(meta: PulseMeta) => (void|Promise<void>)} onPulse **required** \u2013 user callback invoked on every pulse.\r\n * @property {number} interval **required** \u2013 period length in ms (50 \u2013 2 147 483 647).\r\n * @property {number} [offset=0] Shift in ms applied to the start of each interval (0 \u2264 offset < interval).\r\n * @property {() => number} [getNow=() => Date.now()] Custom time source, useful for tests or time travel.\r\n * @property {(err: unknown) => void} [onError=blankFn] Error handler for exceptions or rejected `onPulse` promises.\r\n * @property {boolean} [autoStart=false] If true, the loop starts immediately after construction.\r\n */\r\n\r\n/**\r\n * Factory helper \u2013 simply calls `new Pulse(options)`.\r\n * @param {PulseOptions} [options={}] See {@link PulseOptions}.\r\n * @returns {Pulse}\r\n */\r\nexport const createPulse = (options = {}) => new Pulse(options);\r\n\r\n/**\r\n * Periodic scheduler that aligns each callback to exact multiples\r\n * of the given interval (optionally shifted by `offset`).\r\n */\r\nexport class Pulse {\r\n\r\n /**\r\n * Create a new Pulse instance.\r\n * @param {PulseOptions} [options={}] See {@link PulseOptions}.\r\n */\r\n constructor(options = {}) {\r\n const _p = {\r\n state: false,\r\n }\r\n\r\n const onPulse = valid(\"function\", options.onPulse, true, \"options.onPulse\");\r\n const interval = validRange(10, 2_147_483_647, options.interval, true, \"options.interval\");\r\n const offset = (validRange(0, interval, options.offset, false, \"options.offset\") || 0);\r\n const getNow = valid(\"function\", options.getNow, false, \"options.getNow\") || (_ => Date.now());\r\n const onError = valid(\"function\", options.onError, false, \"options.onError\") || blankFn;\r\n const afterPulse = valid(\"function\", options.afterPulse, false, \"options.afterPulse\") || blankFn;\r\n const autoStart = valid(\"boolean\", options.autoStart, false, \"options.autoStart\") || false;\r\n const noMeta = valid(\"boolean\", options.noMeta, false, \"option.noMeta\") || false;\r\n\r\n _p.plan = async _ => {\r\n if (!_p.state || _p.metaData) { return; }\r\n const now = getNow();\r\n const runIn = (interval - now % interval) + offset;\r\n _p.timeoutId = setTimeout(_p.run, runIn);\r\n }\r\n\r\n _p.run = async _ => {\r\n if (!_p.state || _p.metaData) { return; }\r\n\r\n const md = _p.metaData = noMeta ? undefined : createMetaData(getNow);\r\n let error;\r\n\r\n try {\r\n const result = await onPulse(md);\r\n if (md) { solid(md, \"result\", result); }\r\n }\r\n catch (err) {\r\n error = err;\r\n if (md) { solid(md, \"error\", err); }\r\n }\r\n\r\n if (md) { solid(md, \"ended\", getNow()); }\r\n if (error) { onError(error, md); }\r\n\r\n try {\r\n await afterPulse(md);\r\n delete _p.metaData;\r\n _p.plan();\r\n }\r\n catch(err) {\r\n _p.state = false;\r\n throw err;\r\n }\r\n }\r\n\r\n virtual(this, \"state\", _ => _p.state);\r\n solids(this, {\r\n interval,\r\n offset\r\n });\r\n\r\n vault.set(this, _p);\r\n\r\n process.on(\"exit\", _ => this.stop());\r\n if (autoStart) { this.start(); }\r\n }\r\n\r\n /**\r\n * Start the pulse loop (no-op if already running).\r\n * @returns {boolean} `true` if it started now, `false` if it was already running.\r\n */\r\n start() {\r\n const { state } = this;\r\n if (state) { return false; }\r\n const _p = vault.get(this);\r\n _p.state = true;\r\n _p.plan();\r\n return true;\r\n }\r\n\r\n /**\r\n * Stop the pulse loop (no-op if already stopped).\r\n * @returns {boolean} `true` if it stopped now, `false` if it was already stopped.\r\n */\r\n stop() {\r\n const { state } = this;\r\n if (!state) { return false; }\r\n const _p = vault.get(this);\r\n _p.state = false;\r\n clearTimeout(_p.timeoutId);\r\n return true;\r\n }\r\n\r\n\r\n}", "\r\n\r\n\r\nexport const vault = new WeakMap();\r\n\r\nexport const blankFn = ()=>{};", "\r\n\r\nexport const is = (type, any)=>typeof any === type;\r\n\r\nexport const valid = (type, any, req=false, msg=\"argument\")=>{\r\n if (any == null) {\r\n if (!req) { return; }\r\n throw new Error(`${msg} require typeof '${type}'`);\r\n }\r\n if (is(type, any)) { return any; }\r\n throw new Error(`${msg} is not typeof '${type}'`);\r\n}\r\n\r\nexport const validRange = (min, max, any, req=false, msg=\"argument\")=>{\r\n const num = valid(\"number\", any, req, msg);\r\n if (num == null) { return; }\r\n if (num < min) { throw new Error(`${msg} must be greater than ${min}`); }\r\n if (num > max) { throw new Error(`${msg} must be less than ${max}`); }\r\n return num;\r\n}", "import { createPulse, Pulse } from \"./Pulse\";\n\nexport default createPulse;\n\nexport { createPulse, Pulse }\n"],
|
|
5
|
+
"mappings": ";AAAA,SAAS,OAAO,QAAQ,eAAe;;;ACGhC,IAAM,QAAQ,oBAAI,QAAQ;AAE1B,IAAM,UAAU,MAAI;AAAC;;;ACHrB,IAAM,KAAK,CAAC,MAAM,QAAM,OAAO,QAAQ;AAEvC,IAAM,QAAQ,CAAC,MAAM,KAAK,MAAI,OAAO,MAAI,eAAa;AACzD,MAAI,OAAO,MAAM;AACb,QAAI,CAAC,KAAK;AAAE;AAAA,IAAQ;AACpB,UAAM,IAAI,MAAM,GAAG,GAAG,oBAAoB,IAAI,GAAG;AAAA,EACrD;AACA,MAAI,GAAG,MAAM,GAAG,GAAG;AAAE,WAAO;AAAA,EAAK;AACjC,QAAM,IAAI,MAAM,GAAG,GAAG,mBAAmB,IAAI,GAAG;AACpD;AAEO,IAAM,aAAa,CAAC,KAAK,KAAK,KAAK,MAAI,OAAO,MAAI,eAAa;AAClE,QAAM,MAAM,MAAM,UAAU,KAAK,KAAK,GAAG;AACzC,MAAI,OAAO,MAAM;AAAE;AAAA,EAAQ;AAC3B,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,yBAAyB,GAAG,EAAE;AAAA,EAAG;AACxE,MAAI,MAAM,KAAK;AAAE,UAAM,IAAI,MAAM,GAAG,GAAG,sBAAsB,GAAG,EAAE;AAAA,EAAG;AACrE,SAAO;AACX;;;AFPA,IAAM,iBAAiB,CAAC,WAAW;AAC/B,QAAM,IAAI,CAAC;AACX,QAAM,IAAI,CAAC;AACX,QAAM,GAAG,WAAW,OAAO,CAAC;AAC5B,UAAQ,GAAG,YAAY,OAAK,CAAC,GAAG,CAAC,CAAC;AAClC,UAAQ,GAAG,WAAW,QAAM,EAAE,QAAQ,EAAE,QAAQ,OAAO,KAAK,EAAE,OAAO;AACrE,QAAM,GAAG,QAAQ,aAAW,EAAE,KAAK,OAAO,GAAG,KAAK;AAClD,SAAO;AACX;AAkBO,IAAM,cAAc,CAAC,UAAU,CAAC,MAAM,IAAI,MAAM,OAAO;AAMvD,IAAM,QAAN,MAAY;AAAA;AAAA;AAAA;AAAA;AAAA,EAMf,YAAY,UAAU,CAAC,GAAG;AACtB,UAAM,KAAK;AAAA,MACP,OAAO;AAAA,IACX;AAEA,UAAM,UAAU,MAAM,YAAY,QAAQ,SAAS,MAAM,iBAAiB;AAC1E,UAAM,WAAW,WAAW,IAAI,YAAe,QAAQ,UAAU,MAAM,kBAAkB;AACzF,UAAM,SAAU,WAAW,GAAG,UAAU,QAAQ,QAAQ,OAAO,gBAAgB,KAAK;AACpF,UAAM,SAAS,MAAM,YAAY,QAAQ,QAAQ,OAAO,gBAAgB,MAAM,OAAK,KAAK,IAAI;AAC5F,UAAM,UAAU,MAAM,YAAY,QAAQ,SAAS,OAAO,iBAAiB,KAAK;AAChF,UAAM,aAAa,MAAM,YAAY,QAAQ,YAAY,OAAO,oBAAoB,KAAK;AACzF,UAAM,YAAY,MAAM,WAAW,QAAQ,WAAW,OAAO,mBAAmB,KAAK;AACrF,UAAM,SAAS,MAAM,WAAW,QAAQ,QAAQ,OAAO,eAAe,KAAK;AAE3E,OAAG,OAAO,OAAM,MAAK;AACjB,UAAI,CAAC,GAAG,SAAS,GAAG,UAAU;AAAE;AAAA,MAAQ;AACxC,YAAM,MAAM,OAAO;AACnB,YAAM,QAAS,WAAW,MAAM,WAAY;AAC5C,SAAG,YAAY,WAAW,GAAG,KAAK,KAAK;AAAA,IAC3C;AAEA,OAAG,MAAM,OAAM,MAAK;AAChB,UAAI,CAAC,GAAG,SAAS,GAAG,UAAU;AAAE;AAAA,MAAQ;AAExC,YAAM,KAAK,GAAG,WAAW,SAAS,SAAY,eAAe,MAAM;AACnE,UAAI;AAEJ,UAAI;AACA,cAAM,SAAS,MAAM,QAAQ,EAAE;AAC/B,YAAI,IAAI;AAAE,gBAAM,IAAI,UAAU,MAAM;AAAA,QAAG;AAAA,MAC3C,SACO,KAAK;AACR,gBAAQ;AACR,YAAI,IAAI;AAAE,gBAAM,IAAI,SAAS,GAAG;AAAA,QAAG;AAAA,MACvC;AAEA,UAAI,IAAI;AAAE,cAAM,IAAI,SAAS,OAAO,CAAC;AAAA,MAAG;AACxC,UAAI,OAAO;AAAE,gBAAQ,OAAO,EAAE;AAAA,MAAG;AAEjC,UAAI;AACA,cAAM,WAAW,EAAE;AACnB,eAAO,GAAG;AACV,WAAG,KAAK;AAAA,MACZ,SACM,KAAK;AACP,WAAG,QAAQ;AACX,cAAM;AAAA,MACV;AAAA,IACJ;AAEA,YAAQ,MAAM,SAAS,OAAK,GAAG,KAAK;AACpC,WAAO,MAAM;AAAA,MACT;AAAA,MACA;AAAA,IACJ,CAAC;AAED,UAAM,IAAI,MAAM,EAAE;AAElB,YAAQ,GAAG,QAAQ,OAAK,KAAK,KAAK,CAAC;AACnC,QAAI,WAAW;AAAE,WAAK,MAAM;AAAA,IAAG;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,QAAQ;AACJ,UAAM,EAAE,MAAM,IAAI;AAClB,QAAI,OAAO;AAAE,aAAO;AAAA,IAAO;AAC3B,UAAM,KAAK,MAAM,IAAI,IAAI;AACzB,OAAG,QAAQ;AACX,OAAG,KAAK;AACR,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO;AACH,UAAM,EAAE,MAAM,IAAI;AAClB,QAAI,CAAC,OAAO;AAAE,aAAO;AAAA,IAAO;AAC5B,UAAM,KAAK,MAAM,IAAI,IAAI;AACzB,OAAG,QAAQ;AACX,iBAAa,GAAG,SAAS;AACzB,WAAO;AAAA,EACX;AAGJ;;;AGzIA,IAAO,gBAAQ;",
|
|
6
|
+
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED