type-plus 7.3.0 → 7.3.1

package/README.md

@@ -325,6 +325,7 @@ You can learn more in their respective sections:
 - [undefined](./ts/undefined/readme.md)
 - [unknown](./ts/unknown/readme.md)
 - [void](./ts/void/readme.md)
+- [mix types](./ts/mix-types/readme.md)
 
 ### any
 

package/cjs/mix_types/any_or_never_type.d.ts

@@ -1,20 +1,28 @@
-import type { IsNever } from '../never/never_type.js';
-import type { IsAny } from '../any/any_type.js';
+import type { AnyType } from '../any/any_type.js';
+import type { NeverType } from '../never/never_type.js';
 /**
- * 🐾 Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ * Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ *
+ * 🐾 *parse*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
- * type R = AnyType<any> // any
+ * type R = AnyOrNeverType<any> // any
+ * type R = AnyOrNeverType<never> // never
+ * type R = AnyOrNeverType<never, 1, 2> // 1
  *
- * type R = AnyType<never> // never
- * type R = AnyType<unknown> // never
- * type R = AnyType<string | boolean> // never
+ * type R = AnyOrNeverType<unknown> // never
+ * type R = AnyOrNeverType<unknown, 1, 2> // 2
+ * type R = AnyOrNeverType<string | boolean> // never
  * ```
  */
-export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T, Then, Else>>;
+export type AnyOrNeverType<T, Then = T, Else = never> = NeverType<T, Then, AnyType<T, Then, Else>>;
 /**
- * 🎭 Validate if `T` is either exactly `any` or exactly `never`.
+ * Validate if `T` is either exactly `any` or exactly `never`.
+ *
+ * 🎭 *validate*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
@@ -25,5 +33,5 @@ export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T
  * type R = IsAnyOrNever<unknown> // false
  * ```
  */
-export type IsAnyOrNever<T, Then = true, Else = false> = IsNever<T, Then, IsAny<T, Then, Else>>;
+export type IsAnyOrNever<T, Then = true, Else = false> = NeverType<T, Then, AnyType<T, Then, Else>>;
 //# sourceMappingURL=any_or_never_type.d.ts.map

