inferred-types 0.20.0 → 0.22.5

package/src/index.ts

@@ -1,8 +1,8 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 3f75741a
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 5ddbbf55
 
 // directory exports
 export * from "./Mutation/index";
@@ -10,30 +10,7 @@ export * from "./shared/index";
 export * from "./types/index";
 export * from "./utility/index";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/shared/index.ts

@@ -1,38 +1,15 @@
 // #autoindex: orphan
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 58ead14b
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 3305143b
 
 // file exports
 export * from "./randomString";
 export * from "./uuid";
 export * from "./valueTypes";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/shared/valueTypes.ts

@@ -1,4 +1,4 @@
-import { Narrowable } from "~/types/Narrowable";
+import { Narrowable } from "src/types/Narrowable";
 
 export type ValueTuple = [type: any, narrowable: boolean];
 

package/src/types/ExpandRecursively.ts

@@ -1,3 +1,12 @@
+
+/**
+ * Recursively goes over an object based structure and tries to reduce
+ * it down to just a simple key/value type.
+ */
 export type ExpandRecursively<T> = T extends object
-  ? { [K in keyof T]: ExpandRecursively<T[K]> }
+  ? T extends (...args: any[]) => any
+    // Functions should be treated like any other non-object value
+    // but will/can identify as an object in JS
+    ? T
+    : { [K in keyof T]: ExpandRecursively<T[K]> }
   : T;

package/src/types/Keys.ts

@@ -1,10 +1,10 @@
-/** 
+/**
  * A Utility class that provides the same functionality as the built-in
  * `keyof` TS operator but can also:
- * 
+ *
  * - receive an array of strings and convert that into a union type.
  * - you can exclude literal string from the returned result
- * 
+ *
  * ```ts
  * const t1 = { foo: 1, bar: 2 };
  * // "foo" | "bar"
@@ -17,6 +17,10 @@
 export type Keys<
   T extends Record<string, any> | readonly string[],
   W extends string | undefined = undefined
-  > = T extends readonly string[]
-  ? W extends string ? Exclude<T[number], W> : T[number]
-  : W extends string ? Exclude<keyof T & string, W> : keyof T & string;
+> = T extends readonly string[]
+  ? W extends string
+    ? Exclude<T[number], W>
+    : T[number]
+  : W extends string
+  ? Exclude<keyof T & string, W>
+  : keyof T & string;

package/src/types/SimplifyObject.ts

@@ -0,0 +1,12 @@
+import { ExpandRecursively } from "./ExpandRecursively";
+import { UnionToIntersection } from "./type-conversion/UnionToIntersection";
+
+/**
+ * Often when mutating the shape of an object you will end up with the union of a number of
+ * `Record<string, x>` and `Record<string, y>` which is messy to look at and take away meaning.
+ *
+ * This type utility will cleanup an object and return a simple dictionary definition for it.
+ */
+export type SimplifyObject<T extends {}> = ExpandRecursively<
+  UnionToIntersection<ExpandRecursively<T>>
+>;

package/src/types/Transformer.ts

@@ -1,4 +1,4 @@
-import { SameKeys } from "./type-conversion/SameKeys";
+import { SameKeys } from "./dictionary/SameKeys";
 
 /**
  * **Transformer**

package/src/types/alphabetic/CamelCase.ts

@@ -1,3 +1,3 @@
-import { PascalCase } from "~/types/alphabetic";
+import { PascalCase } from "./PascalCase";
 
-export type CamelCase<S extends string> = Uncapitalize<PascalCase<S>>;
+export type CamelCase<S extends string> = string extends S ? string : Uncapitalize<PascalCase<S>>;

package/src/types/alphabetic/CapFirstAlpha.ts

@@ -1,9 +1,14 @@
-import type { NonAlpha, Replace } from "~/types";
+import { Replace } from "../string-literals";
+import { NonAlpha } from "./alpha-characters";
 
 /**
  * Strips the non-alpha characters that lead a string
  */
