@js-utils-kit/types 1.4.0 → 1.6.0

package/dist/index.d.cts

@@ -154,6 +154,20 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
  */
 type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 509 | 510 | 511;
 //#endregion
+//#region src/json.d.ts
+/**
+ * Represents the `replacer` argument accepted by {@link JSON.stringify}
+ *
+ * This type unifies the two overloads of `JSON.stringify` into a single.
+ *
+ * @remarks
+ * - The function form is called for each key-value pair during serialization.
+ * - Returning `undefined` from the function will omit the property.
+ * - The array form acts as a whitelist of keys to include.
+ * - Defined explicitly to avoid TypeScript overload inference issues with `Parameters<typeof JSON.stringify>[1]`.
+ */
+type JsonReplacer = ((this: unknown, key: string, value: unknown) => unknown) | readonly (string | number)[] | null;
+//#endregion
 //#region src/MinuteOrSecond.d.ts
 /**
  * Represents a minute or second value in time.
@@ -300,6 +314,10 @@ type PackageJson = DeepPartial<{
   [key: string]: unknown;
 }>;
 //#endregion
+//#region src/PlainObject.d.ts
+/** Represents a generic JavaScript object with arbitrary property keys */
+type PlainObject = Record<PropertyKey, unknown>;
+//#endregion
 //#region src/Trim.d.ts
 /**
  * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
@@ -335,4 +353,5 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };
+export { ArchiveFormat, type ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, JsonReplacer, MinuteOrSecond, PackageJson, PlainObject, Trim };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/commit/types.ts","../src/ArchiveFormat.ts","../src/CreateArchiveOptions.ts","../src/Environment.ts","../src/Falsy.ts","../src/Hour.ts","../src/HttpStatusCode.ts","../src/json.ts","../src/MinuteOrSecond.ts","../src/utils/DeepPartial.ts","../src/PackageJson.ts","../src/PlainObject.ts","../src/Trim.ts"],"mappings":";;;;;;AAKA;;UAAiB,cAAA;EAAc;;;;;;;;;EAU7B,IAAA;EAuCU;;;EAlCV,WAAA;ECjBU;;;;;;;ED0BV,oBAAA;EEvBe;;;EF4Bf,iBAAA;EExBA;;;EF6BA,kBAAA;EEXA;;;EFgBA,KAAA;EENa;;;EFWb,IAAA;;;AGpCF;EHyCE,UAAA;AAAA;;;;;;KCnDU,aAAA;;;;ADEZ;;UECiB,oBAAA;EFDc;;;EEK7B,MAAA,EAAQ,aAAA;EFwBR;;;EEnBA,MAAA;EFuCA;;;;;;EE/BA,WAAA;EDpBuB;;;ECyBvB,OAAA,GAAU,iBAAA;;;;EAKV,GAAA;EA3BmC;;;EAgCnC,SAAA,IAAa,KAAA;AAAA;;;;;;AFjCf;;;;;;;;;;cGQa,WAAA;EHyCX,2EAAU;EAAA;yBCnDA;EAAA;;KEsBA,WAAA,WAAsB,WAAA,eAA0B,WAAA;;;;;;AHpB5D;;;;;;;;;KIOY,KAAA;;;;;;AJPZ;;;KKCY,IAAA;;;;;;ALDZ;;;;;;;;;;;KMSY,cAAA;;;;;;ANTZ;;;;;;;;KOMY,YAAA,KACN,IAAA,WAAe,GAAA,UAAa,KAAA;;;;;;APPlC;;;KQCY,cAAA;;;KCNA,WAAA,MAAiB,CAAA,cAAc,IAAA,2BACvC,CAAA,GACA,CAAA,yCACW,WAAA,CAAY,CAAA,MACrB,CAAA,gCACgB,CAAA,IAAK,WAAA,CAAY,CAAA,CAAE,CAAA,OACjC,CAAA;;;KCJH,MAAA;EAGC,IAAA;EACA,KAAA;EACA,GAAA;AAAA;AAAA,KAGD,UAAA;EAGC,IAAA;EACA,GAAA;EACA,SAAA;AAAA;AAAA,KAGD,IAAA;EAGC,GAAA;EACA,KAAA;AAAA;AAAA,KAGD,WAAA;EAGC,GAAA;EACA,IAAA;AAAA;AAAA,KAGD,OAAA,GAAU,WAAA,GAAc,WAAA;AAAA,KAExB,WAAA;EACH,IAAA;EACA,GAAA;AAAA;AAAA,KAGG,aAAA;EACH,IAAA;EACA,OAAA;EACA,MAAA;AAAA;AAAA,KAGG,cAAA,GAAiB,aAAA,GAAgB,aAAA;AAAA,KAEjC,UAAA;EACH,EAAA,EAAI,cAAA;EACJ,GAAA,EAAK,cAAA;EACL,IAAA,EAAM,cAAA;EACN,OAAA,EAAS,cAAA;EACT,cAAA,EAAgB,cAAA;AAAA;AAAA,KAGN,WAAA,GAAc,WAAA;EACxB,IAAA;EACA,WAAA;EACA,OAAA;EACA,WAAA;EACA,QAAA;EAEA,OAAA;EAEA,QAAA;EACA,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,IAAA;EAEN,OAAA;EACA,QAAA,EAAU,WAAA;EAEV,MAAA,EAAQ,MAAA;EACR,YAAA,EAAc,MAAA;EACd,WAAA,EAAa,MAAA;EAEb,OAAA,EAAS,OAAA;EAET,KAAA;EAEA,IAAA;EACA,MAAA;EACA,KAAA;EACA,OAAA;EAEA,OAAA;EACA,OAAA,EAAS,MAAA;EAET,GAAA,WAAc,MAAA;EACd,GAAA;EAEA,IAAA;EAEA,WAAA;IACE,GAAA;IACA,GAAA;IACA,OAAA;IACA,GAAA;IACA,GAAA;IACA,IAAA;EAAA;EAGF,OAAA,EAAS,MAAA;EACT,MAAA,EAAQ,MAAA;EAER,YAAA,EAAc,MAAA;EACd,eAAA,EAAiB,MAAA;EACjB,oBAAA,EAAsB,MAAA;EACtB,gBAAA,EAAkB,MAAA;EAElB,oBAAA,EAAsB,MAAA;IAGlB,QAAA;EAAA;EAIJ,kBAAA;EACA,mBAAA;EAEA,OAAA,EAAS,MAAA;EACT,YAAA;EAEA,EAAA;EACA,GAAA;EAEA,UAAA,EAAY,UAAA;EAEZ,YAAA;EAEA,aAAA;IACE,MAAA;IACA,GAAA;IACA,QAAA;IACA,UAAA;EAAA;EAGF,IAAA;IACE,MAAA;IACA,OAAA;EAAA;EAGF,MAAA;EAEA,MAAA;IAGM,IAAA;IACA,OAAA;EAAA;EAGN,UAAA;IAGM,QAAA;IACA,OAAA;EAAA;EAGN,WAAA,EAAa,MAAA;EACb,SAAA,EAAW,MAAA;EAEX,cAAA;EAEA,aAAA,EAAe,MAAA,SAAe,MAAA;EAE9B,KAAA;IACE,OAAA;IACA,IAAA;IACA,GAAA;IACA,IAAA;IACA,IAAA;EAAA;EAGF,IAAA,EAAM,MAAA;EAEN,YAAA,EAAc,MAAA;EACd,QAAA,EAAU,MAAA;EACV,SAAA,EAAW,MAAA;EACX,GAAA,EAAK,MAAA;EACL,OAAA,EAAS,MAAA;EACT,KAAA,EAAO,MAAA;EAEP,UAAA;IACE,mBAAA;IACA,YAAA;IACA,cAAA;IACA,GAAA,EAAK,MAAA;EAAA;EAAA,CAGN,GAAA;AAAA;;;;KC3LS,WAAA,GAAc,MAAA,CAAO,WAAA;;;;;;UCEhB,IAAA;EZEc;;;;;;EAAA,CYK5B,GAAA;EZ6BD;;;;;;EYrBA,KAAA,CAAM,GAAA;;;AXfR;;;;EWuBE,GAAA,CAAI,GAAA;;;;AVpBN;;;EU4BE,mBAAA,CAAoB,GAAA;AAAA"}

package/dist/index.d.mts

@@ -154,6 +154,20 @@ type Hour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15
  */
 type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 509 | 510 | 511;
 //#endregion
