typeshi 2.2.0 → 2.2.1

package/dist/utils/object.d.ts

@@ -54,8 +54,7 @@ export declare function picked<T extends object, K extends keyof T>(obj: T, keys
  * - `'FIFO'` - remove elements from front (`'First-In-First-Out'`)
  * @note **assumes newest elements were pushed to end** i.e. `stack.push()` or `queue.enque()`
  * @param inPlace `boolean (optional)` `default = true`
- * - `true` - modify and return original array with: `arr.length = maxLength (LIFO)` or `arr.splice() (FIFO)`
- * - - if `'LIFO'`, can use JS trick by setting `arr.length = maxLength`
+ * - `true` - modify and return original array using: `arr.length = maxLength (LIFO)` or `arr.splice() (FIFO)`
  * - `false` - return new array with: `arr.slice()` `arr.slice(0, maxLength) (LIFO) or arr.slice(i, n) (FIFO)` where `n - i === maxLength`
  * @returns **`arr`** `T[]` where `arr.length <= maxLength`
  */

package/dist/utils/object.js

@@ -90,8 +90,7 @@ function picked(obj, keys) {
  * - `'FIFO'` - remove elements from front (`'First-In-First-Out'`)
  * @note **assumes newest elements were pushed to end** i.e. `stack.push()` or `queue.enque()`
  * @param inPlace `boolean (optional)` `default = true`
- * - `true` - modify and return original array with: `arr.length = maxLength (LIFO)` or `arr.splice() (FIFO)`
- * - - if `'LIFO'`, can use JS trick by setting `arr.length = maxLength`
+ * - `true` - modify and return original array using: `arr.length = maxLength (LIFO)` or `arr.splice() (FIFO)`
  * - `false` - return new array with: `arr.slice()` `arr.slice(0, maxLength) (LIFO) or arr.slice(i, n) (FIFO)` where `n - i === maxLength`
  * @returns **`arr`** `T[]` where `arr.length <= maxLength`
  */
@@ -116,7 +115,7 @@ function enforceMaxLength(arr, maxLength, principle = 'LIFO', inPlace = true) {
         if (principle === 'LIFO') {
             arr.length = maxLength;
         }
-        else {
+        else { // 'FIFO'
             arr.splice(0, excess);
         }
         return arr;
@@ -125,7 +124,7 @@ function enforceMaxLength(arr, maxLength, principle = 'LIFO', inPlace = true) {
         if (principle === 'LIFO') {
             return arr.slice(0, maxLength);
         }
-        else {
+        else { // 'FIFO'
             return arr.slice(excess);
         }
     }

package/dist/utils/typeValidation.d.ts

@@ -261,7 +261,12 @@ export type PrimitiveKeys<T, Required extends boolean = false> = {
 export type Primitive = string | number | boolean | null | undefined;
 /** Get the union of all values of `T` (like `valueof T`) */
 export type ValueOf<T> = T[keyof T];
-/** Keys of `T` whose values extend a given type `U` */
-export type KeysOfType<T, U> = {
-    [K in keyof T]: T[K] extends U ? K : never;
+/**
+ * Keys of `T` whose values extend a given type `U`
+ * @template T - The object type
+ * @template U - The type to check each `T[K]` against
+ * @template Required - Whether the key is required (allows for `undefined` values if `false`) `default = false`
+ */
+export type KeysOfType<T, U, Required extends boolean = false> = {
+    [K in keyof T]: Required extends true ? (T[K] extends U ? K : never) : (T[K] extends U | undefined ? K : never);
 }[keyof T][];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",