@openstax/ts-utils 1.2.9 → 1.3.0

package/dist/esm/types.d.ts

@@ -1,6 +1,27 @@
+/**
+ * Returns the literal type `'yes'` if the first generic tuple array is a prefix of the second,
+ * the `'no'` literal type otherwise. Can be used in conditional types, e.g.
+ *
+ * `type WillBeString = TupleExtends<[1,2], [1,2,3]> extends 'yes' ? string : number;`
+ *
+ * There may be a better way to do this; `T1 extends T2` doesn't work
+ */
 export declare type TupleExtends<T1, T2> = T1 extends [infer T1Head, ...infer T1Tail] ? T2 extends [infer T2Head, ...infer T2Tail] ? T1Head extends T2Head ? TupleExtends<T1Tail, T2Tail> extends 'yes' ? 'yes' : 'no' : 'no' : T2 extends [] ? 'yes' : 'no' : T1 extends [] ? T2 extends [] ? 'yes' : 'no' : 'no';
+/**
+ * If `R` is `Promise<I>`, returns `I`, otherwise returns `R`
+ * @deprecated use TypeScript builtin Awaited instead:
+ * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#the-awaited-type-and-promise-improvements
+ */
 export declare type UnwrapPromise<R> = R extends Promise<infer I> ? I : R;
+/**
+ * turns `thing | thing2` into `thing & thing2`
+ * @see https://stackoverflow.com/a/50375286/14809536
+ */
 export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+/**
+ * make certain fields required
+ * @see https://stackoverflow.com/a/69328045/14809536
+ */
 export declare type WithRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstax/ts-utils",
   "sideEffects": false,
-  "version": "1.2.9",
+  "version": "1.3.0",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {

package/script/bin/copy-from-template.bash

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# spell-checker: ignore pipefail
+# spell-checker: ignore pipefail syncignore lastsync nowarn mktemp
 set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
 
 project_dir=$(pwd)