type-plus 6.5.0 → 6.7.0

package/ts/type/readme.md

@@ -0,0 +1,36 @@
+# type
+
+General type utilities.
+
+## Failed
+
+`Failed<Msg>` is a type to describe a failure.
+
+Use the same concept to create your own failure types.
+
+```ts
+import { type Failed } from 'type-plus'
+
+type YourComplexType<A,B,C> = A extends B ?
+  ... // and many more hard work later...
+  : Failed<'you are doing something wrong!'>
+```
+
+[![Just Code: I failed][failed-type]][failed-type-url]
+
+## NoInfer
+
+`NoInfer<T>` is a type to prevent type inference.
+
+```ts
+import { type NoInfer } from 'type-plus'
+
+ function assertEqual<T>(a: T, b: NoInfer<T>) {
+   return a === b
+ }
+
+ function stub<T>(v: RecursivePartial<NoInfer<T>>): T { return v }
+```
+
+[failed-type]: https://img.youtube.com/vi/3pEXVe6KJO4/0.jpg
+[failed-type-url]: https://www.youtube.com/live/3pEXVe6KJO4

package/ts/undefined/undefined_type.ts

@@ -3,9 +3,7 @@ import type { IsAny } from '../any/any_type.js'
 /**
  * Check if the type `T` is exactly `undefined`.
  *
- * ```
- * import type { UndefinedType } from 'type-plus'
- *
+ * ```ts
  * type R = UndefinedType<undefined> // undefined
  *
  * type R = UndefinedType<never> // never
@@ -22,9 +20,7 @@ export type UndefinedType<T, Then = T, Else = never> = IsAny<
 /**
  * Is the type `T` exactly `undefined`.
  *
- * ```
- * import type { IsUndefined } from 'type-plus'
- *
+ * ```ts
  * type R = IsUndefined<undefined> // true
  *
  * type R = IsUndefined<never> // false
@@ -37,9 +33,7 @@ export type IsUndefined<T, Then = true, Else = false> = UndefinedType<T, Then, E
 /**
  * Check if the type `T` is not `undefined`.
  *
- * ```
- * import type { NotUndefinedType } from 'type-plus'
- *
+ * ```ts
  * type R = NotUndefinedType<undefined> // never
  *
  * type R = NotUndefinedType<never> // never
@@ -52,9 +46,7 @@ export type NotUndefinedType<T, Then = T, Else = never> = UndefinedType<T, Else,
 /**
  * Is the type `T` not `undefined`.
  *
- * ```
- * import type { IsNotUndefined } from 'type-plus'
- *
+ * ```ts
  * type R = IsNotUndefined<undefined> // false
  *
  * type R = IsNotUndefined<never> // true

package/ts/unknown/unknown_type.ts

@@ -3,9 +3,7 @@ import type { IsAny } from '../any/any_type.js'
 /**
  * Check if the type `T` is exactly `unknown`.
  *
- * ```
- * import type { UnknownType } from 'type-plus'
- *
+ * ```ts
  * type R = UnknownType<unknown> // unknown
  *
  * type R = UnknownType<number> // never
@@ -21,9 +19,7 @@ export type UnknownType<T, Then = T, Else = never> = IsAny<
 /**
  * Is the type `T` exactly `unknown`.
  *
- * ```
- * import type { IsUnknown } from 'type-plus'
- *
+ * ```ts
  * type R = IsUnknown<unknown> // true
  *
  * type R = IsUnknown<number> // false
@@ -35,9 +31,7 @@ export type IsUnknown<T, Then = true, Else = false> = UnknownType<T, Then, Else>
 /**
  * Check if the type `T` is not `unknown`.
  *
- * ```
- * import type { NotUnknownType } from 'type-plus'
- *
+ * ```ts
  * type R = NotUnknownType<unknown> // never
  *
  * type R = NotUnknownType<never> // never
@@ -50,9 +44,7 @@ export type NotUnknownType<T, Then = T, Else = never> = UnknownType<T, Else, The
 /**
  * Is the type `T` not exactly `unknown`.
  *
- * ```
- * import type { IsNotUnknown } from 'type-plus'
- *
+ * ```ts
  * type R = IsNotUnknown<unknown> // false
  *
  * type R = IsNotUnknown<never> // true

package/ts/void/void_type.ts

@@ -5,8 +5,6 @@ import type { IsUndefined } from '../undefined/undefined_type.js'
  * Check if `T` is `void`.
  *
  * ```ts
- * import type { VoidType } from 'type-plus'
- *
  * type R = VoidType<void> // void
  *
  * type R = VoidType<1> // never
@@ -22,8 +20,6 @@ export type VoidType<T, Then = T, Else = never> = IsAnyOrNever<
  * Check if `T` is not `void`.
  *
  * ```ts
- * import type { VoidType } from 'type-plus'
- *
  * type R = VoidType<void> // never
  *
  * type R = VoidType<1> // 1
@@ -35,8 +31,6 @@ export type NotVoidType<T, Then = T, Else = never> = VoidType<T, Else, Then>
  * Is `T` `void`.
  *
  * ```ts
- * import type { IsVoid } from 'type-plus'
- *
  * type R = IsVoid<void> // true
  *
  * type R = IsVoid<1> // false
@@ -48,8 +42,6 @@ export type IsVoid<T, Then = true, Else = false> = VoidType<T, Then, Else>
  * Is `T` not `void`.
  *
  * ```ts
- * import type { IsNotVoid } from 'type-plus'
- *
  * type R = IsNotVoid<void> // false
  *
  * type R = IsNotVoid<1> // true

package/cjs/type/constants.d.ts

@@ -1,5 +0,0 @@
-/**
- * This is a internal symbol to create branded types.
- */
-export declare const uniSym: unique symbol;
-//# sourceMappingURL=constants.d.ts.map

package/cjs/type/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../ts/type/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,MAAM,eAAsB,CAAA"}

package/cjs/type/constants.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uniSym = void 0;
-/**
- * This is a internal symbol to create branded types.
- */
-exports.uniSym = Symbol('type-plus');
-//# sourceMappingURL=constants.js.map

package/cjs/type/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../ts/type/constants.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA"}

package/esm/type/constants.d.ts

@@ -1,5 +0,0 @@
-/**
- * This is a internal symbol to create branded types.
- */
-export declare const uniSym: unique symbol;
-//# sourceMappingURL=constants.d.ts.map

package/esm/type/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../ts/type/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,MAAM,eAAsB,CAAA"}

package/esm/type/constants.js

@@ -1,5 +0,0 @@
-/**
- * This is a internal symbol to create branded types.
- */
-export const uniSym = Symbol('type-plus');
-//# sourceMappingURL=constants.js.map

package/esm/type/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../ts/type/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA"}

package/ts/type/constants.ts

@@ -1,4 +0,0 @@
-/**
- * This is a internal symbol to create branded types.
- */
-export const uniSym = Symbol('type-plus')