package/cjs/mix_types/any_or_never_type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"any_or_never_type.d.ts","sourceRoot":"","sources":["../../ts/mix_types/any_or_never_type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE/C;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAE9F;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA"}
+{"version":3,"file":"any_or_never_type.d.ts","sourceRoot":"","sources":["../../ts/mix_types/any_or_never_type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAElG;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA"}

package/esm/mix_types/any_or_never_type.d.ts

@@ -1,20 +1,28 @@
-import type { IsNever } from '../never/never_type.js';
-import type { IsAny } from '../any/any_type.js';
+import type { AnyType } from '../any/any_type.js';
+import type { NeverType } from '../never/never_type.js';
 /**
- * 🐾 Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ * Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ *
+ * 🐾 *parse*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
- * type R = AnyType<any> // any
+ * type R = AnyOrNeverType<any> // any
+ * type R = AnyOrNeverType<never> // never
+ * type R = AnyOrNeverType<never, 1, 2> // 1
  *
- * type R = AnyType<never> // never
- * type R = AnyType<unknown> // never
- * type R = AnyType<string | boolean> // never
+ * type R = AnyOrNeverType<unknown> // never
+ * type R = AnyOrNeverType<unknown, 1, 2> // 2
+ * type R = AnyOrNeverType<string | boolean> // never
  * ```
  */
-export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T, Then, Else>>;
+export type AnyOrNeverType<T, Then = T, Else = never> = NeverType<T, Then, AnyType<T, Then, Else>>;
 /**
- * 🎭 Validate if `T` is either exactly `any` or exactly `never`.
+ * Validate if `T` is either exactly `any` or exactly `never`.
+ *
+ * 🎭 *validate*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
@@ -25,5 +33,5 @@ export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T
  * type R = IsAnyOrNever<unknown> // false
  * ```
  */
-export type IsAnyOrNever<T, Then = true, Else = false> = IsNever<T, Then, IsAny<T, Then, Else>>;
+export type IsAnyOrNever<T, Then = true, Else = false> = NeverType<T, Then, AnyType<T, Then, Else>>;
 //# sourceMappingURL=any_or_never_type.d.ts.map

package/esm/mix_types/any_or_never_type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"any_or_never_type.d.ts","sourceRoot":"","sources":["../../ts/mix_types/any_or_never_type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE/C;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAE9F;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA"}
+{"version":3,"file":"any_or_never_type.d.ts","sourceRoot":"","sources":["../../ts/mix_types/any_or_never_type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAElG;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "type-plus",
-  "version": "7.3.0",
+  "version": "7.3.1",
   "description": "Provides additional types for TypeScript.",
-  "homepage": "https://github.com/unional/type-plus/tree/main/type-plus",
+  "homepage": "https://github.com/unional/type-plus/tree/main/type-plus#readme",
   "bugs": {
     "url": "https://github.com/unional/type-plus/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/unional/type-plus.git"
+    "url": "https://github.com/unional/type-plus.git",
+    "directory": "type-plus"
   },
   "license": "MIT",
   "author": {

package/ts/any/readme.md

@@ -1,6 +1,8 @@
 # Any
 
-`any` is one of the two top type in TypeScript. It is the supertype of all types. It is a way to opt-out of type checking and let the values pass through compile-time checks.
+`any` is one of the two top types in TypeScript.
+It is a supertype of all types.
+It is a way to opt-out of type checking and let the values pass through compile-time checks.
 
 ## Type Checking
 
@@ -15,9 +17,24 @@ except `any & never` which is `never`.
 - [`NotAnyType<T, Then = T, Else = never>`](any_type.ts#L45): check if `T` is not exactly `any`.
 - [`IsNotAny<T, Then = true, Else = false>`](any_type.ts#L60): is `T` not exactly `any`.
 
-## Type Utilities
+## Trivia
 
-- [`IsAnyOrNever<T, Then = true, Else = false>`](any_or_never.ts#L17)]: is `T` type `any` or `never`.
+> Both `any` and `unknown` are top types?
+
+Well, yeah:
+
+```ts
+type A = any extends unknown ? 1 : 2 // 1
+type B = unknown extends any ? 1 : 2 // 1
+```
+
+> Aren't using `any` is bad?
+
+If you use it to simply tell TypeScript to shut up because you are lazy, then yes.
+
+But it is ok to use `any` in many cases, as the type system of TypeScript is not sounded.
+
+There are many cases it is not possible to induce the type correctly.
 
 ## References
 

package/ts/mix_types/any_or_never_type.ts

@@ -1,22 +1,30 @@
-import type { IsNever } from '../never/never_type.js'
-import type { IsAny } from '../any/any_type.js'
+import type { AnyType } from '../any/any_type.js'
+import type { NeverType } from '../never/never_type.js'
 
 /**
- * 🐾 Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ * Parse `T` to ensure it is either exactly `any` or exactly `never`.
+ *
+ * 🐾 *parse*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
- * type R = AnyType<any> // any
+ * type R = AnyOrNeverType<any> // any
+ * type R = AnyOrNeverType<never> // never
+ * type R = AnyOrNeverType<never, 1, 2> // 1
  *
- * type R = AnyType<never> // never
- * type R = AnyType<unknown> // never
- * type R = AnyType<string | boolean> // never
+ * type R = AnyOrNeverType<unknown> // never
+ * type R = AnyOrNeverType<unknown, 1, 2> // 2
+ * type R = AnyOrNeverType<string | boolean> // never
  * ```
  */
-export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T, Then, Else>>
+export type AnyOrNeverType<T, Then = T, Else = never> = NeverType<T, Then, AnyType<T, Then, Else>>
 
 /**
- * 🎭 Validate if `T` is either exactly `any` or exactly `never`.
+ * Validate if `T` is either exactly `any` or exactly `never`.
+ *
+ * 🎭 *validate*
+ * 🩳 *shortcut*
  *
  * @example
  * ```ts
@@ -27,4 +35,4 @@ export type AnyOrNeverType<T, Then = T, Else = never> = IsNever<T, Then, IsAny<T
  * type R = IsAnyOrNever<unknown> // false
  * ```
  */
-export type IsAnyOrNever<T, Then = true, Else = false> = IsNever<T, Then, IsAny<T, Then, Else>>
+export type IsAnyOrNever<T, Then = true, Else = false> = NeverType<T, Then, AnyType<T, Then, Else>>

package/ts/mix_types/readme.md

@@ -0,0 +1,34 @@
+# Mix Types
+
+This folder contains types and utilities that work across multiple types.
+
+## [AnyOrNeverType](./any_or_never_type.ts)
+
+`AnyOrNeverType<T, Then = T, Else = never>` 🎭 🩳
+
+Parse `T` to ensure it is either exactly `any` or exactly `never`.
+
+```ts
+import type { AnyOrNeverType } from 'type-plus'
+
+type R = AnyOrNeverType<any> // any
+type R = AnyOrNeverType<never> // never
+type R = AnyOrNeverType<never, 1, 2> // 1
+
+type R = AnyOrNeverType<unknown, 1, 2> // 2
+```
+
+## [IsAnyOrNever](./any_or_never_type.ts)
+
+`IsAnyOrNever<T, Then = true, Else = false>` 🎭 🩳
+
+Validate if `T` is either exactly `any` or exactly `never`.
+
+```ts
+import type { IsAnyOrNever } from 'type-plus'
+
+type R = IsAnyOrNever<any> // true
+type R = IsAnyOrNever<never> // true
+
+type R = IsAnyOrNever<unknown> // false
+```