-export type StripLeftNonAlpha<S extends string> = S extends `${infer First}${infer Rest}` ? First extends NonAlpha ? StripLeftNonAlpha<Rest> : S : never;
+export type StripLeftNonAlpha<S extends string> = S extends `${infer First}${infer Rest}`
+  ? First extends NonAlpha
+    ? StripLeftNonAlpha<Rest>
+    : S
+  : never;
 
 /**
  * identifies the leading characters which are _not_ alphabetical
@@ -16,4 +21,3 @@ export type LeadingNonAlpha<S extends string> = Replace<S, StripLeftNonAlpha<S>,
 export type CapFirstAlpha<T extends string> = LeadingNonAlpha<T> extends string
   ? `${LeadingNonAlpha<T>}${Capitalize<Replace<T, LeadingNonAlpha<T>, "">>}`
   : Capitalize<T>;
-

package/src/types/alphabetic/Dasherize.ts

@@ -1,10 +1,12 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { DashUppercase, LowerAllCaps } from "~/types";
+
 import { Trim } from "../string-literals";
+import { DashUppercase } from "./DashUppercase";
+import { LowerAllCaps } from "./LowerAllCaps";
 
 /**
- * Converts a string literal into a _dasherized_ format while ignoring _exterior_ whitepace.
- * 
+ * Converts a string literal into a _dasherized_ format while ignoring _exterior_ whitespace.
+ *
  * ```ts
  * // "foo-bar"
  * type Dash = Dasherize<"foo_bar">;
@@ -14,7 +16,8 @@ import { Trim } from "../string-literals";
  * type Dash = Dasherize<"\n  foo bar \t">;
  * ```
  */
-export type Dasherize<S extends string> = string extends S ? string :
-  DashUppercase<Trim<LowerAllCaps<S>>> extends `${infer Begin}${"_" | " "}${infer Rest}`
+export type Dasherize<S extends string> = string extends S
+  ? string
+  : DashUppercase<Trim<LowerAllCaps<S>>> extends `${infer Begin}${"_" | " "}${infer Rest}`
   ? Dasherize<`${Lowercase<Begin>}-${Rest}`>
   : Lowercase<DashUppercase<Uncapitalize<Trim<LowerAllCaps<S>>>>>;

package/src/types/alphabetic/KebabCase.ts

@@ -1,4 +1,4 @@
-import type { Dasherize } from "~/types/alphabetic";
+import { Dasherize } from "./Dasherize";
 
 /**
  * **KebabCase<T>** is an _alias_ for **Dasherize<T>**.

package/src/types/alphabetic/PascalCase.ts

@@ -1,5 +1,7 @@
 /* eslint @typescript-eslint/no-unused-vars: "off" */
-import type { LowerAllCaps, Trim } from "~/types";
+
+import { Trim } from "../string-literals";
+import { LowerAllCaps } from "./LowerAllCaps";
 
 type Delimiter = "_" | "-" | " ";
 

package/src/types/alphabetic/SnakeCase.ts

@@ -1,6 +1,8 @@
 /* eslint @typescript-eslint/no-unused-vars: "off" */
 
-import type { DashUppercase, LowerAllCaps, Trim } from "~/types";
+import { Trim } from "../string-literals";
+import { DashUppercase } from "./DashUppercase";
+import { LowerAllCaps } from "./LowerAllCaps";
 
 /** convert space to dash */
 type SpaceToDash<T extends string> = T extends `${infer Begin}${" "}${infer Rest}`
@@ -16,7 +18,10 @@ type SpaceToDash<T extends string> = T extends `${infer Begin}${" "}${infer Rest
  * type T = SnakeCase<"foo-bar">;
  * type T = SnakeCase<"\n foo bar \t">;
  * ``` */
-export type SnakeCase<S extends string> = string extends S ? string :
-  DashUppercase<Uncapitalize<SpaceToDash<Trim<LowerAllCaps<S>>>>> extends `${infer Begin}${"-"}${infer Rest}`
+export type SnakeCase<S extends string> = string extends S
+  ? string
+  : DashUppercase<
+      Uncapitalize<SpaceToDash<Trim<LowerAllCaps<S>>>>
+    > extends `${infer Begin}${"-"}${infer Rest}`
   ? SnakeCase<`${Lowercase<Begin>}_${Rest}`>
   : Lowercase<DashUppercase<Uncapitalize<Trim<LowerAllCaps<S>>>>>;

package/src/types/alphabetic/alpha-characters.ts

@@ -1,4 +1,30 @@
-export type LowerAlpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+export type LowerAlpha =
+  | "a"
+  | "b"
+  | "c"
+  | "d"
+  | "e"
+  | "f"
+  | "g"
+  | "h"
+  | "i"
+  | "j"
+  | "k"
+  | "l"
+  | "m"
+  | "n"
+  | "o"
+  | "p"
+  | "q"
+  | "r"
+  | "s"
+  | "t"
+  | "u"
+  | "v"
+  | "w"
+  | "x"
+  | "y"
+  | "z";
 
 /** Uppercase alphabetic character */
 export type UpperAlpha = Uppercase<LowerAlpha>;
