@maxclicks/utilities 1.6.0 → 1.6.1

package/dist/types.d.ts

@@ -1,27 +1,56 @@
+/** Like `Omit`, but constrains `K` to keys of `T` for type safety. */
 export type OmitTyped<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+/** Like `Exclude`, but constrains `U` to extend `T` for type safety. */
 export type ExcludeTyped<T, U extends T> = T extends U ? never : T;
+/** Removes `readonly` modifier from all properties of `T`. */
 export type Writable<T> = {
     -readonly [K in keyof T]: T[K];
 };
+/** Recursively removes `readonly` modifier from all properties. */
 export type DeepWritable<T> = T extends BuiltIns ? T : T extends ReadonlyArray<infer U> ? Array<DeepWritable<U>> : T extends ReadonlyMap<infer K, infer V> ? Map<K, DeepWritable<V>> : T extends ReadonlySet<infer M> ? Set<DeepWritable<M>> : {
     -readonly [K in keyof T]: DeepWritable<T[K]>;
 };
+/** Recursively adds `readonly` modifier to all properties. */
 export type DeepReadonly<T> = T extends BuiltIns ? T : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<K, DeepReadonly<V>> : T extends ReadonlySet<infer M> ? ReadonlySet<DeepReadonly<M>> : {
     readonly [K in keyof T]: DeepReadonly<T[K]>;
 };
+/** Recursively makes all properties optional. */
 export type DeepPartial<T> = T extends BuiltIns ? T : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U> | undefined> : T extends Array<infer U> ? Array<DeepPartial<U> | undefined> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<K, DeepPartial<V> | undefined> : T extends Map<infer K, infer V> ? Map<K, DeepPartial<V> | undefined> : T extends ReadonlySet<infer M> ? ReadonlySet<DeepPartial<M>> : T extends Set<infer M> ? Set<DeepPartial<M>> : {
     [K in keyof T]?: DeepPartial<T[K]>;
 };
+/** Narrows a union type `U` to members with a specific `type` discriminant. */
 export type WithType<U extends {
     readonly type?: any;
 }, T extends U['type']> = U & {
     readonly type: T;
 };
+/**
+ * Works together with the `typed()` helper function to help define objects with
+ * specific types that _extend_ some other type.
+ *
+ * @example
+ * ```ts
+ * interface Base { x: number }
+ *
+ * const extendingValue = (typed as Extender<Base>)({ x: 123, y: 'foo' }) // ✅ typeof extendingValue === { x: number; y: string }
+ *
+ * const invalidValue = (typed as Extender<Base>)({ y: 'foo' }) // ❌ TypeScript will complain about the value not extending the Base type correctly.
+ * ```
+ */
 export type Extender<U> = <T extends U>(value: T) => T;
+/**
+ * Sometimes TypeScript fails to figure out the "index signature of 'string'"
+ * in some type definitions, thus considers them unable to extend some base
+ * types like `Readonly<string, unknown>`.
+ * Even though. this is practically the same as the given type, it can help
+ * TypeScript to figure out the index signature it expects.
+ */
 export type WithStringIndexSignature<T> = {
     [Key in keyof T]: T[Key];
 };
+/** Values that are falsy in JavaScript. */
 export type Falsy = false | '' | 0 | null | undefined | void;
+/** Excludes falsy values from type `T`. */
 export type Trucy<T> = Exclude<T, Falsy>;
 type BuiltIns = Primitive | Function | Date | RegExp;
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAG1E,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;AAGlE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAG5D,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC5C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACtB,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GACvB,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACpB;IACE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAA;AAGX,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC5C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC9B,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GAC/B,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC5B;IACE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAA;AAGX,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC3C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GACzC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACtB,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GACjC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,WAAW,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAC1C,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC7B,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAClC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC3B,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACpB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACnB;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAA;AAGjB,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAA;CAAE,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CAAE,CAAA;AAevG,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;AAStD,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;CAAE,CAAA;AAGtE,MAAM,MAAM,KAAK,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAA;AAG5D,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;AAGxC,KAAK,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAA;AAEpD,KAAK,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE1E,wEAAwE;AACxE,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;AAElE,8DAA8D;AAC9D,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAE5D,mEAAmE;AACnE,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC5C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACtB,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GACvB,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACpB;IACE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAA;AAEX,8DAA8D;AAC9D,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC5C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC9B,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GAC/B,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAC5B;IACE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAA;AAEX,iDAAiD;AACjD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC3C,CAAC,GACD,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAC9B,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GACzC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACtB,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GACjC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACrC,WAAW,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAC1C,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC7B,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GAClC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC3B,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACpB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACnB;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAA;AAEjB,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAA;CAAE,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CAAE,CAAA;AAEvG;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;AAEtD;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;CAAE,CAAA;AAEtE,2CAA2C;AAC3C,MAAM,MAAM,KAAK,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAA;AAE5D,2CAA2C;AAC3C,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;AAGxC,KAAK,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAA;AAEpD,KAAK,SAAS,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxclicks/utilities",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "The common utility implementations shared by maxclicks projects",
   "license": "MIT",
   "type": "module",