@ix-xs/node-comfort 2.1.1 → 2.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/CHANGELOG.md +135 -0
- package/README.md +2 -2
- package/package.json +2 -2
- package/src/Arr.js +13 -5
- package/src/Checker.js +56 -8
- package/src/Cli.js +60 -18
- package/src/Color.js +32 -6
- package/src/Crypto.js +429 -78
- package/src/Emitter.js +9 -9
- package/src/Env.js +90 -8
- package/src/FS.js +366 -56
- package/src/Http.js +263 -72
- package/src/Id.js +53 -15
- package/src/Logger.js +100 -22
- package/src/Num.js +2 -1
- package/src/Obj.js +225 -36
- package/src/SQLite.js +154 -97
- package/src/Schema.js +281 -40
- package/src/Str.js +77 -29
- package/src/Sys.js +123 -22
- package/src/Time.js +96 -22
- package/src/Utils.js +18 -3
- package/src/errors.js +75 -4
- package/src/internal/shared.js +68 -14
- package/src/internal/terminal.js +49 -0
- package/types/index.d.ts +28 -5
- package/types/src/Arr.d.ts +4 -2
- package/types/src/Arr.d.ts.map +1 -1
- package/types/src/Checker.d.ts +29 -3
- package/types/src/Checker.d.ts.map +1 -1
- package/types/src/Cli.d.ts +6 -4
- package/types/src/Cli.d.ts.map +1 -1
- package/types/src/Color.d.ts +2 -2
- package/types/src/Color.d.ts.map +1 -1
- package/types/src/Crypto.d.ts +126 -28
- package/types/src/Crypto.d.ts.map +1 -1
- package/types/src/Emitter.d.ts +6 -6
- package/types/src/Emitter.d.ts.map +1 -1
- package/types/src/Env.d.ts +19 -1
- package/types/src/Env.d.ts.map +1 -1
- package/types/src/FS.d.ts +27 -20
- package/types/src/FS.d.ts.map +1 -1
- package/types/src/Http.d.ts +42 -5
- package/types/src/Http.d.ts.map +1 -1
- package/types/src/Id.d.ts.map +1 -1
- package/types/src/Logger.d.ts +11 -3
- package/types/src/Logger.d.ts.map +1 -1
- package/types/src/Num.d.ts.map +1 -1
- package/types/src/Obj.d.ts +15 -2
- package/types/src/Obj.d.ts.map +1 -1
- package/types/src/SQLite.d.ts +104 -12
- package/types/src/SQLite.d.ts.map +1 -1
- package/types/src/Schema.d.ts +61 -5
- package/types/src/Schema.d.ts.map +1 -1
- package/types/src/Str.d.ts +32 -7
- package/types/src/Str.d.ts.map +1 -1
- package/types/src/Sys.d.ts +42 -9
- package/types/src/Sys.d.ts.map +1 -1
- package/types/src/Time.d.ts +10 -5
- package/types/src/Time.d.ts.map +1 -1
- package/types/src/Utils.d.ts +16 -6
- package/types/src/Utils.d.ts.map +1 -1
- package/types/src/errors.d.ts +6 -2
- package/types/src/errors.d.ts.map +1 -1
- package/types/src/internal/shared.d.ts +7 -0
- package/types/src/internal/shared.d.ts.map +1 -1
- package/types/src/internal/terminal.d.ts +13 -0
- package/types/src/internal/terminal.d.ts.map +1 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Crypto.d.ts","sourceRoot":"","sources":["../../src/Crypto.js"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"Crypto.d.ts","sourceRoot":"","sources":["../../src/Crypto.js"],"names":[],"mappings":";;;6BA2Da,KAAK,GAAG,QAAQ,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAyC9B,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,aAAa,EAAE,SAAS,GAAG,OAAO,aAAa,EAAE,UAAU;;;;;;;;eAMhG,MAAM;;;;gBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAmBP,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAkC9H,CAAC;YAED;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE;aACrD,CAAC,GAAG,SAAS;;;;eACb,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BN,MAAM;;;;;;;;;;;;;;;;;;;;;2BAqfP;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,GAAG;IAAE,MAAM,CAAC,EAAE,SAAS,CAAC;IAAC,GAAG,EAAE,OAAO,aAAa,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE;AAtYzL;;;;;;;;;;GAUG;AACH,2BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,WAAW,GACT,MAAM,CAIlB;AAED;;;;;;;;;;;;GAYG;AACH,2BALW,MAAM,GAAG,MAAM,GAAG,UAAU,UAC5B,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,WAAW,GACT,MAAM,CAOlB;AAED;;;;;;;;;;;;;;;GAeG;AACH,iCANW,MAAM,GAAG,MAAM,GAAG,UAAU,aAC5B,OAAO,UACP,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,WAAW,GACT,OAAO,CAOnB;AAED;;;;;;;;;;;;;GAaG;AACH,6BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,KAC5B,MAAM,GAAG,MAAM,GAAG,UAAU,GAC1B,OAAO,CASnB;AAiDD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,uCANW,MAAM,YACN,mBAAmB,GACjB,OAAO,CAAC,MAAM,CAAC,CAkC3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,yCANW,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAqC5B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,oCAJW,MAAM,YACN,mBAAmB,GACjB,OAAO,CA2BnB;AAED;;;;;GAKG;AACH,+BAFa,MAAM,CAIlB;AAYD;;;;;;;;;;;;;;;;GAgBG;AACH,8BALW,MAAM,GAAG,MAAM,GAAG,UAAU,UAC5B,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,cAAc,GACZ,MAAM,CAYlB;;;;;;;;;;;;;;;AAUE,iCACQ,MAAM,UACN,MAAM,GAAG,MAAM,GAAG,UAAU,WAC5B,cAAc,GAAG;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,GACnC,MAAM,CAClB;;;;;;;;;;AAIE,iCACQ,MAAM,UACN,MAAM,GAAG,MAAM,GAAG,UAAU,yCAE1B,MAAM,CAClB;AA0VD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iCANW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UACvB,MAAM,YACN,cAAc,GACZ,MAAM,CAsBlB;AAED;;;;;;;;;;;GAWG;AACH,0BALc,CAAC,mCACJ,MAAM,GACJ,UAAU,CAAC,CAAC,CAAC,CAMzB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,0BARc,CAAC,mCACJ,MAAM,UACN,MAAM,YACN,gBAAgB,GACd,CAAC,GAAG,SAAS,CAqDzB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,4CAJW,OAAO,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,YAClD;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,GACxB,OAAO,CAAC,OAAO,CAAC,CAoB5B;AAED;;;;;;;;;;GAUG;AACH,mCAJW,MAAM,GACJ,MAAM,CAMlB;AA6CD;;;;;;;;;;;GAWG;AACH,6BALW,MAAM,YACN,WAAW,GACT,MAAM,CAMlB;AA4CD;;;;;;;;;;;;;;;;;GAiBG;AACH,kCAPW,MAAM,UACN,MAAM,YACN,iBAAiB,GACf,OAAO,CAMnB;AA9DD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,+BAPW,MAAM,UACN,MAAM,YACN,iBAAiB,GACf,MAAM,GAAG,SAAS,CAwB9B;AAwBD;;;;;;;;;GASG;AACH,gCAJW,MAAM,WACN,cAAc,GACZ,MAAM,CAUlB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;;GAWG;AACH,+BAJW,MAAM,OACN,MAAM,GACJ,MAAM,CAOlB;AAED;;;;;;;;;;GAUG;AACH,+BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACnB,MAAM,CAIlB;;;;;;;;;;;;;AASE,iCACQ,MAAM,WACN;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,GAClB,MAAM,CAClB;;;;;;;;;AAIE,iCACQ,MAAM;aACK,MAAM;gBACf,MAAM,CAClB"}
|
package/types/src/Emitter.d.ts
CHANGED
|
@@ -22,9 +22,9 @@ declare class Emitter<Events extends EventMap = EventMap> {
|
|
|
22
22
|
* @param {K} event
|
|
23
23
|
* @param {(...args: Events[K]) => unknown} listener
|
|
24
24
|
* @param {ListenOptions} [options]
|
|
25
|
-
* @returns {() => void} Removes the listener.
|
|
25
|
+
* @returns {(() => void) & Disposable} Removes the listener. With `using`, at the end of the block.
|
|
26
26
|
*/
|
|
27
|
-
on<K extends keyof Events & string>(event: K, listener: (...args: Events[K]) => unknown, options?: ListenOptions): () => void;
|
|
27
|
+
on<K extends keyof Events & string>(event: K, listener: (...args: Events[K]) => unknown, options?: ListenOptions): (() => void) & Disposable;
|
|
28
28
|
/**
|
|
29
29
|
* Listens to an event once.
|
|
30
30
|
*
|
|
@@ -32,9 +32,9 @@ declare class Emitter<Events extends EventMap = EventMap> {
|
|
|
32
32
|
* @param {K} event
|
|
33
33
|
* @param {(...args: Events[K]) => unknown} listener
|
|
34
34
|
* @param {ListenOptions} [options]
|
|
35
|
-
* @returns {() => void} Removes the listener if it hasn't run yet.
|
|
35
|
+
* @returns {(() => void) & Disposable} Removes the listener if it hasn't run yet. With `using`, at the end of the block.
|
|
36
36
|
*/
|
|
37
|
-
once<K extends keyof Events & string>(event: K, listener: (...args: Events[K]) => unknown, options?: ListenOptions): () => void;
|
|
37
|
+
once<K extends keyof Events & string>(event: K, listener: (...args: Events[K]) => unknown, options?: ListenOptions): (() => void) & Disposable;
|
|
38
38
|
/**
|
|
39
39
|
* Listens to every event; the listener gets the event name first. Handy for
|
|
40
40
|
* logging.
|
|
@@ -43,9 +43,9 @@ declare class Emitter<Events extends EventMap = EventMap> {
|
|
|
43
43
|
* emitter.onAny((event, ...args) => nc.debug(event, args));
|
|
44
44
|
*
|
|
45
45
|
* @param {(event: keyof Events & string, ...args: any[]) => unknown} listener
|
|
46
|
-
* @returns {() => void} Removes the listener.
|
|
46
|
+
* @returns {(() => void) & Disposable} Removes the listener. With `using`, at the end of the block.
|
|
47
47
|
*/
|
|
48
|
-
onAny(listener: (event: keyof Events & string, ...args: any[]) => unknown): () => void;
|
|
48
|
+
onAny(listener: (event: keyof Events & string, ...args: any[]) => unknown): (() => void) & Disposable;
|
|
49
49
|
/**
|
|
50
50
|
* Removes a listener, or all listeners of the event if you don't pass one.
|
|
51
51
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Emitter.d.ts","sourceRoot":"","sources":["../../src/Emitter.js"],"names":[],"mappings":";AAiDA;;;;;GAKG;AACH,sBAFyB,MAAM,SAAjB,QAAS;IA0CrB;;;;;;;;;;;;;;;;;OAiBG;IACH,GANqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,YACD,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,YAC/B,aAAa,GACX,MAAM,IAAI,
|
|
1
|
+
{"version":3,"file":"Emitter.d.ts","sourceRoot":"","sources":["../../src/Emitter.js"],"names":[],"mappings":";AAiDA;;;;;GAKG;AACH,sBAFyB,MAAM,SAAjB,QAAS;IA0CrB;;;;;;;;;;;;;;;;;OAiBG;IACH,GANqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,YACD,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,YAC/B,aAAa,GACX,CAAC,MAAM,IAAI,CAAC,GAAG,UAAU,CAIrC;IAED;;;;;;;;OAQG;IACH,KANqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,YACD,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,YAC/B,aAAa,GACX,CAAC,MAAM,IAAI,CAAC,GAAG,UAAU,CAWrC;IAED;;;;;;;;;OASG;IACH,gBAHW,CAAC,KAAK,EAAE,MAAM,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,GACvD,CAAC,MAAM,IAAI,CAAC,GAAG,UAAU,CAOrC;IAED;;;;;;;OAOG;IACH,IALqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,aACD,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,GAC7B,IAAI,CAMhB;IAED;;;;;;;;;;;OAWG;IACH,KALqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,WACD,MAAM,CAAC,CAAC,CAAC,GACP,OAAO,CAQnB;IAED;;;;;;;;;;;OAWG;IACH,UALqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,WACD,MAAM,CAAC,CAAC,CAAC,GACP,OAAO,CAAC,OAAO,EAAE,CAAC,CAQ9B;IAED;;;;;;;;;;;;;OAaG;IACH,QAPqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,YACD,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAgC9B;IAED;;;;;;;;;;;;;OAaG;IACH,QALqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GACtB,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAsC5C;IAED;;;;;;OAMG;IACH,sBAHW,MAAM,MAAM,GAAG,MAAM,GACnB,MAAM,CAOlB;IAED;;;;;;;OAOG;IACH,UAJqC,CAAC,SAAxB,MAAM,MAAM,GAAG,MAAO,SACzB,CAAC,GACC,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAIlD;IAED;;;;OAIG;IACH,cAFa,KAAK,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,CAIxC;IAED;;;;;OAKG;IACH,cAHW,MAAM,MAAM,GAAG,MAAM,GACnB,IAAI,CAShB;;CACF;;;;;;;;gBA3UY,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;;;;;;;;;;;;;oBAWb,CAAC,SAAR,GAAG,EAAG;;;;;;;;;;;;wBAII,CAAC,KAAK,OAAO;;;;;;uBAMxB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG;IAAE,QAAQ,CAAC,WAAU;CAAE"}
|
package/types/src/Env.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ type EnvParseOptions = {
|
|
|
58
58
|
*/
|
|
59
59
|
expand?: boolean | undefined;
|
|
60
60
|
/**
|
|
61
|
-
* Other variables usable in expansions. Defaults to `process.env
|
|
61
|
+
* Other variables usable in expansions. Defaults to none: a reference resolves only from the text itself, so parsing a file you don't trust can't copy your secrets into it. Pass `process.env` to read from it.
|
|
62
62
|
*/
|
|
63
63
|
env?: Record<string, string | undefined> | undefined;
|
|
64
64
|
};
|
|
@@ -157,14 +157,18 @@ type EnvConfig<T extends Record<string, EnvVarSpec>> = { -readonly [K in keyof T
|
|
|
157
157
|
/**
|
|
158
158
|
* Parses the text of a `.env` file: quotes, multi-line values, `export`,
|
|
159
159
|
* comments, escapes, and `${VAR}` expansion (except in single quotes).
|
|
160
|
+
* References resolve from the text itself and from `env`, never from
|
|
161
|
+
* `process.env` unless you pass it.
|
|
160
162
|
*
|
|
161
163
|
* @example
|
|
162
164
|
* env.parse('PORT=3000\nURL="http://localhost:${PORT}"');
|
|
163
165
|
* // { PORT: "3000", URL: "http://localhost:3000" }
|
|
166
|
+
* env.parse("HOME_COPY=${HOME}", { env: process.env });
|
|
164
167
|
*
|
|
165
168
|
* @param {string} content
|
|
166
169
|
* @param {EnvParseOptions} [options]
|
|
167
170
|
* @returns {Record<string, string>}
|
|
171
|
+
* @throws {RangeError} If references make one value grow past 64 KB, as with variables that each use the one before several times.
|
|
168
172
|
*/
|
|
169
173
|
declare function parse(content: string, options?: EnvParseOptions): Record<string, string>;
|
|
170
174
|
/**
|
|
@@ -173,6 +177,20 @@ declare function parse(content: string, options?: EnvParseOptions): Record<strin
|
|
|
173
177
|
* `override`. The `.env` loaded by itself at startup doesn't count as
|
|
174
178
|
* already set: `.env.local` wins over it, as you'd expect.
|
|
175
179
|
*
|
|
180
|
+
* The load at startup leaves out the variables that can run code or weaken
|
|
181
|
+
* TLS, and says so on stderr: `NODE_OPTIONS`, `NODE_TLS_REJECT_UNAUTHORIZED`,
|
|
182
|
+
* `NODE_EXTRA_CA_CERTS`, `NODE_PATH`, `NODE_REDIRECT_WARNINGS`,
|
|
183
|
+
* `NODE_REPL_EXTERNAL_MODULE`, `NODE_USE_ENV_PROXY`, `LD_PRELOAD`,
|
|
184
|
+
* `LD_LIBRARY_PATH`, `LD_AUDIT`,
|
|
185
|
+
* `DYLD_*`, `GIT_SSH_COMMAND`, `GIT_SSH`, `GIT_ASKPASS`, `GIT_EXEC_PATH`,
|
|
186
|
+
* `GIT_CONFIG*`, `GIT_PROXY_COMMAND`, `GIT_EXTERNAL_DIFF`, `GIT_TEMPLATE_DIR`,
|
|
187
|
+
* `GIT_PAGER`, `GIT_EDITOR`, `GIT_SEQUENCE_EDITOR`, `PAGER`, `EDITOR`,
|
|
188
|
+
* `VISUAL`, `SSH_ASKPASS`, `PATH`, `PATHEXT`,
|
|
189
|
+
* `ComSpec`, `BASH_ENV`, `PROMPT_COMMAND`, `PERL5OPT`,
|
|
190
|
+
* `PYTHONSTARTUP`, `PYTHONPATH`, `RUBYOPT`, `JAVA_TOOL_OPTIONS` and
|
|
191
|
+
* `_JAVA_OPTIONS`. A call to `load()` loads them all: don't make one on a
|
|
192
|
+
* file you don't trust, such as the `.env` of a repository someone sent you.
|
|
193
|
+
*
|
|
176
194
|
* @example
|
|
177
195
|
* env.load(); // ./.env
|
|
178
196
|
* env.load([".env.local", ".env"]); // local values win
|
package/types/src/Env.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Env.d.ts","sourceRoot":"","sources":["../../src/Env.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA6Ca,CAAC;;;;;;;;;;;;;;;;;;kBAWD,CACZ;IAAM,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACxH;IAAM,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjI;IAAM,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACpF;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAChF;IAAM,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACrG;IAAM,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjF;IAAM,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7F;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjF;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CACxG;;;;iBAKsB,CAAC,SAAb,UAAW,IACZ,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GAAG,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS;IAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,GAAG,MAAM;;;;eAKrM,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,IAC5B,EAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAE;
|
|
1
|
+
{"version":3,"file":"Env.d.ts","sourceRoot":"","sources":["../../src/Env.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA6Ca,CAAC;;;;;;;;;;;;;;;;;;kBAWD,CACZ;IAAM,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACxH;IAAM,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjI;IAAM,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACpF;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAChF;IAAM,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACrG;IAAM,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjF;IAAM,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7F;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACjF;IAAM,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CACxG;;;;iBAKsB,CAAC,SAAb,UAAW,IACZ,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GAAG,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS;IAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,GAAG,MAAM;;;;eAKrM,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,IAC5B,EAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAE;AA2H9H;;;;;;;;;;;;;;;GAeG;AACH,gCALW,MAAM,YACN,eAAe,GACb,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKlC;AAkID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,8BALW,MAAM,GAAG,MAAM,EAAE,YACjB,cAAc,GACZ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA0DlC;AAED;;;;;;;;;GASG;AACH,2BAJW,MAAM,aACN,MAAM,GACJ,MAAM,GAAG,SAAS,CAI9B;AAED;;;;;GAKG;AACH,2BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,gCAJW,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,8BALW,MAAM,YACN,gBAAgB,CAAC,MAAM,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACjE,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,8BALW,MAAM,YACN,gBAAgB,CAAC,MAAM,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1E,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,4BALW,MAAM,YACN,gBAAgB,CAAC,OAAO,CAAC,GACvB,OAAO,CAKnB;AAED;;;;;;;;;;GAUG;AACH,4BALW,MAAM,YACN,gBAAgB,CAAC,MAAM,CAAC,GACtB,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,2BALW,MAAM,YACN,gBAAgB,CAAC,MAAM,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GACjD,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,gCALW,MAAM,YACN,gBAAgB,CAAC,MAAM,GAAG,MAAM,CAAC,GAC/B,MAAM,CAKlB;AAED;;;;;;;;;;;GAWG;AACH,4BALW,MAAM,YACN,gBAAgB,CAAC,MAAM,EAAE,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD,MAAM,EAAE,CAKpB;AAED;;;;;;;;;;;GAWG;AACH,sBANc,CAAC,cACJ,MAAM,YACN,gBAAgB,CAAC,CAAC,CAAC,GACjB,CAAC,CAKb;AAED;;;;;;;;;;;;;GAaG;AACH,uBAPsB,CAAC,SAAV,MAAQ,QACV,MAAM,UACN,SAAS,CAAC,EAAE,YACZ,gBAAgB,CAAC,CAAC,CAAC,GACjB,CAAC,CAKb;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,0BAN0C,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,QAC9B,CAAC,YACD;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;CAAE,GACzB,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAmBlC;AAYD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,+BAHW,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GACxB,MAAM,CAelB;AAED;;;;GAIG;AACH,yBAFa,MAAM,CAIlB;AAED;;;GAGG;AACH,iCAFa,OAAO,CAInB;AAED;;;GAGG;AACH,kCAFa,OAAO,CAInB;AAED;;;;GAIG;AACH,2BAFa,OAAO,CAInB"}
|
package/types/src/FS.d.ts
CHANGED
|
@@ -255,9 +255,10 @@ export type WatchOptions = {
|
|
|
255
255
|
debounce?: string | number | undefined;
|
|
256
256
|
};
|
|
257
257
|
/**
|
|
258
|
-
* Returned by `watch()`.
|
|
258
|
+
* Returned by `watch()`. With `using`, the watch stops at the end of the block.
|
|
259
259
|
*/
|
|
260
|
-
export type Watcher =
|
|
260
|
+
export type Watcher = _WatcherMethods & Disposable;
|
|
261
|
+
export type _WatcherMethods = {
|
|
261
262
|
/**
|
|
262
263
|
* Listens for changes. `"all"` also gets the event name. `"error"` tells you the watch broke, for instance because the folder was deleted.
|
|
263
264
|
*/
|
|
@@ -378,7 +379,7 @@ export function find(name: string, options?: FindOptions): string | undefined;
|
|
|
378
379
|
* nc.findUp(["pnpm-lock.yaml", "yarn.lock", "package-lock.json"]);
|
|
379
380
|
*
|
|
380
381
|
* @param {string | string[]} name One name, or several to try in each folder, in this order.
|
|
381
|
-
* @param {{ cwd?: string, type?: "file" | "folder" | "any", stopAt?: string }} [options] Where to start (the working directory by default), what to look for (`"any"` by default), and a folder not to go above.
|
|
382
|
+
* @param {{ cwd?: string, type?: "file" | "folder" | "any", stopAt?: string }} [options] Where to start (the working directory by default), what to look for (`"any"` by default), and a folder not to go above: the search ends there, or as soon as it's outside of it.
|
|
382
383
|
* @returns {string | undefined} The absolute path.
|
|
383
384
|
*/
|
|
384
385
|
export function findUp(name: string | string[], options?: {
|
|
@@ -572,14 +573,17 @@ export function deleteFoldersIn(path?: string, filter?: (folder: string) => bool
|
|
|
572
573
|
*/
|
|
573
574
|
export function deleteFilesIn(path?: string, recursive?: boolean, filter?: (file: string) => boolean): number | undefined;
|
|
574
575
|
/**
|
|
575
|
-
* Deletes everything inside a folder, keeping the folder.
|
|
576
|
+
* Deletes everything inside a folder, keeping the folder. A link to a folder
|
|
577
|
+
* (a junction on Windows) is refused: what it points to is left alone.
|
|
576
578
|
*
|
|
577
579
|
* @param {string} path
|
|
578
|
-
* @returns {boolean | undefined} `undefined` if it doesn't exist.
|
|
580
|
+
* @returns {boolean | undefined} `undefined` if it doesn't exist, `false` if it's a link or something couldn't be deleted.
|
|
579
581
|
*/
|
|
580
582
|
export function emptyFolder(path: string): boolean | undefined;
|
|
581
583
|
/**
|
|
582
|
-
* Copies a file or a whole folder, like `cp -r`.
|
|
584
|
+
* Copies a file or a whole folder, like `cp -r`. Links inside the folder
|
|
585
|
+
* are copied as links (junctions on Windows), never followed: files outside
|
|
586
|
+
* the folder are never brought along.
|
|
583
587
|
*
|
|
584
588
|
* @example
|
|
585
589
|
* nc.copy("./templates", "./dist/templates");
|
|
@@ -588,11 +592,12 @@ export function emptyFolder(path: string): boolean | undefined;
|
|
|
588
592
|
* @param {string} source
|
|
589
593
|
* @param {string} destination
|
|
590
594
|
* @param {CopyOptions} [options]
|
|
591
|
-
* @returns {boolean} `false` if the source is missing or the copy failed.
|
|
595
|
+
* @returns {boolean} `false` if the source is missing, if the destination is the source or inside it, or if the copy failed.
|
|
592
596
|
*/
|
|
593
597
|
export function copy(source: string, destination: string, options?: CopyOptions): boolean;
|
|
594
598
|
/**
|
|
595
|
-
* Moves or renames a file or folder, across drives too.
|
|
599
|
+
* Moves or renames a file or folder, across drives too. A destination in the
|
|
600
|
+
* way is put aside first, and put back if the move fails.
|
|
596
601
|
*
|
|
597
602
|
* @example
|
|
598
603
|
* nc.move("./report.pdf", "./archive/2024/report.pdf");
|
|
@@ -600,7 +605,7 @@ export function copy(source: string, destination: string, options?: CopyOptions)
|
|
|
600
605
|
* @param {string} source
|
|
601
606
|
* @param {string} destination
|
|
602
607
|
* @param {{ overwrite?: boolean }} [options] `overwrite` replaces an existing destination. Defaults to `true`.
|
|
603
|
-
* @returns {boolean}
|
|
608
|
+
* @returns {boolean} `false` if the source is missing, if the destination is inside it, if the source is a link to the destination, or if the move failed.
|
|
604
609
|
*/
|
|
605
610
|
export function move(source: string, destination: string, options?: {
|
|
606
611
|
overwrite?: boolean;
|
|
@@ -610,7 +615,7 @@ export function move(source: string, destination: string, options?: {
|
|
|
610
615
|
* for most cases.
|
|
611
616
|
*
|
|
612
617
|
* @param {CopyFoldersOptions} options
|
|
613
|
-
* @returns {number | undefined} How many were copied.
|
|
618
|
+
* @returns {number | undefined} How many were copied: `0` when `dest` is the source folder or inside it.
|
|
614
619
|
*/
|
|
615
620
|
export function copyFoldersIn(options: CopyFoldersOptions): number | undefined;
|
|
616
621
|
/**
|
|
@@ -618,7 +623,7 @@ export function copyFoldersIn(options: CopyFoldersOptions): number | undefined;
|
|
|
618
623
|
* folder is created; `copy()` copies everything in one call.
|
|
619
624
|
*
|
|
620
625
|
* @param {CopyFolderOptions} options
|
|
621
|
-
* @returns {boolean | undefined}
|
|
626
|
+
* @returns {boolean | undefined} `false` when `dest` is the source folder or inside it.
|
|
622
627
|
*/
|
|
623
628
|
export function copyFolder(options: CopyFolderOptions): boolean | undefined;
|
|
624
629
|
/**
|
|
@@ -628,7 +633,7 @@ export function copyFolder(options: CopyFolderOptions): boolean | undefined;
|
|
|
628
633
|
* nc.copyFilesIn({ path: "./src", dest: "./dist", filter: (file) => file.endsWith(".css") });
|
|
629
634
|
*
|
|
630
635
|
* @param {CopyFilesOptions} options
|
|
631
|
-
* @returns {number | undefined} How many were copied
|
|
636
|
+
* @returns {number | undefined} How many were copied: `0` when `dest` is the source folder, or inside it with `recursive`.
|
|
632
637
|
*/
|
|
633
638
|
export function copyFilesIn(options: CopyFilesOptions): number | undefined;
|
|
634
639
|
/**
|
|
@@ -639,30 +644,31 @@ export function copyFilesIn(options: CopyFilesOptions): number | undefined;
|
|
|
639
644
|
* nc.copyFile({ path: "./src/index.js", dest: "./dist/" });
|
|
640
645
|
*
|
|
641
646
|
* @param {CopyFileOptions} options
|
|
642
|
-
* @returns {boolean | undefined}
|
|
647
|
+
* @returns {boolean | undefined} `false` when `dest` is the file itself.
|
|
643
648
|
*/
|
|
644
649
|
export function copyFile(options: CopyFileOptions): boolean | undefined;
|
|
645
650
|
/**
|
|
646
651
|
* Moves the folders inside a folder.
|
|
647
652
|
*
|
|
648
653
|
* @param {CopyFoldersOptions} options
|
|
649
|
-
* @returns {number | undefined} How many were moved.
|
|
654
|
+
* @returns {number | undefined} How many were moved: `0` when `dest` is the source folder or inside it.
|
|
650
655
|
*/
|
|
651
656
|
export function moveFoldersIn(options: CopyFoldersOptions): number | undefined;
|
|
652
657
|
/**
|
|
653
658
|
* Moves a folder.
|
|
654
659
|
*
|
|
655
660
|
* @param {CopyFolderOptions & { path: string }} options
|
|
656
|
-
* @returns {boolean | undefined}
|
|
661
|
+
* @returns {boolean | undefined} `false` when `dest` is the source folder or inside it.
|
|
657
662
|
*/
|
|
658
663
|
export function moveFolder(options: CopyFolderOptions & {
|
|
659
664
|
path: string;
|
|
660
665
|
}): boolean | undefined;
|
|
661
666
|
/**
|
|
662
|
-
* Moves the files inside a folder.
|
|
667
|
+
* Moves the files inside a folder. A file that can't be copied stays where
|
|
668
|
+
* it is, and isn't counted.
|
|
663
669
|
*
|
|
664
670
|
* @param {CopyFilesOptions} options
|
|
665
|
-
* @returns {number | undefined} How many were moved
|
|
671
|
+
* @returns {number | undefined} How many were moved: `0` when `dest` is the source folder, or inside it with `recursive`.
|
|
666
672
|
*/
|
|
667
673
|
export function moveFilesIn(options: CopyFilesOptions): number | undefined;
|
|
668
674
|
/**
|
|
@@ -672,7 +678,7 @@ export function moveFilesIn(options: CopyFilesOptions): number | undefined;
|
|
|
672
678
|
* nc.moveFile({ path: "./logs/app.log", dest: "./logs/archive/" });
|
|
673
679
|
*
|
|
674
680
|
* @param {CopyFileOptions} options
|
|
675
|
-
* @returns {boolean | undefined}
|
|
681
|
+
* @returns {boolean | undefined} `false` when `dest` is the file itself under the same name, or when the file is a link to `dest`.
|
|
676
682
|
*/
|
|
677
683
|
export function moveFile(options: CopyFileOptions): boolean | undefined;
|
|
678
684
|
/**
|
|
@@ -751,8 +757,9 @@ export function hashFile(path: string, options?: {
|
|
|
751
757
|
export function tempFolder(prefix?: string): string;
|
|
752
758
|
/**
|
|
753
759
|
* Turns any text into a file name that works on Windows, macOS and Linux:
|
|
754
|
-
* forbidden characters are replaced,
|
|
755
|
-
*
|
|
760
|
+
* forbidden characters are replaced, invisible and text direction
|
|
761
|
+
* characters are removed, reserved names like `CON`, `NUL .txt` or
|
|
762
|
+
* `COM¹` are prefixed, and the length is capped.
|
|
756
763
|
*
|
|
757
764
|
* @example
|
|
758
765
|
* nc.sanitizeFilename('Report: Q1/Q2 "final"?.pdf'); // "Report_ Q1_Q2 _final__.pdf"
|
package/types/src/FS.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FS.d.ts","sourceRoot":"","sources":["../../src/FS.js"],"names":[],"mappings":";;;;;;;UA8Bc,MAAM;;;;;;;;;;;;;;;;;;;;uBAKG,MAAM,KAAK,OAAO;;;;;;;;;UAM3B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;UAUN,MAAM;;;;;;;;;;;;;;;;qBAIC,MAAM,KAAK,OAAO;;;;;;;;;UAMzB,MAAM;;;;UACN,MAAM;;;;;;;;;;;;;;;;;uBAQG,MAAM,eAAe,MAAM,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAmB1C,MAAM,SAAS,OAAO,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;qBASlC,MAAM,SAAS,GAAG,KAAK,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAkCxB,QAAQ,GAAG,QAAQ,QAAQ,MAAM,KAAK,OAAO
|
|
1
|
+
{"version":3,"file":"FS.d.ts","sourceRoot":"","sources":["../../src/FS.js"],"names":[],"mappings":";;;;;;;UA8Bc,MAAM;;;;;;;;;;;;;;;;;;;;uBAKG,MAAM,KAAK,OAAO;;;;;;;;;UAM3B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;UAUN,MAAM;;;;;;;;;;;;;;;;qBAIC,MAAM,KAAK,OAAO;;;;;;;;;UAMzB,MAAM;;;;UACN,MAAM;;;;;;;;;;;;;;;;;uBAQG,MAAM,eAAe,MAAM,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAmB1C,MAAM,SAAS,OAAO,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;qBASlC,MAAM,SAAS,GAAG,KAAK,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAkCxB,QAAQ,GAAG,QAAQ,QAAQ,MAAM,KAAK,OAAO;;;;;;;;;sBAMtD,eAAe,GAAG,UAAU;;;;;QAK3B,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,SAAS,KAAK,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,SAAS,OAAO,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,KAAK,OAAO;;;;UAC5N,MAAM,IAAI;;;;WACV,MAAM,OAAO;YACb,MAAM,OAAO;;AA6f3B;;;;;;;;;GASG;AACH,6BAJW,MAAM,aACN,MAAM,GACJ,MAAM,GAAG,SAAS,CAI9B;AAED;;;;;;;;;GASG;AACH,kCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,iCAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAI9B;AAED;;;;;GAKG;AACH,8BAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAI9B;AAED;;;;;;;;;;;GAWG;AACH,oCAJW,MAAM,cACN,OAAO,GAAG,WAAW,GACnB,MAAM,EAAE,GAAG,SAAS,CAKhC;AAED;;;;;;;;;;GAUG;AACH,kCAJW,MAAM,cACN,OAAO,GAAG,WAAW,GACnB,MAAM,EAAE,GAAG,SAAS,CAKhC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,8BAJW,MAAM,GAAG,MAAM,EAAE,YACjB,WAAW,GACT,MAAM,EAAE,CAiBpB;AAyDD;;;;;;;;;;;GAWG;AACH,2BAJW,MAAM,YACN,WAAW,GACT,MAAM,GAAG,SAAS,CAsB9B;AASD;;;;;;;;;;;;;GAaG;AACH,6BAJW,MAAM,GAAG,MAAM,EAAE,YACjB;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CA0B9B;;;;;;;;;;;;;AASE,+BACQ,MAAM,YACN,QAAQ,GACN,MAAM,GAAG,SAAS,CAC9B;;;;;;;;;AAIE,+BACQ,MAAM,0CAEJ,MAAM,GAAG,SAAS,CAC9B;AAgBD;;;;;;;;GAQG;AACH,gCAHW,MAAM,GACJ,MAAM,EAAE,GAAG,SAAS,CAOhC;AAED;;;;;;;;;;;;;GAaG;AACH,yBANc,CAAC,cACJ,MAAM,aACN,CAAC,YACD,eAAe,GACb,CAAC,CAWb;AAED;;;;;;;;;;;;GAYG;AACH,gCALW,MAAM,QACN,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,YACrC,gBAAgB,GACd,OAAO,CASnB;AAED;;;;;;;;;;GAUG;AACH,gCALW,MAAM,QACN,OAAO,YACP,gBAAgB,GACd,OAAO,CAWnB;AAED;;;;;;;;;GASG;AACH,iCAJW,MAAM,QACN,MAAM,GAAG,MAAM,GACb,OAAO,CAiBnB;AAED;;;;;;;;;;;GAWG;AACH,iCALW,MAAM,UACN,OAAO,SACP,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAC7B,OAAO,GAAG,SAAS,CAY/B;AAED;;;;;;;;;;GAUG;AACH,mCAJW,MAAM,UACN,OAAO,GACL,OAAO,GAAG,SAAS,CAe/B;AAED;;;;;;;;;GASG;AACH,mCAJW,MAAM,GACJ,MAAM,CAOlB;AAED;;;;;;;GAOG;AACH,iCAJW,MAAM,GACJ,MAAM,CAUlB;AAED;;;;;;GAMG;AACH,4BAHW,MAAM,GACJ,OAAO,CAWnB;AAED;;;;;GAKG;AACH,mCAHW,MAAM,GACJ,OAAO,GAAG,SAAS,CAW/B;AAED;;;;;GAKG;AACH,iCAHW,MAAM,GACJ,OAAO,GAAG,SAAS,CAW/B;AAED;;;;;;;;;GASG;AACH,6BAHW,MAAM,GACJ,OAAO,CAWnB;AAED;;;;;;;;;GASG;AACH,uCAJW,MAAM,WACN,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GACzB,MAAM,GAAG,SAAS,CAY9B;AAED;;;;;;;;;;GAUG;AACH,qCALW,MAAM,cACN,OAAO,WACP,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GACvB,MAAM,GAAG,SAAS,CAgB9B;AAED;;;;;;GAMG;AACH,kCAHW,MAAM,GACJ,OAAO,GAAG,SAAS,CAY/B;AAED;;;;;;;;;;;;;GAaG;AACH,6BALW,MAAM,eACN,MAAM,YACN,WAAW,GACT,OAAO,CAcnB;AAKD;;;;;;;;;;;GAWG;AACH,6BALW,MAAM,eACN,MAAM,YACN;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GACrB,OAAO,CAsDnB;AAED;;;;;;GAMG;AACH,uCAHW,kBAAkB,GAChB,MAAM,GAAG,SAAS,CAqB9B;AAED;;;;;;GAMG;AACH,oCAHW,iBAAiB,GACf,OAAO,GAAG,SAAS,CAsB/B;AAED;;;;;;;;GAQG;AACH,qCAHW,gBAAgB,GACd,MAAM,GAAG,SAAS,CAmB9B;AAsBD;;;;;;;;;GASG;AACH,kCAHW,eAAe,GACb,OAAO,GAAG,SAAS,CAgB/B;AAED;;;;;GAKG;AACH,uCAHW,kBAAkB,GAChB,MAAM,GAAG,SAAS,CAa9B;AAED;;;;;GAKG;AACH,oCAHW,iBAAiB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAClC,OAAO,GAAG,SAAS,CAO/B;AAED;;;;;;GAMG;AACH,qCAHW,gBAAgB,GACd,MAAM,GAAG,SAAS,CA8B9B;AAED;;;;;;;;GAQG;AACH,kCAHW,eAAe,GACb,OAAO,GAAG,SAAS,CAqB/B;AAED;;;;;GAKG;AACH,6BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,6BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,+BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;GAQG;AACH,2BAHW,MAAM,GACJ,EAAE,CAAC,KAAK,GAAG,SAAS,CAQhC;AAED;;;;;;;;GAQG;AACH,+BAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAU9B;AAED;;;;;GAKG;AACH,iCAHW,MAAM,GACJ,MAAM,GAAG,SAAS,CAc9B;AAED;;;;;;;;;;GAUG;AACH,+BAJW,MAAM,YACN;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,WAAW,CAAA;CAAE,GAC/D,MAAM,GAAG,SAAS,CAkB9B;AAED;;;;;;;;;GASG;AACH,oCAHW,MAAM,GACJ,MAAM,CAIlB;AAeD;;;;;;;;;;;;;GAaG;AACH,uCAJW,MAAM,YACN;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACtB,MAAM,CA0BlB;AAED;;;;;;;;;;;GAWG;AACH,gCAHW,YAAY,GACV,OAAO,GAAG,SAAS,CAuF/B"}
|
package/types/src/Http.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
declare namespace _exports {
|
|
2
|
-
export { HttpBody, HttpMethod, QueryParams, HttpHeaders, HttpRetryOptions, HttpRequestConfig, HttpHooks, HttpOptions, HttpResponse, ResponseSchema, HttpOptionsOf, HttpClient };
|
|
2
|
+
export { HttpBody, HttpMethod, QueryParams, HttpHeaders, HttpRetryOptions, HttpRequestConfig, HttpHooks, HttpOptions, HttpResponse, ResponseSchema, HttpOptionsOf, HttpClient, _ReadSettings };
|
|
3
3
|
}
|
|
4
4
|
declare namespace _exports {
|
|
5
5
|
export { request };
|
|
@@ -108,15 +108,19 @@ type HttpOptions = {
|
|
|
108
108
|
*/
|
|
109
109
|
method?: HttpMethod | undefined;
|
|
110
110
|
/**
|
|
111
|
-
* Prefix for relative URLs.
|
|
111
|
+
* Prefix for relative URLs. It's a boundary: a path that would leave it, like `"../admin"`, `"//other.host"` or an absolute URL to another place, throws a `TypeError` (see `allowAbsoluteUrls`).
|
|
112
112
|
*/
|
|
113
113
|
baseURL?: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* With a `baseURL`, let an absolute URL go elsewhere: `api.get("https://cdn.example.com/x", { allowAbsoluteUrls: true })`. The client's own `auth`, `headers` and `query` still stay with the base origin, only those of the call go there. Defaults to `false`, so a URL built from outside input can't take the client's credentials to another host.
|
|
116
|
+
*/
|
|
117
|
+
allowAbsoluteUrls?: boolean | undefined;
|
|
114
118
|
/**
|
|
115
119
|
* Set a header to `undefined` to remove a default one.
|
|
116
120
|
*/
|
|
117
121
|
headers?: HttpHeaders | undefined;
|
|
118
122
|
/**
|
|
119
|
-
* Values for the `:name` parts of the URL: `"users/:id"` with `{ id: 42 }` gives `users/42`. They're encoded for you.
|
|
123
|
+
* Values for the `:name` parts of the URL: `"users/:id"` with `{ id: 42 }` gives `users/42`. They're encoded for you, and `"."` or `".."` throws a `TypeError`, since they would move up the path.
|
|
120
124
|
*/
|
|
121
125
|
params?: Record<string, string | number | boolean> | undefined;
|
|
122
126
|
/**
|
|
@@ -180,9 +184,17 @@ type HttpOptions = {
|
|
|
180
184
|
percent: number | undefined;
|
|
181
185
|
}) => void) | undefined;
|
|
182
186
|
/**
|
|
183
|
-
* Defaults to `"
|
|
187
|
+
* Largest body read into memory, in bytes or like `"50MB"`, counted once decompressed. Past it, the request is cancelled and an `HttpError` with the code `ERR_RESPONSE_TOO_LARGE` is thrown, so a huge or zip bomb answer can't fill the memory. Defaults to `"100MB"`, `Infinity` turns it off. A stream (`responseType: "stream"`) and the file of `download()` aren't held in memory, so they aren't limited.
|
|
188
|
+
*/
|
|
189
|
+
maxResponseSize?: string | number | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* `"follow"` (the default) follows up to 20 redirects, `"manual"` returns the 3xx response as it is, `"error"` throws an `HttpError` with the code `ERR_REDIRECT`. When a redirect goes to another origin, `authorization`, `cookie`, `proxy-authorization` and the `sensitiveHeaders` are left behind.
|
|
184
192
|
*/
|
|
185
193
|
redirect?: "error" | "follow" | "manual" | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* Headers dropped when a redirect goes to another origin, on top of `authorization`, `cookie` and `proxy-authorization`. Names are case-insensitive. Defaults to `["x-api-key", "x-auth-token", "api-key"]`; a list you give replaces it, so add these to it if you use them.
|
|
196
|
+
*/
|
|
197
|
+
sensitiveHeaders?: string[] | undefined;
|
|
186
198
|
};
|
|
187
199
|
/**
|
|
188
200
|
* A response.
|
|
@@ -289,6 +301,29 @@ type HttpClient = {
|
|
|
289
301
|
extend: (defaults: HttpOptions) => HttpClient;
|
|
290
302
|
defaults: Readonly<HttpOptions>;
|
|
291
303
|
};
|
|
304
|
+
/**
|
|
305
|
+
* How `_readBody()` reads.
|
|
306
|
+
*/
|
|
307
|
+
type _ReadSettings = {
|
|
308
|
+
type: HttpOptions["responseType"];
|
|
309
|
+
onProgress: HttpOptions["onDownloadProgress"];
|
|
310
|
+
/**
|
|
311
|
+
* Most bytes kept, once decompressed.
|
|
312
|
+
*/
|
|
313
|
+
limit: number;
|
|
314
|
+
/**
|
|
315
|
+
* Past the limit, keep the start instead of throwing.
|
|
316
|
+
*/
|
|
317
|
+
truncate: boolean;
|
|
318
|
+
/**
|
|
319
|
+
* For the error message.
|
|
320
|
+
*/
|
|
321
|
+
method: string;
|
|
322
|
+
/**
|
|
323
|
+
* Cancels the request.
|
|
324
|
+
*/
|
|
325
|
+
abort: () => void;
|
|
326
|
+
};
|
|
292
327
|
/**
|
|
293
328
|
* Sends a request and resolves with the response, body already read.
|
|
294
329
|
* Throws an `HttpError` for error statuses, a `TimeoutError` when it's too
|
|
@@ -404,7 +439,9 @@ declare function del<T = any, S extends ResponseSchema = {
|
|
|
404
439
|
* Downloads to a file as a stream, so memory stays flat whatever the size.
|
|
405
440
|
* Folders are created. The data goes to a temporary file that takes the
|
|
406
441
|
* final name once complete, so a failed or interrupted download never
|
|
407
|
-
* leaves half a file where you expect a whole one.
|
|
442
|
+
* leaves half a file where you expect a whole one. That temporary file has
|
|
443
|
+
* a random name and is only readable and writable by you (mode `0o600`),
|
|
444
|
+
* which the final file keeps. `maxResponseSize` doesn't apply here.
|
|
408
445
|
*
|
|
409
446
|
* `timeout` is how long the server gets to start answering; the transfer
|
|
410
447
|
* itself can take as long as it needs. Use `signal` to put a limit on it.
|
package/types/src/Http.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Http.d.ts","sourceRoot":"","sources":["../../src/Http.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;gBAoBa,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,IAAI,GAAG,cAAc,GAAG,OAAO,aAAa,EAAE,QAAQ;;;;kBAKhI,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;;;;mBAKhF,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;;;;mBAK7G,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAkBrE,MAAM;YACN,UAAU;;;;aACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;UACtB,QAAQ,GAAG,SAAS;;;;aACpB,MAAM;;;;;;;;;8BAMS,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;;;;gCACxC,YAAY,CAAC,GAAG,CAAC,UAAU,iBAAiB,KAAK,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;;;;2BAChH,OAAO,WAAW,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC
|
|
1
|
+
{"version":3,"file":"Http.d.ts","sourceRoot":"","sources":["../../src/Http.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;gBAoBa,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,IAAI,GAAG,cAAc,GAAG,OAAO,aAAa,EAAE,QAAQ;;;;kBAKhI,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;;;;mBAKhF,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;;;;mBAK7G,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAkBrE,MAAM;YACN,UAAU;;;;aACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;UACtB,QAAQ,GAAG,SAAS;;;;aACpB,MAAM;;;;;;;;;8BAMS,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;;;;gCACxC,YAAY,CAAC,GAAG,CAAC,UAAU,iBAAiB,KAAK,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;;;;2BAChH,OAAO,WAAW,MAAM,SAAS,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAY9E,OAAO;;;;;;;;;;;;;gBAGG,MAAM;;kBAAiB,MAAM;kBAAY,MAAM;;;;;;;;;;;;;;;;;;oBAI3C,OAAO,GAAG,OAAO;;;;;;;;;;;;;;qCAIpB;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI;;;;;;;;;;;;;;;;;kBAQ9F,CAAC;YAED,MAAM;gBACN,MAAM;;;;QACN,OAAO;;;;aACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;;;aACtB,MAAM,EAAE;;;;UACR,CAAC;;;;SACD,MAAM;;;;cACN,MAAM;;;;cACN,MAAM;;;;;;sBAMP;IAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAAE;;;;mBAKhB,CAAC,SAAjB,cAAe,IAChB,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,CAAC,CAAA;CAAE;;;;;;;;aAM3C,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;SACjK,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;UACjK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;;;;YAC/E,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;UACjK,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;SACjL,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;WACjL,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,cAAc,GAAG;QAAE,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAA;KAAE,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;;;;cACjL,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;;;;YAC1G,CAAC,QAAQ,EAAE,WAAW,KAAK,UAAU;cACrC,QAAQ,CAAC,WAAW,CAAC;;;;;;UAwNrB,WAAW,CAAC,cAAc,CAAC;gBAC3B,WAAW,CAAC,oBAAoB,CAAC;;;;WACjC,MAAM;;;;cACN,OAAO;;;;YACP,MAAM;;;;WACN,MAAM,IAAI;;AAwTxB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,yBAPc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,YACZ,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAKzD;AAED;;;;;;;;;;;GAWG;AACH,qBANc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,YACZ,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAIzD;AAED;;;;;;;;;;;GAWG;AACH,sBALc,CAAC,mBACJ,MAAM,GAAG,GAAG,YACZ,WAAW,GACT,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAIpC;AAED;;;;;;;;;;;;;;GAcG;AACH,sBAPc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,SACZ,OAAO,YACP,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAIzD;AAED;;;;;;;;;GASG;AACH,qBAPc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,SACZ,OAAO,YACP,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAIzD;AAED;;;;;;;;;GASG;AACH,uBAPc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,SACZ,OAAO,YACP,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAIzD;AAED;;;;;;;;;;;GAWG;AACH,qBANc,CAAC,QACgB,CAAC,SAAlB,cAAe;gBAAkB,OAAO,GAAG,CAAC;QAC/C,MAAM,GAAG,GAAG,YACZ,aAAa,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAIzD;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,+BANW,MAAM,GAAG,GAAG,eACZ,MAAM,YACN,WAAW,GACT,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAKnD;AAiDD;;;;;;;;;;;;;;GAcG;AACH,mCAHW,WAAW,GACT,UAAU,CAItB"}
|
package/types/src/Id.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Id.d.ts","sourceRoot":"","sources":["../../src/Id.js"],"names":[],"mappings":";;;4BAqBa,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ;;;;;4BAMpD,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;UAc7C,IAAI;;;;eACJ,MAAM;cACN,MAAM;eACN,MAAM;;;;eACN,MAAM;;
|
|
1
|
+
{"version":3,"file":"Id.d.ts","sourceRoot":"","sources":["../../src/Id.js"],"names":[],"mappings":";;;4BAqBa,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ;;;;;4BAMpD,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;UAc7C,IAAI;;;;eACJ,MAAM;cACN,MAAM;eACN,MAAM;;;;eACN,MAAM;;AA2MpB;;;;;;;GAOG;AACH,wBAFa,MAAM,CAIlB;AAED;;;;;;;;;;;;;GAaG;AACH,6BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,aAC5B,aAAa,GACX,MAAM,CAYlB;AAED;;;;;;;;;;;GAWG;AACH,0BAFa,MAAM,CAmBlB;AAgBD;;;;;;;;;;;GAWG;AACH,4BAJW,MAAM,GAAG,IAAI,GACX,MAAM,CA8BlB;AAED;;;;;;;;;;;;GAYG;AACH,gCAJW,MAAM,GAAG,IAAI,GACX,MAAM,CAclB;AAED;;;;;;;;;;;;GAYG;AACH,4BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;GAUG;AACH,yCAJW,MAAM,SACN,MAAM,GACJ,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,MAAM,CAKrC;AAED;;;;;;;;;;;;GAYG;AACH,iCAJW,MAAM,SACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;;GAWG;AACH,8BAJW,MAAM,aACN,aAAa,GACX,MAAM,CASlB;AAED;;;;;;;;;;;GAWG;AACH,8BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAIlB;AAKD;;;;;;;;;;GAUG;AACH,oCAJW,gBAAgB,GACd,MAAM,CAiBlB;AAED;;;;;;;;;;GAUG;AACH,mCALW,MAAM,GAAG,MAAM,YACf,gBAAgB,GACd,eAAe,CAkB3B;AAED;;;;;;;;;;GAUG;AACH,iCAHW,MAAM,GACJ,IAAI,GAAG,SAAS,CAU5B;AAKD;;;;;;;;;;GAUG;AACH,6BAHW,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;GAOG;AACH,4BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,OAAO,UAAU,EAAE,WAAW,GAC5B,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,4BALW,MAAM,GAAG,MAAM,GAAG,UAAU,UAC5B,MAAM,GAAG,MAAM,GAAG,UAAU,YAC5B,OAAO,UAAU,EAAE,WAAW,GAC5B,MAAM,CAIlB;AAED;;;;;;;GAOG;AACH,6BAJW,MAAM,GAAG,MAAM,GAAG,UAAU,KAC5B,MAAM,GAAG,MAAM,GAAG,UAAU,GAC1B,OAAO,CAInB"}
|
package/types/src/Logger.d.ts
CHANGED
|
@@ -25,6 +25,10 @@ export type LogFileOptions = {
|
|
|
25
25
|
* How many rotated files to keep. Defaults to `5`.
|
|
26
26
|
*/
|
|
27
27
|
maxFiles?: number | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* The permissions a new log file gets, like `0o640`. Defaults to `0o600`: only its owner can read it. A file that already exists keeps its own. Ignored on Windows.
|
|
30
|
+
*/
|
|
31
|
+
mode?: number | undefined;
|
|
28
32
|
};
|
|
29
33
|
/**
|
|
30
34
|
* A message as `onLog` receives it.
|
|
@@ -107,7 +111,7 @@ export type LoggerOptions = {
|
|
|
107
111
|
*/
|
|
108
112
|
export type Logger = {
|
|
109
113
|
/**
|
|
110
|
-
* A plain message, no badge.
|
|
114
|
+
* A plain message, no badge. Its first argument supports markup.
|
|
111
115
|
*/
|
|
112
116
|
log: (...args: unknown[]) => Logger;
|
|
113
117
|
/**
|
|
@@ -196,6 +200,9 @@ export type _LogFile = {
|
|
|
196
200
|
keep: number;
|
|
197
201
|
size: number;
|
|
198
202
|
ready: boolean;
|
|
203
|
+
options: {
|
|
204
|
+
mode: number;
|
|
205
|
+
};
|
|
199
206
|
};
|
|
200
207
|
/**
|
|
201
208
|
* What a message looks like on one output: its colors, and the parts that
|
|
@@ -211,8 +218,9 @@ export type _Face = {
|
|
|
211
218
|
stampWidth: number;
|
|
212
219
|
};
|
|
213
220
|
/**
|
|
214
|
-
* Prints a message without a badge.
|
|
215
|
-
* pretty-printed, and several arguments are
|
|
221
|
+
* Prints a message without a badge. The first argument, when it's a string,
|
|
222
|
+
* supports markup; objects are pretty-printed, and several arguments are
|
|
223
|
+
* joined with spaces.
|
|
216
224
|
*
|
|
217
225
|
* @example
|
|
218
226
|
* nc.log("<% green ✔ Saved%> in <% bold 12ms%>");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.js"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.js"],"names":[],"mappings":";;;uBAuCa,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ;;;;;wBAMlE;IAAE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE;;;;;;;;UAM/B,MAAM;;;;;;;;;;;;;;;;;;UASN,IAAI;WACJ,QAAQ;;;;UACR,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO;WAC3E,MAAM,GAAG,SAAS;;;;aAClB,MAAM;;;;UACN,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;eAUA,MAAM;gBAAU,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAOvB,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;;;;;;;;;SAOzC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;WAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;WAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;UAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;aAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;UAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;WAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;WAC9B,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM;;;;WAC9B,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM;;;;cAC1B,MAAM,MAAM;;;;eACZ,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM;;;;aAC1B,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM;;;;WAC1B,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,OAAO,EAAE,YAAY,KAAK,MAAM;;;;SACtG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,OAAO,EAAE,UAAU,KAAK,MAAM;;;;aAC9D,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM;;;;WAC1B,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM;;;;cAClD,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM;;;;cAC3B,MAAM,QAAQ;;;;oBACd,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO;;;;eAC5B,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM;;;;;uBA6QnC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE;;;;;oBAyEpH;IAAE,OAAO,EAAE,OAAO,SAAS,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE;AAuR3K;;;;;;;;;;;GAWG;AACH,6BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;GAKG;AACH,+BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;GASG;AACH,+BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;GAQG;AACH,8BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;GAQG;AACH,iCAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;GAKG;AACH,8BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;GASG;AACH,+BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;GAMG;AACH,+BAHc,OAAO,EAAA,GACR,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;;GAUG;AACH,8BAHW,MAAM,GACJ,cAAc,UAAU,CAAC,CAKrC;AAED;;;;GAIG;AACH,4BAFa,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;;GAUG;AACH,kCAHW,MAAM,GACJ,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;GAKG;AACH,gCAHW,MAAM,GACJ,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;GASG;AACH,4BAJW,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,YAC5C,OAAO,OAAO,EAAE,YAAY,GAC1B,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;GASG;AACH,0BAJW,MAAM,YACN,OAAO,OAAO,EAAE,UAAU,GACxB,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;GAKG;AACH,gCAHW,MAAM,GACJ,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;;GAUG;AACH,gCAJW,QAAQ,GACN,cAAc,UAAU,CAAC,CAMrC;AAED;;;;GAIG;AACH,4BAFa,QAAQ,CAIpB;AAED;;;;;;;;;GASG;AACH,sCAHW,QAAQ,GACN,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,mCAHW,aAAa,GACX,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;GASG;AACH,oCAHW,OAAO,GAAG,MAAM,GACd,cAAc,UAAU,CAAC,CAKrC;AAED;;;;;;;;;;GAUG;AACH,uCAHW;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/B,cAAc,UAAU,CAAC,CAKrC;AAhTD;;;;;;;;;;;;;GAaG;AACH,uCAHW,aAAa,GACX,MAAM,CAIlB"}
|
package/types/src/Num.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Num.d.ts","sourceRoot":"","sources":["../../src/Num.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"Num.d.ts","sourceRoot":"","sources":["../../src/Num.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAo4BA;;;;;;;;;;GAUG;AACH,kCAHW,MAAM,GACJ,cAAc,OAAO,CAAC,CAKlC;AAED;;;;;;;GAOG;AACH,6BAFa,MAAM,CAIlB;AA1xBD;;;;;;;;;;;GAWG;AACH,6BALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;GAUG;AACH,+BALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;;;;;GAYG;AACH,4BALW,MAAM,OACN,MAAM,OACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;;;;;;GAaG;AACH,6BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;GASG;AACH,6BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;GASG;AACH,4BAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;GAUG;AACH,4BAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;;GAWG;AACH,+BALW,MAAM,KACN,MAAM,YACN,MAAM,GACJ,OAAO,CAMnB;AAED;;;;;;;;;;GAUG;AACH,4BALW,MAAM,OACN,MAAM,KACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;;;;;GAaG;AACH,gCAPW,MAAM,SACN,MAAM,SACN,MAAM,UACN,MAAM,UACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,6BAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;;;GASG;AACH,+BAJW,MAAM,OACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;;GASG;AACH,4BAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,gCAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,CAMlB;AAED;;;;;;;;GAQG;AACH,gCAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,CAKlB;AAED;;;;;;;;;GASG;AACH,+BAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,CAOlB;AAED;;;;;;;;GAQG;AACH,6BAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,EAAE,CAepB;AAED;;;;;;;;;GASG;AACH,iCAJW,QAAQ,CAAC,MAAM,CAAC,YAChB,eAAe,GACb,MAAM,CAUlB;AAED;;;;;;;;;GASG;AACH,+BAJW,QAAQ,CAAC,MAAM,CAAC,YAChB,eAAe,GACb,MAAM,CAIlB;AAED;;;;;;;;;;;GAWG;AACH,mCAJW,QAAQ,CAAC,MAAM,CAAC,KAChB,MAAM,GACJ,MAAM,CASlB;AAED;;;;;;GAMG;AACH,4BAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,GAAG,SAAS,CAS9B;AAED;;;;;;GAMG;AACH,4BAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,GAAG,SAAS,CAS9B;AAED;;;;;;;;;;;GAWG;AACH,+BALW,MAAM,SACN,MAAM,aACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;;;;;;;;GAYG;AACH,oCALW,MAAM,MACN,MAAM,aACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;GAQG;AACH,+BAHc,MAAM,EAAA,GACP,MAAM,CAelB;AAED;;;;;;;;GAQG;AACH,+BAHc,MAAM,EAAA,GACP,MAAM,CAMlB;AAED;;;;;;;;;GASG;AACH,+BAHW,MAAM,GACJ,OAAO,CAUnB;AAED;;;;;;;;;;;;GAYG;AACH,6BALW,MAAM,aACN,OAAO,GACL,MAAM,GAAG,MAAM,CAa3B;AAED;;;;;GAKG;AACH,8BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,6BAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;;;;;;;GAaG;AACH,6BALW,MAAM,QACN,MAAM,SACN,MAAM,GACJ,MAAM,EAAE,CAmBpB;AAED;;;;;;;;;;;GAWG;AACH,6BAJW,OAAO,aACP,MAAM,GACJ,MAAM,CAQlB;AAED;;;;;;;;;;;GAWG;AACH,kCAJW,MAAM,GAAG,MAAM,YACf,iBAAiB,GACf,MAAM,CAWlB;AAED;;;;;;;;;;;GAWG;AACH,mCAJW,MAAM,YACN,kBAAkB,GAChB,MAAM,CAuBlB;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAJW,MAAM,GAAG,MAAM,YACf,mBAAmB,GACjB,MAAM,CAwBlB;AAED;;;;;;;;;;;;GAYG;AACH,gCALW,MAAM,GAAG,MAAM,QACf,MAAM,YACN,eAAe,GACb,MAAM,CAWlB;AAED;;;;;;;;;;;GAWG;AACH,kCAJW,MAAM,aACN,MAAM,GACJ,MAAM,CAgBlB;AAED;;;;;;;;;GASG;AACH,iCAJW,MAAM,GAAG,MAAM,cACf,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;;;;;GAYG;AACH,2BALW,MAAM,UACN,MAAM,SACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;;;;;;GAWG;AACH,+BAJW,MAAM,YACN,cAAc,GACZ,MAAM,CAalB"}
|
package/types/src/Obj.d.ts
CHANGED
|
@@ -126,6 +126,7 @@ type CompactOptions = {
|
|
|
126
126
|
* @template T
|
|
127
127
|
* @param {T} value
|
|
128
128
|
* @returns {T}
|
|
129
|
+
* @throws {RangeError} If the value is nested too deeply to walk, thousands of levels.
|
|
129
130
|
*/
|
|
130
131
|
declare function clone<T>(value: T): T;
|
|
131
132
|
/**
|
|
@@ -172,6 +173,7 @@ declare function merge<A extends object, B extends object, C extends object>(a:
|
|
|
172
173
|
* @overload
|
|
173
174
|
* @param {...object} sources
|
|
174
175
|
* @returns {Record<string, any>}
|
|
176
|
+
* @throws {RangeError} If an object is nested too deeply to walk, thousands of levels.
|
|
175
177
|
*/
|
|
176
178
|
declare function merge(...sources: object[]): Record<string, any>;
|
|
177
179
|
/**
|
|
@@ -186,6 +188,7 @@ declare function merge(...sources: object[]): Record<string, any>;
|
|
|
186
188
|
* @param {MergeOptions} options
|
|
187
189
|
* @param {...object} sources
|
|
188
190
|
* @returns {Record<string, any>}
|
|
191
|
+
* @throws {RangeError} If an object is nested too deeply to walk, thousands of levels.
|
|
189
192
|
*/
|
|
190
193
|
declare function mergeWith(options: MergeOptions, ...sources: object[]): Record<string, any>;
|
|
191
194
|
/**
|
|
@@ -201,6 +204,7 @@ declare function mergeWith(options: MergeOptions, ...sources: object[]): Record<
|
|
|
201
204
|
* @param {T} target
|
|
202
205
|
* @param {...D} sources The first one has the highest priority.
|
|
203
206
|
* @returns {T & D}
|
|
207
|
+
* @throws {RangeError} If an object is nested too deeply to walk, thousands of levels.
|
|
204
208
|
*/
|
|
205
209
|
declare function defaults<T extends object, D extends object>(target: T, ...sources: D[]): T & D;
|
|
206
210
|
/**
|
|
@@ -215,6 +219,7 @@ declare function defaults<T extends object, D extends object>(target: T, ...sour
|
|
|
215
219
|
* @param {unknown} a
|
|
216
220
|
* @param {unknown} b
|
|
217
221
|
* @returns {boolean}
|
|
222
|
+
* @throws {RangeError} If the values are nested too deeply to walk, thousands of levels.
|
|
218
223
|
*/
|
|
219
224
|
declare function equal(a: unknown, b: unknown): boolean;
|
|
220
225
|
/**
|
|
@@ -231,11 +236,13 @@ declare function equal(a: unknown, b: unknown): boolean;
|
|
|
231
236
|
* @param {unknown} before
|
|
232
237
|
* @param {unknown} after
|
|
233
238
|
* @returns {Change[]} Empty when nothing changed.
|
|
239
|
+
* @throws {RangeError} If the values are nested too deeply to walk, thousands of levels.
|
|
234
240
|
*/
|
|
235
241
|
declare function diff(before: unknown, after: unknown): Change[];
|
|
236
242
|
/**
|
|
237
243
|
* Reads a nested value from a dotted path. Your editor completes the paths
|
|
238
|
-
* and knows the type of the result.
|
|
244
|
+
* and knows the type of the result. What a plain object inherits is not
|
|
245
|
+
* read: `obj.get({}, "toString")` is `undefined`.
|
|
239
246
|
*
|
|
240
247
|
* @example
|
|
241
248
|
* obj.get(config, "db.pool.max"); // number | undefined
|
|
@@ -267,7 +274,8 @@ declare function get<T, P extends string>(object: T, path: P | Paths<T> | Readon
|
|
|
267
274
|
declare function get<T, P extends string, F>(object: T, path: P | Paths<T> | ReadonlyArray<string | number>, fallback: F): Exclude<PathValue<T, P>, undefined> | F;
|
|
268
275
|
/**
|
|
269
276
|
* Returns a copy with a nested value set. Missing levels are created
|
|
270
|
-
* (arrays when the next key is a number
|
|
277
|
+
* (arrays when the next key is a number up to 10000, objects otherwise, so
|
|
278
|
+
* a key like `"a.4000000000"` can't make a huge array).
|
|
271
279
|
*
|
|
272
280
|
* @example
|
|
273
281
|
* obj.set({}, "a.b.c", 1); // { a: { b: { c: 1 } } }
|
|
@@ -416,6 +424,7 @@ declare function invert(object: Record<string, PropertyKey>): Record<string, str
|
|
|
416
424
|
* @param {T} object
|
|
417
425
|
* @param {CompactOptions} [options]
|
|
418
426
|
* @returns {Partial<T>}
|
|
427
|
+
* @throws {RangeError} With `deep`, if the object is nested too deeply to walk, thousands of levels.
|
|
419
428
|
*/
|
|
420
429
|
declare function compact<T extends object>(object: T, options?: CompactOptions): Partial<T>;
|
|
421
430
|
/**
|
|
@@ -427,10 +436,12 @@ declare function compact<T extends object>(object: T, options?: CompactOptions):
|
|
|
427
436
|
* @param {object} object
|
|
428
437
|
* @param {string} [prefix=""] Added in front of every key.
|
|
429
438
|
* @returns {Record<string, unknown>}
|
|
439
|
+
* @throws {RangeError} If the object is nested too deeply to walk, thousands of levels.
|
|
430
440
|
*/
|
|
431
441
|
declare function flatten(object: object, prefix?: string): Record<string, unknown>;
|
|
432
442
|
/**
|
|
433
443
|
* Rebuilds nested objects from dotted keys. The opposite of `flatten()`.
|
|
444
|
+
* A number key up to 10000 makes an array, as in `set()`.
|
|
434
445
|
*
|
|
435
446
|
* @example
|
|
436
447
|
* obj.unflatten({ "db.host": "x", "db.port": 5432 }); // { db: { host: "x", port: 5432 } }
|
|
@@ -462,6 +473,7 @@ declare function paths(object: object): string[];
|
|
|
462
473
|
* @param {T} object
|
|
463
474
|
* @param {SortKeysOptions} [options]
|
|
464
475
|
* @returns {T}
|
|
476
|
+
* @throws {RangeError} If the object is nested too deeply to walk, thousands of levels.
|
|
465
477
|
*/
|
|
466
478
|
declare function sortKeys<T>(object: T, options?: SortKeysOptions): T;
|
|
467
479
|
/**
|
|
@@ -531,6 +543,7 @@ declare function isEmpty(object: unknown): boolean;
|
|
|
531
543
|
* @template T
|
|
532
544
|
* @param {T} object
|
|
533
545
|
* @returns {DeepReadonly<T>} The same object.
|
|
546
|
+
* @throws {RangeError} If the object is nested too deeply to walk, thousands of levels. What was reached by then stays frozen.
|
|
534
547
|
*/
|
|
535
548
|
declare function deepFreeze<T>(object: T): DeepReadonly<T>;
|
|
536
549
|
/** Marks an unknown path segment in `PathStep`. */
|