+//#region src/json.d.ts
+/**
+ * Represents the `replacer` argument accepted by {@link JSON.stringify}
+ *
+ * This type unifies the two overloads of `JSON.stringify` into a single.
+ *
+ * @remarks
+ * - The function form is called for each key-value pair during serialization.
+ * - Returning `undefined` from the function will omit the property.
+ * - The array form acts as a whitelist of keys to include.
+ * - Defined explicitly to avoid TypeScript overload inference issues with `Parameters<typeof JSON.stringify>[1]`.
+ */
+type JsonReplacer = ((this: unknown, key: string, value: unknown) => unknown) | readonly (string | number)[] | null;
+//#endregion
 //#region src/MinuteOrSecond.d.ts
 /**
  * Represents a minute or second value in time.
@@ -300,6 +314,10 @@ type PackageJson = DeepPartial<{
   [key: string]: unknown;
 }>;
 //#endregion
+//#region src/PlainObject.d.ts
+/** Represents a generic JavaScript object with arbitrary property keys */
+type PlainObject = Record<PropertyKey, unknown>;
+//#endregion
 //#region src/Trim.d.ts
 /**
  * Trims whitespace from a string with methods for leading and trailing and normalizing whitespace.
@@ -335,4 +353,5 @@ interface Trim {
   normalizeWhitespace(str: string): string;
 }
 //#endregion
-export { ArchiveFormat, ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, MinuteOrSecond, PackageJson, Trim };
+export { ArchiveFormat, type ArchiverOptions, CommitTypeMeta, CreateArchiveOptions, Environment, Falsy, Hour, HttpStatusCode, JsonReplacer, MinuteOrSecond, PackageJson, PlainObject, Trim };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/commit/types.ts","../src/ArchiveFormat.ts","../src/CreateArchiveOptions.ts","../src/Environment.ts","../src/Falsy.ts","../src/Hour.ts","../src/HttpStatusCode.ts","../src/json.ts","../src/MinuteOrSecond.ts","../src/utils/DeepPartial.ts","../src/PackageJson.ts","../src/PlainObject.ts","../src/Trim.ts"],"mappings":";;;;;;AAKA;;UAAiB,cAAA;EAAc;;;;;;;;;EAU7B,IAAA;EAuCU;;;EAlCV,WAAA;ECjBU;;;;;;;ED0BV,oBAAA;EEvBe;;;EF4Bf,iBAAA;EExBA;;;EF6BA,kBAAA;EEXA;;;EFgBA,KAAA;EENa;;;EFWb,IAAA;;;AGpCF;EHyCE,UAAA;AAAA;;;;;;KCnDU,aAAA;;;;ADEZ;;UECiB,oBAAA;EFDc;;;EEK7B,MAAA,EAAQ,aAAA;EFwBR;;;EEnBA,MAAA;EFuCA;;;;;;EE/BA,WAAA;EDpBuB;;;ECyBvB,OAAA,GAAU,iBAAA;;;;EAKV,GAAA;EA3BmC;;;EAgCnC,SAAA,IAAa,KAAA;AAAA;;;;;;AFjCf;;;;;;;;;;cGQa,WAAA;EHyCX,2EAAU;EAAA;yBCnDA;EAAA;;KEsBA,WAAA,WAAsB,WAAA,eAA0B,WAAA;;;;;;AHpB5D;;;;;;;;;KIOY,KAAA;;;;;;AJPZ;;;KKCY,IAAA;;;;;;ALDZ;;;;;;;;;;;KMSY,cAAA;;;;;;ANTZ;;;;;;;;KOMY,YAAA,KACN,IAAA,WAAe,GAAA,UAAa,KAAA;;;;;;APPlC;;;KQCY,cAAA;;;KCNA,WAAA,MAAiB,CAAA,cAAc,IAAA,2BACvC,CAAA,GACA,CAAA,yCACW,WAAA,CAAY,CAAA,MACrB,CAAA,gCACgB,CAAA,IAAK,WAAA,CAAY,CAAA,CAAE,CAAA,OACjC,CAAA;;;KCJH,MAAA;EAGC,IAAA;EACA,KAAA;EACA,GAAA;AAAA;AAAA,KAGD,UAAA;EAGC,IAAA;EACA,GAAA;EACA,SAAA;AAAA;AAAA,KAGD,IAAA;EAGC,GAAA;EACA,KAAA;AAAA;AAAA,KAGD,WAAA;EAGC,GAAA;EACA,IAAA;AAAA;AAAA,KAGD,OAAA,GAAU,WAAA,GAAc,WAAA;AAAA,KAExB,WAAA;EACH,IAAA;EACA,GAAA;AAAA;AAAA,KAGG,aAAA;EACH,IAAA;EACA,OAAA;EACA,MAAA;AAAA;AAAA,KAGG,cAAA,GAAiB,aAAA,GAAgB,aAAA;AAAA,KAEjC,UAAA;EACH,EAAA,EAAI,cAAA;EACJ,GAAA,EAAK,cAAA;EACL,IAAA,EAAM,cAAA;EACN,OAAA,EAAS,cAAA;EACT,cAAA,EAAgB,cAAA;AAAA;AAAA,KAGN,WAAA,GAAc,WAAA;EACxB,IAAA;EACA,WAAA;EACA,OAAA;EACA,WAAA;EACA,QAAA;EAEA,OAAA;EAEA,QAAA;EACA,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,IAAA;EAEN,OAAA;EACA,QAAA,EAAU,WAAA;EAEV,MAAA,EAAQ,MAAA;EACR,YAAA,EAAc,MAAA;EACd,WAAA,EAAa,MAAA;EAEb,OAAA,EAAS,OAAA;EAET,KAAA;EAEA,IAAA;EACA,MAAA;EACA,KAAA;EACA,OAAA;EAEA,OAAA;EACA,OAAA,EAAS,MAAA;EAET,GAAA,WAAc,MAAA;EACd,GAAA;EAEA,IAAA;EAEA,WAAA;IACE,GAAA;IACA,GAAA;IACA,OAAA;IACA,GAAA;IACA,GAAA;IACA,IAAA;EAAA;EAGF,OAAA,EAAS,MAAA;EACT,MAAA,EAAQ,MAAA;EAER,YAAA,EAAc,MAAA;EACd,eAAA,EAAiB,MAAA;EACjB,oBAAA,EAAsB,MAAA;EACtB,gBAAA,EAAkB,MAAA;EAElB,oBAAA,EAAsB,MAAA;IAGlB,QAAA;EAAA;EAIJ,kBAAA;EACA,mBAAA;EAEA,OAAA,EAAS,MAAA;EACT,YAAA;EAEA,EAAA;EACA,GAAA;EAEA,UAAA,EAAY,UAAA;EAEZ,YAAA;EAEA,aAAA;IACE,MAAA;IACA,GAAA;IACA,QAAA;IACA,UAAA;EAAA;EAGF,IAAA;IACE,MAAA;IACA,OAAA;EAAA;EAGF,MAAA;EAEA,MAAA;IAGM,IAAA;IACA,OAAA;EAAA;EAGN,UAAA;IAGM,QAAA;IACA,OAAA;EAAA;EAGN,WAAA,EAAa,MAAA;EACb,SAAA,EAAW,MAAA;EAEX,cAAA;EAEA,aAAA,EAAe,MAAA,SAAe,MAAA;EAE9B,KAAA;IACE,OAAA;IACA,IAAA;IACA,GAAA;IACA,IAAA;IACA,IAAA;EAAA;EAGF,IAAA,EAAM,MAAA;EAEN,YAAA,EAAc,MAAA;EACd,QAAA,EAAU,MAAA;EACV,SAAA,EAAW,MAAA;EACX,GAAA,EAAK,MAAA;EACL,OAAA,EAAS,MAAA;EACT,KAAA,EAAO,MAAA;EAEP,UAAA;IACE,mBAAA;IACA,YAAA;IACA,cAAA;IACA,GAAA,EAAK,MAAA;EAAA;EAAA,CAGN,GAAA;AAAA;;;;KC3LS,WAAA,GAAc,MAAA,CAAO,WAAA;;;;;;UCEhB,IAAA;EZEc;;;;;;EAAA,CYK5B,GAAA;EZ6BD;;;;;;EYrBA,KAAA,CAAM,GAAA;;;AXfR;;;;EWuBE,GAAA,CAAI,GAAA;;;;AVpBN;;;EU4BE,mBAAA,CAAoB,GAAA;AAAA"}