@@ -8,7 +34,6 @@ export type UpperAlpha = Uppercase<LowerAlpha>;
  */
 export type Alpha = UpperAlpha | LowerAlpha;
 
-
 export type Whitespace = " " | "\n" | "\t";
 
 export type Punctuation = "." | "," | ";" | "!" | "?";
@@ -17,18 +42,18 @@ export type Punctuation = "." | "," | ";" | "!" | "?";
  */
 export type StringDelimiter = "_" | "-" | "/" | "\\";
 
-export type OpenningBracket = "(" | "[" | "{";
+export type OpeningBracket = "(" | "[" | "{";
 export type ClosingBracket = ")" | "]" | "}";
 
 /**
- * Openning and closing parenthesis
+ * Opening and closing parenthesis
  */
 export type Parenthesis = "(" | ")";
 
 /**
- * Openning and closing brackets
+ * Opening and closing brackets
  */
-export type Bracket = OpenningBracket | ClosingBracket;
+export type Bracket = OpeningBracket | ClosingBracket;
 
 /**
  * Numeric string characters
@@ -40,10 +65,9 @@ export type NumericString = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8"
  */
 export type AlphaNumeric = Alpha | NumericString;
 
-
 export type SpecialCharacters = "@" | "~" | "^" | "#" | "&" | "*";
 
 /**
- * Non-alphabetic characters including whitespace, string numerals, and 
+ * Non-alphabetic characters including whitespace, string numerals, and
  */
-export type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;
+export type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;

package/src/types/alphabetic/index.ts

@@ -1,7 +1,7 @@
 // #autoindex, exclude: Alpha
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: fcf9c4b
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: b32382ed
 
 // file exports
 export * from "./AllCaps";
@@ -19,30 +19,7 @@ export * from "./Pluralize";
 export * from "./SnakeCase";
 export * from "./alpha-characters";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/dictionary/DictChangeValue.ts

@@ -0,0 +1,26 @@
+import { SimplifyObject } from "../SimplifyObject";
+
+/**
+ * Allow a dictionary have it's value's type changed to `T` while maintaining the keys in
+ * the original object `I` so long as the original value for the KV pair extends `V`.
+ *
+ * If `V` is not specified then it defaults to _any_ and therefore all KVs are preserved.
+ */
+export type DictChangeValue<
+  /** the object who's value-type we're changing */
+  I extends Record<string, any>,
+  /** the return type that functions should be modified to have */
+  T extends any,
+  /**
+   *The type we expect in the value; if the value extends type `V` then the value will
+   * be converted to type `O`; if not then the KV pair will be discarded
+   */
+  V extends any = any
+> = SimplifyObject<
+  {
+    [K in keyof I]: I[K] extends V
+      ? // it's a function (or at least the scoped down type of function we're looking for)
+        Record<K, T>
+      : never;
+  }[keyof I]
+>;

package/src/types/dictionary/DictPartialApplication.ts

@@ -0,0 +1,30 @@
+import { SimplifyObject } from "../SimplifyObject";
+
+/**
+ * Given a dictionary of key/values, where the value is a function, this
+ * type utility will maintain the keys but change the values to whatever
+ * the `ReturnType` of the function was.
+ * ```ts
+ * const api = {
+ *    val: 42,
+ *    hi: (name: string) => `hi ${name}`,
+ *    bye: (name: string) => `bye ${name}`
+ * };
+ * // { hi: string; bye: string }
+ * type Test = UnwrapValue<typeof api>
+ * // { val: number; foo: string; bar: string }
+ * type Test2 = UnwrapValue<typeof api, false>
+ * ```
+ */
+export type DictPartialApplication<
+  T extends Record<string, any>,
+  I extends boolean = true
+> = SimplifyObject<
+  {
+    [K in keyof T]: T[K] extends (...args: any[]) => any
+      ? Record<K, ReturnType<T[K]>>
+      : true extends I
+      ? never
+      : Record<K, T[K]>;
+  }[keyof T]
+>;

package/src/types/dictionary/DictPrependWithFn.ts

@@ -0,0 +1,23 @@
+import { SimplifyObject } from "../SimplifyObject";
+
+/**
+ * **DictPrependWithFn**
+ *
+ * Given a strongly typed object `<T>`, this utility will inject a function call with
+ * arguments `<A>` and then return what had subsequently been the value of the property.
+ * 
+ * Should you only want to apply this treatment to _some_ of the properties you can
+ * pass in a value `<E>` which will ensure that only properties which _extend_ `E` will be
+ * modified.
+ */
+export type DictPrependWithFn<
+  T extends Record<string, any>,
+  A extends any[],
+  E extends any = any
+> = SimplifyObject<
+  {
+    [K in keyof T]: T[K] extends E 
+      ? Record<K, (...args: A) => T[K]>
+      : Record<K, T[K]>;
+  }[keyof T]
+>;

