type-plus 6.4.0 → 6.6.0

package/ts/string/strict_string_type.ts

@@ -3,26 +3,26 @@ import type { IsAny } from '../any/any_type.js'
 /**
  * Check if the type `T` is exactly `string`.
  *
- * ```
- * import type { StrictStringType } from 'type-plus'
- *
+ * ```ts
  * type R = StrictStringType<string> // string
-*
-* type R = StrictStringType<''> // never
-* type R = StrictStringType<'1'> // never
-* type R = StrictStringType<string | boolean> // never
-* type R = StrictStringType<never> // never
-* type R = StrictStringType<unknown> // never
+ *
+ * type R = StrictStringType<''> // never
+ * type R = StrictStringType<'1'> // never
+ * type R = StrictStringType<string | boolean> // never
+ * type R = StrictStringType<never> // never
+ * type R = StrictStringType<unknown> // never
  * ```
  */
-export type StrictStringType<T, Then = T, Else = never> = IsAny<T, Else, [T, string] extends [string, T] ? Then : Else>
+export type StrictStringType<T, Then = T, Else = never> = IsAny<
+	T,
+	Else,
+	[T, string] extends [string, T] ? Then : Else
+>
 
 /**
  * Is the type `T` exactly `string`.
  *
- * ```
- * import type { IsStrictString } from 'type-plus'
- *
+ * ```ts
  * type R = IsStrictString<string> // true
  *
  * type R = IsStrictString<''> // false
@@ -37,9 +37,7 @@ export type IsStrictString<T, Then = true, Else = false> = StrictStringType<T, T
 /**
  * Check if the type `T` is not exactly `string`.
  *
- * ```
- * import type { NotStrictStringType } from 'type-plus'
- *
+ * ```ts
  * type R = NotStrictStringType<string> // never
  *
  * type R = NotStrictStringType<''> // ''
@@ -54,9 +52,7 @@ export type NotStrictStringType<T, Then = T, Else = never> = StrictStringType<T,
 /**
  * Is the type `T` not exactly `string`.
  *
- * ```
- * import type { IsNotStrictString } from 'type-plus'
- *
+ * ```ts
  * type R = IsNotStrictString<string> // false
  *
  * type R = IsNotStrictString<''> // true

package/ts/string/string.ts

@@ -0,0 +1,36 @@
+/**
+ * Check if `Subject` includes `Search`.
+ * If either of them is not a string, returns `Else`.
+ *
+ * ```ts
+ * type R = StringIncludes<'abc', 'a'> // true
+ *
+ * type R = StringIncludes<'abc', 'd'> // false
+ * ```
+ */
+export type StringIncludes<
+	Subject extends string,
+	Search extends string,
+	Then = true,
+	Else = false
+> = Subject extends `${infer _}${Search}${infer _}` ? Then : Else
+
+/**
+ * Split a string into substrings using the specified separator,
+ * and return them as an array.
+ *
+ * ```ts
+ * type R = StringSplit<'abc', ''> // ['a', 'b', 'c']
+ * type R = StringSplit<'abc', 'a'> // ['', 'bc']
+ * type R = StringSplit<'abc', 'b'> // ['a', 'c']
+ * type R = StringSplit<'abc', 'c'> // ['ab', '']
+ * ```
+ */
+export type StringSplit<
+	Subject extends string,
+	Seperator extends string
+> = Subject extends `${infer A}${Seperator}${infer B}`
+	? [A, ...StringSplit<B, Seperator>]
+	: Seperator extends ''
+	? []
+	: [Subject]

package/ts/string/string_plus.ts

