@battis/typescript-tricks 0.3.0 → 0.4.1

package/dist/Constructor.d.ts

@@ -1,9 +1,21 @@
-export type Constructor<T> = new (...args: any[]) => T;
+export type Constructor<T = object> = new (...args: any[]) => T;
 export declare const isConstructor: (value: any) => value is Constructor<any>;
 /**
- * TODO is this even useful?
- *   Not sure why I included it, it seems more likely that it's related to
- *   wanting [this](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)?
+ * ```ts
+ * class A {}
+ * class B {}
+ * class C extends A {}
+ *
+ * const a = new A();
+ * const b = new B();
+ * const c = new C();
+ *
+ * const list = [a, b, c];
+ * const filteredList = instanceOf(list, A);
+ * // filteredList = [a, c]
+ * ```
  * @ see https://stackoverflow.com/a/65152869/294171
  */
-export declare function instanceOf<TElements, TFilter extends TElements>(array: TElements[], filterType: Constructor<TFilter>): TFilter[];
+export declare function filterByType<Elements, Filter extends Elements>(array: Elements[], filterType: Constructor<Filter>): Filter[];
+/** @deprecated use {@link filterByType} */
+export declare const instanceOf: typeof filterByType;

package/dist/Constructor.js

@@ -1,17 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOf = exports.isConstructor = void 0;
+exports.instanceOf = exports.filterByType = exports.isConstructor = void 0;
 const isConstructor = (value) => {
     return !!value && !!value.prototype && !!value.prototype.constructor;
 };
 exports.isConstructor = isConstructor;
 /**
- * TODO is this even useful?
- *   Not sure why I included it, it seems more likely that it's related to
- *   wanting [this](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)?
+ * ```ts
+ * class A {}
+ * class B {}
+ * class C extends A {}
+ *
+ * const a = new A();
+ * const b = new B();
+ * const c = new C();
+ *
+ * const list = [a, b, c];
+ * const filteredList = instanceOf(list, A);
+ * // filteredList = [a, c]
+ * ```
  * @ see https://stackoverflow.com/a/65152869/294171
  */
-function instanceOf(array, filterType) {
+function filterByType(array, filterType) {
     return array.filter((e) => e instanceof filterType);
 }
-exports.instanceOf = instanceOf;
+exports.filterByType = filterByType;
+/** @deprecated use {@link filterByType} */
+exports.instanceOf = filterByType;

package/dist/Mixin.d.ts

@@ -1 +1,2 @@
+/** @deprecated see {@link https://www.typescriptlang.org/docs/handbook/mixins.html#constrained-mixins TypeScript docs} */
 export type Mixin<T extends (...args: any[]) => any> = InstanceType<ReturnType<T>>;

package/dist/PropertyRequirements.d.ts

@@ -1,10 +1,40 @@
+/**
+ * @see {@link https://stackoverflow.com/a/49725198/294171 StackOverflow response} on requiring at least one property
+ */
 export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
 }[Keys];
+/**
+ * @see {@link https://stackoverflow.com/a/49725198/294171 StackOverflow response} on requiring only one property
+ */
 export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
 }[Keys];
-/** @see https://stackoverflow.com/a/51365037 */
+/** @see {@link https://stackoverflow.com/a/51365037 StackOverflow response} */
 export type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
 };
+/**
+ * ```ts
+ * type A = {
+ *   d: number,
+ *   e: string
+ *   f: boolean
+ * }
+ *
+ * type B = ReplaceProperty<A, 'e', number[]>;
+ * // type B = {
+ * //   d: number,
+ * //   e: number[],
+ * //   f: boolean
+ * // }
+ * ```
+ * @see {@link https://stackoverflow.com/a/51599774 StackOverflow response}
+ */
+export type ReplaceProperty<T, K extends keyof T, TReplace> = Identity<Pick<T, Exclude<keyof T, K>> & {
+    [P in K]: TReplace;
+}>;
+type Identity<T> = {
+    [P in keyof T]: T[P];
+};
+export {};

package/dist/Shorthand.d.ts

@@ -1,7 +1,10 @@
 export type AsynchronousFunction = () => Promise<any>;
+/** @deprecated `null` is part of type unless using utility type `Nonnullable` */
 export type Nullable<T> = T | null;
+/** @deprecated use `?` */
 export type Optional<T> = T | undefined;
 export type Subset<T, U extends T> = T;
+/** @deprecated use `Record<string,T>` */
 export type AssociativeArray<T> = {
     [key: string]: T;
 };

package/dist/StaticImplements.d.ts

@@ -1 +1,23 @@
+/**
+
+@see {@link https://stackoverflow.com/a/69571314/294171 StackOverflow response} on static interfaces
+
+```ts
+interface InstanceInterface {
+  instanceMethod();
+}
+
+interface StaticInterface {
+  new(...args: any[]): InstanceInterface;
+  staticMethod();
+}
+
+class MyClass implements StaticImplements<StaticInterface, typeof MyClass> {
+  static staticMethod() { }
+  static ownStaticMethod() { }
+  instanceMethod() { }
+  ownInstanceMethod() { }
+}
+```
+*/
 export type StaticImplements<I extends new (...args: any[]) => any, C extends I> = InstanceType<C>;

package/dist/StaticImplements.js

@@ -1,25 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/*
-
-https://stackoverflow.com/a/69571314/294171
-
-Usage:
-
-interface InstanceInterface {
-  instanceMethod();
-}
-
-interface StaticInterface {
-  new(...args: any[]): InstanceInterface;
-  staticMethod();
-}
-
-class MyClass implements StaticImplements<StaticInterface, typeof MyClass> {
-  static staticMethod() { }
-  static ownStaticMethod() { }
-  instanceMethod() { }
-  ownInstanceMethod() { }
-}
-
-*/

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@battis/typescript-tricks",
   "description": "A handful of useful types and operators",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "author": "Seth Battis <seth@battis.net>",
   "license": "GPL-3.0",
   "main": "./dist/index.js",