@battis/typescript-tricks 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @battis/typescript-tricks
+
+## 0.5.1
+
+### Patch Changes
+
+- 28bf17c: repo moved to @battis/typescript-config monorepo

package/package.json

@@ -1,47 +1,32 @@
 {
   "name": "@battis/typescript-tricks",
   "description": "A handful of useful types and operators",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "author": "Seth Battis <seth@battis.net>",
   "license": "GPL-3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "homepage": "https://github.com/battis/typescript-tricks#readme",
+  "homepage": "https://github.com/battis/typescript-config/tree/main/packages/tricks#readme",
   "engines": {
     "node": "*"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/battis/typescript-tricks.git"
+    "url": "https://github.com/battis/typescript-config.git",
+    "directory": "packages/tricks"
   },
   "bugs": {
-    "url": "https://github.com/battis/typescript-tricks/issues"
-  },
-  "scripts": {
-    "build": "run-s build:*",
-    "build:clean": "shx rm -rf dist",
-    "build:compile": "tsc",
-    "release": "run-s release:*",
-    "release:build": "npm run build",
-    "release:publish": "np --yolo --no-release-draft"
+    "url": "https://github.com/battis/typescript-config/issues"
   },
   "devDependencies": {
-    "@battis/eslint-config": "github:battis/eslint-config",
-    "@battis/prettier-config": "github:battis/prettier-config",
     "@tsconfig/recommended": "^1.0.3",
-    "np": "^8.0.4",
     "npm-run-all": "^4.1.5",
     "shx": "^0.3.4",
     "typescript": "^4.9.5"
   },
-  "prettier": "@battis/prettier-config",
-  "eslintConfig": {
-    "extends": [
-      "@battis/eslint-config"
-    ]
-  },
-  "np": {
-    "cleanup": false,
-    "tests": false
+  "scripts": {
+    "build": "run-s build:*",
+    "build:clean": "shx rm -rf dist",
+    "build:compile": "tsc"
   }
-}
+}

package/dist/Constructor.d.ts

@@ -1,21 +0,0 @@
-export type Constructor<T = object> = new (...args: any[]) => T;
-export declare const isConstructor: (value: any) => value is Constructor<any>;
-/**
- * ```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 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,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOf = exports.filterByType = exports.isConstructor = void 0;
-const isConstructor = (value) => {
-    return !!value && !!value.prototype && !!value.prototype.constructor;
-};
-exports.isConstructor = isConstructor;
-/**
- * ```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 filterByType(array, filterType) {
-    return array.filter((e) => e instanceof filterType);
-}
-exports.filterByType = filterByType;
-/** @deprecated use {@link filterByType} */
-exports.instanceOf = filterByType;

package/dist/EnumeratedTypes.d.ts

@@ -1,11 +0,0 @@
-type EnumObject = {
-    [key: string]: number | string;
-};
-type EnumObjectEnum<E extends EnumObject> = E extends {
-    [key: string]: infer ET | string;
-} ? ET : never;
-/**
- * @see {@link https://blog.oyam.dev/typescript-enum-values/ How to get an array of enum values in TypeScript}
- */
-export declare function getEnumValues<E extends EnumObject>(enumObject: E): EnumObjectEnum<E>[];
-export {};

package/dist/EnumeratedTypes.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnumValues = void 0;
-/**
- * @see {@link https://blog.oyam.dev/typescript-enum-values/ How to get an array of enum values in TypeScript}
- */
-function getEnumValues(enumObject) {
-    return Object.keys(enumObject)
-        .filter((key) => Number.isNaN(Number(key)))
-        .map((key) => enumObject[key]);
-}
-exports.getEnumValues = getEnumValues;

package/dist/JSONValue.d.ts

@@ -1,9 +0,0 @@
-export type JSONValue = string | number | boolean | null | JSONValue[] | {
-    [key: string]: JSONValue;
-};
-export interface JSONObject {
-    [k: string]: JSONValue;
-}
-export interface JSONArray extends Array<JSONValue> {
-}
-export default JSONValue;

package/dist/JSONValue.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/MethodNames.d.ts

@@ -1,13 +0,0 @@
-/**
- * @see https://stackoverflow.com/a/61940388
- */
-export type MethodNames<T extends {
-    [K in keyof T]: any;
-}> = {
-    [K in keyof T]: T[K] extends Function ? K : never;
-}[keyof T];
-export type MethodNamesMatching<T extends {
-    [K in keyof T]: any;
-}, P extends Function = Function> = {
-    [K in keyof T]: T[K] extends Function ? P extends T[K] ? K : never : never;
-}[keyof T];

package/dist/MethodNames.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/Mixin.d.ts

@@ -1,2 +0,0 @@
-/** @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/Mixin.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/PropertyRequirements.d.ts

@@ -1,40 +0,0 @@
-/**
- * @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 {@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/PropertyRequirements.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/Shorthand.d.ts

@@ -1,11 +0,0 @@
-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;
-};
-export type JSONPrimitiveTypes = string | number | boolean | null;

package/dist/Shorthand.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/StaticImplements.d.ts

@@ -1,23 +0,0 @@
-/**
-
-@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,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,8 +0,0 @@
-export * from './Constructor';
-export * from './EnumeratedTypes';
-export * from './Mixin';
-export * from './PropertyRequirements';
-export * from './Shorthand';
-export * from './StaticImplements';
-export * from './JSONValue';
-export * from './MethodNames';

package/dist/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Constructor"), exports);
-__exportStar(require("./EnumeratedTypes"), exports);
-__exportStar(require("./Mixin"), exports);
-__exportStar(require("./PropertyRequirements"), exports);
-__exportStar(require("./Shorthand"), exports);
-__exportStar(require("./StaticImplements"), exports);
-__exportStar(require("./JSONValue"), exports);
-__exportStar(require("./MethodNames"), exports);