@@ -0,0 +1,33 @@
+import type { StringIncludes, StringSplit } from './string.js'
+
+export namespace StringPlus {
+	/**
+	 * Check if `Subject` includes `Search`.
+	 * If either of them is not a string, returns `Else`.
+	 *
+	 * ```ts
+	 * type R = StringPlus.Includes<'abc', 'a'> // true
+	 *
+	 * type R = StringPlus.Includes<'abc', 'd'> // false
+	 * ```
+	 */
+	export type Includes<
+		Subject extends string,
+		Search extends string,
+		Then = true,
+		Else = false
+	> = StringIncludes<Subject, Search, Then, Else>
+
+	/**
+	 * Split a string into substrings using the specified separator,
+	 * and return them as an array.
+	 *
+	 * ```ts
+	 * type R = StringPlus.Split<'abc', ''> // ['a', 'b', 'c']
+	 * type R = StringPlus.Split<'abc', 'a'> // ['', 'bc']
+	 * type R = StringPlus.Split<'abc', 'b'> // ['a', 'c']
+	 * type R = StringPlus.Split<'abc', 'c'> // ['ab', '']
+	 * ```
+	 */
+	export type Split<Subject extends string, Seperator extends string> = StringSplit<Subject, Seperator>
+}

package/ts/string/string_type.ts

@@ -3,9 +3,7 @@ import type { IsAnyOrNever } from '../any/any_or_never.js'
 /**
  * Check if the type `T` is `string` or string literals.
  *
- * ```
- * import type { StringType } from 'type-plus'
- *
+ * ```ts
  * type R = StringType<string> // string
  * type R = StringType<''> // ''
  * type R = StringType<'1'> // '1'
@@ -20,9 +18,7 @@ export type StringType<T, Then = T, Else = never> = IsAnyOrNever<T, Else, [T] ex
 /**
  * Is the type `T` `string` or string literals.
  *
- * ```
- * import type { IsString } from 'type-plus'
- *
+ * ```ts
  * type R = IsString<string> // true
  * type R = IsString<''> // true
  * type R = IsString<'a'> // true
@@ -37,9 +33,7 @@ export type IsString<T, Then = true, Else = false> = StringType<T, Then, Else>
 /**
  * Check if the type `T` is not `string` nor string literals.
  *
- * ```
- * import type { NotStringType } from 'type-plus'
- *
+ * ```ts
  * type R = NotStringType<string> // never
  * type R = NotStringType<''> // ''
  * type R = NotStringType<'a'> // 'a'
@@ -54,9 +48,7 @@ export type NotStringType<T, Then = T, Else = never> = StringType<T, Else, Then>
 /**
  * Is the type `T` not `string` nor string literals.
  *
- * ```
- * import type { IsNotString } from 'type-plus'
- *
+ * ```ts
  * type R = IsNotString<string> // false
  * type R = IsNotString<''> // false
  * type R = IsNotString<'a'> // false

package/ts/symbol/symbol_type.ts

@@ -3,9 +3,7 @@ import type { IsAnyOrNever } from '../any/any_or_never.js'
 /**
  * Check if the type `T` is exactly `symbol`.
  *
- * ```
- * import type { SymbolType } from 'type-plus'
- *
+ * ```ts
  * type R = SymbolType<symbol> // symbol
  *
  * type R = SymbolType<never> // never
@@ -13,18 +11,12 @@ import type { IsAnyOrNever } from '../any/any_or_never.js'
  * type R = SymbolType<symbol | boolean> // never
  * ```
  */