package/src/types/dictionary/DictReturnValues.ts

@@ -0,0 +1,27 @@
+import { SimplifyObject } from "../SimplifyObject";
+
+/**
+ * **DictReturnValues**
+ *
+ * A type utility which receives an object `<T>` and then modifies
+ * the return type of any properties which are a function to have this
+ * new **ReturnType** `<R>`. Optionally you can specify a particular return type which
+ * you are targeting and then
+ */
+export type DictReturnValues<
+  /** the object which we expect to have props with function values */
+  T extends Record<string, any>,
+  /** the return type that functions should be modified to have */
+  R extends any,
+  /** optionally this utility can target only functions with a certain existing return value */
+  O extends (...args: any[]) => any = (...args: any[]) => any
+> = SimplifyObject<
+  {
+    [K in keyof T]: T[K] extends O
+      ? // it's a function (or at least the scoped down type of function we're looking for)
+        T[K] extends (...args: infer A) => any
+        ? Record<K, (...args: A) => R>
+        : Record<K, T[K]>
+      : Record<K, T[K]>;
+  }[keyof T]
+>;

package/src/types/dictionary/MutableProps.ts

@@ -0,0 +1,19 @@
+import { ExpandRecursively } from "../ExpandRecursively";
+import { Keys } from "../Keys";
+import { Mutable } from "../Mutable";
+
+/**
+ * Given a dictionary of type `<T>`, this utility function will
+ * make the `<M>` generic property _mutable_ and all other _read-only_.
+ *
+ * ```ts
+ * // { foo: string, bar?: Readonly<number> }
+ * type Example = MutableProps<{
+ *    foo: Readonly<string>,
+ *    bar?: number
+ * }, "foo">;
+ * ```
+ */
+export type MutableProps<T extends {}, M extends keyof T & string> = ExpandRecursively<
+  Mutable<Pick<T, M>> & Readonly<Pick<T, Keys<T, M>>>
+>;

package/src/types/dictionary/RequireProps.ts

@@ -0,0 +1,15 @@
+import { ExpandRecursively } from "../ExpandRecursively";
+
+/**
+ * Given a dictionary of type `<T>`, this utility function will
+ * make the `<R>` generic property _required_ (use a union to make
+ * more than one prop required).
+ *
+ * ```ts
+ * // { foo: string, bar?: number }
+ * type Example = RequireProps<{foo?: string, bar?: number}, "foo">;
+ * ```
+ */
+export type RequireProps<T extends {}, R extends keyof T> = ExpandRecursively<
+  Required<Pick<T, R>> & T
+>;

package/src/types/dictionary/index.ts

@@ -1,36 +1,19 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 6th Jun, 2022, 03:36 AM ( GMT-7 )
-// hash-code: 1f3a5076
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 55881f7d
 
 // file exports
+export * from "./DictPartialApplication";
+export * from "./DictPrependWithFn";
+export * from "./DictReturnValues";
 export * from "./Get";
-export * from "./NotEmptyObject";
+export * from "./MutableProps";
+export * from "./RequireProps";
+export * from "./SameKeys";
+export * from "./props";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/{props.ts → dictionary/props.ts}

@@ -1,4 +1,4 @@
-import { Alpha } from "common-types";
+import { Alpha } from "../alphabetic/alpha-characters";
 
 /**
  * Extracts the _required_ keys in the object's type
@@ -18,7 +18,7 @@ export type OptionalKeys<T extends object> = {
  * The _keys_ on a given object `T` which have a literal value of `W`.
  *
  * Optionally, you may provide a generic `E` to exclude certain keys in
- * resultset.
+ * result set.
  * ```ts
  * // "foo"
  * type Str = KeysWithValue<{ foo: "hi"; bar: 5 }>;

package/src/types/fluent/index.ts

@@ -1,35 +1,12 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: c5fbce38
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 9dbff34
 
 // file exports
 export * from "./fluent";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/functions/FinalReturn.ts

@@ -0,0 +1,12 @@
+/**
+ * A type utility which looks at a chain for functions and reduces the type
+ * to the final `ReturnType` of the chain.
+ * 
+ * ```ts
+ * // number
+ * type T = FinalReturn<() => (foo: string) => (bar: string) => () => number>;
+ * ```
+ */
+export type FinalReturn<T extends any> = T extends (...args: any[]) => any
+  ? FinalReturn<ReturnType<T>>
+  : T;