-export type SymbolType<T, Then = T, Else = never> = IsAnyOrNever<
-	T,
-	Else,
-	[T] extends [symbol] ? Then : Else
->
+export type SymbolType<T, Then = T, Else = never> = IsAnyOrNever<T, Else, [T] extends [symbol] ? Then : Else>
 
 /**
  * Is the type `T` exactly `symbol`.
  *
- * ```
- * import type { IsSymbol } from 'type-plus'
- *
+ * ```ts
  * type R = IsSymbol<symbol> // true
  *
  * type R = IsSymbol<never> // false
@@ -37,9 +29,7 @@ export type IsSymbol<T, Then = true, Else = false> = SymbolType<T, Then, Else>
 /**
  * Check if the type `T` is not `symbol`.
  *
- * ```
- * import type { NotSymbolType } from 'type-plus'
- *
+ * ```ts
  * type R = NotSymbolType<symbol> // never
  *
  * type R = NotSymbolType<never> // never
@@ -52,9 +42,7 @@ export type NotSymbolType<T, Then = T, Else = never> = SymbolType<T, Else, Then>
 /**
  * Is the type `T` not `symbol`.
  *
- * ```
- * import type { IsNotSymbol } from 'type-plus'
- *
+ * ```ts
  * type R = IsNotSymbol<symbol> // false
  *
  * type R = IsNotSymbol<never> // true

package/ts/tuple/tuple_type.ts

@@ -4,8 +4,6 @@ import type { IsNever } from '../never/never_type.js'
  * Check if `T` is a tuple and not an array.
  *
  * ```ts
- * import type { TupleType } from 'type-plus'
- *
  * type R = TupleType<[]>       // []
  * type R = TupleType<[1]>      // [1]
  *
@@ -25,8 +23,6 @@ export type TupleType<T, Then = T, Else = never> = IsNever<
  * Check if `T` is not a tuple.
  *
  * ```ts
- * import type { NotTupleType } from 'type-plus'
- *
  * type R = NotTupleType<[]>       // never
  * type R = NotTupleType<[1]>      // never
  *
@@ -42,8 +38,6 @@ export type NotTupleType<T, Then = T, Else = never> = TupleType<T, Else, Then>
  * Is `T` a tuple and not an array.
  *
  * ```ts
- * import type { IsTuple } from 'type-plus'
- *
  * type R = IsTuple<[]>       // true
  *
  * type R = IsTuple<number[]> // false
@@ -58,8 +52,6 @@ export type IsTuple<T, Then = true, Else = false> = TupleType<T, Then, Else>
  * Is `T` not a tuple.
  *
  * ```ts
- * import type { IsNotTuple } from 'type-plus'
- *
  * type R = IsNotTuple<[]>       // false
  * type R = IsNotTuple<[1]>      // false
  *

package/ts/type/failed.ts

@@ -0,0 +1,32 @@
+declare const uniSym: unique symbol
+
+/**
+ * A failed type with message.
+ *
+ * This is analogous to the `Error` class in JavaScript.
+ *
+ * It can be used in type-level programming to failed an error message.
+ *
+ * If you want to add additional type information,
+ * use `FailedT` or create your own failed type instead.
+ *
+ * ```ts
+ * type T = Failed<'error message'>
+ * ```
+ */
+export interface Failed<Msg extends string> {
+	[uniSym]: Msg
+}
+
+/**
+ * A failed type with message and one additional type.
+ *
+ * Use this to add a generic type to the failed type.
+ *
+ * e.g. `FailedT<'missing', number | string>`
+ *
+ * It's recommended to create custom failed types instead of using this to provide better message.
+ */
+export interface FailedT<Msg extends string, T> {
+	[uniSym]: Msg
+}

package/ts/type/readme.md

@@ -0,0 +1,22 @@
+# 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]
+
+[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/nominal/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../ts/nominal/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,eAAiB,CAAA;AACrC,eAAO,MAAM,QAAQ,eAAkB,CAAA"}

package/cjs/nominal/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../ts/nominal/types.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;AACxB,QAAA,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA"}

package/cjs/union_to_intersection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"union_to_intersection.d.ts","sourceRoot":"","sources":["../ts/union_to_intersection.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GACvG,CAAC,GACD,KAAK,CAAA;AAER,wBAAgB,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAElE"}

package/cjs/union_to_intersection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"union_to_intersection.js","sourceRoot":"","sources":["../ts/union_to_intersection.ts"],"names":[],"mappings":";;;AAMA,SAAgB,cAAc,CAAI,KAAQ;IACzC,OAAO,KAAsC,CAAA;AAC9C,CAAC;AAFD,wCAEC"}

package/esm/nominal/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../ts/nominal/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,eAAiB,CAAA;AACrC,eAAO,MAAM,QAAQ,eAAkB,CAAA"}

package/esm/nominal/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../ts/nominal/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;AACrC,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA"}

package/esm/union_to_intersection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"union_to_intersection.d.ts","sourceRoot":"","sources":["../ts/union_to_intersection.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GACvG,CAAC,GACD,KAAK,CAAA;AAER,wBAAgB,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAElE"}

package/esm/union_to_intersection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"union_to_intersection.js","sourceRoot":"","sources":["../ts/union_to_intersection.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,cAAc,CAAI,KAAQ;IACzC,OAAO,KAAsC,CAAA;AAC9C,CAAC"}