inferred-types 0.32.1 → 0.33.0

package/dist/index.d.ts

@@ -365,7 +365,7 @@ declare type SimplifyObject<T extends {}> = ExpandRecursively<UnionToIntersectio
  *
  * Boolean type utility returns `true` if `T` is undefined; `false` otherwise
  */
-declare type IsUndefined<T> = T extends undefined ? true : false;
+declare type IsUndefined<T extends Narrowable> = T extends undefined ? true : false;
 /**
  * **IfUndefined**
  *
@@ -638,7 +638,7 @@ declare function isNull<T extends Narrowable>(i: T): T extends null ? true : fal
  * @param ifVal the value (strongly typed) returned if val is `null`
  * @param elseVal the value (strongly typed) returned if val is NOT `null`
  */
-declare function ifNull<T extends Narrowable, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE): IsNull<T> extends true ? IF : ELSE;
+declare function ifNull<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(val: T, ifVal: IF, elseVal: ELSE): IsNull<T> extends true ? IF : ELSE;
 
 declare type IsNumber<T> = T extends number ? true : false;
 declare function isNumber<T>(i: T): T extends number ? true : false;
@@ -677,7 +677,7 @@ declare function isString<T>(i: T): IsString<T>;
  * @param ifVal the value (strongly typed) returned if val is _string_
  * @param elseVal the value (strongly typed) returned if val is NOT a _string
  */
-declare function ifString<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE): IsString<T> extends true ? IF : ELSE;
+declare function ifString<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(val: T, ifVal: IF, elseVal: ELSE): IsString<T> extends true ? IF : ELSE;
 
 declare function isSymbol<T>(i: T): T extends symbol ? true : false;
 
@@ -712,7 +712,19 @@ declare function isTrue<T extends Narrowable>(i: T): IsTrue<T>;
  */
 declare function ifTrue<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE): IsTrue<T> extends true ? IF : ELSE;
 
-declare function isUndefined<T>(i: T): undefined extends T ? true : false;
+declare function isUndefined<T extends Narrowable>(i: T): undefined extends T ? true : false;
+/**
+ * **ifUndefined**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * _undefined_ and returns one of two values (strongly typed) based on the evaluation
+ * of this criteria.
+ *
+ * @param val the value being tested
+ * @param ifVal the value (strongly typed) returned if val is `undefined`
+ * @param elseVal the value (strongly typed) returned if val is NOT `undefined`
+ */
+declare function ifUndefined<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(val: T, ifVal: IF, elseVal: ELSE): IsUndefined<T> extends true ? IF : ELSE;
 
 declare type Type<T extends any, V extends Function> = {
     name: string;
@@ -2371,4 +2383,4 @@ interface IFluentConfigurator<C> {
  */
 declare function FluentConfigurator<I>(initial?: I): IFluentConfigurator<{}>;
 
-export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AsArray, AsFinalizedConfig, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, Cardinality, Cardinality0, Cardinality1, CardinalityExplicit, CardinalityFilter0, CardinalityFilter1, CardinalityIn, CardinalityInput, CardinalityNode, CardinalityOut, CardinalityTuple, ClosingBracket, Condition, ConditionFilter, Configurator, ConfiguredMap, Constructor, DEFAULT_MANY_TO_ONE_MAPPING, DEFAULT_ONE_TO_MANY_MAPPING, DEFAULT_ONE_TO_ONE_MAPPING, DashToSnake, DashUppercase, Dasherize, DecomposeMapConfig, DefaultManyToOneMapping, DefaultOneToManyMapping, DefaultOneToOneMapping, DefinePropertiesApi, DictArrApi, DictArray, DictArrayFilterCallback, DictArrayKv, DictChangeValue, DictFromKv, DictKvTuple, DictPartialApplication, DictPrependWithFn, DictReturnValues, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, Extends, ExtendsClause, ExtendsNarrowlyClause, FilterContains, FilterDefn, FilterEnds, FilterEquals, FilterFn, FilterGreaterThan, FilterIs, FilterLessThan, FilterNotEqual, FilterStarts, FinalReturn, FinalizedMapConfig, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfBooleanLiteral, IfExtends, IfExtendsThen, IfLiteral, IfNumericLiteral, IfObject, IfOptionalLiteral, IfScalar, IfStringLiteral, Include, Includes, IntersectingKeys, IsArray, IsBoolean, IsBooleanLiteral, IsCapitalized, IsFalse, IsFunction, IsLiteral, IsNull, IsNumber, IsNumericLiteral, IsObject, IsOptionalLiteral, IsScalar, IsString, IsStringLiteral, IsTrue, KebabCase, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LogicFunction, LogicalCombinator, LowerAllCaps, LowerAlpha, ManyToMany, ManyToOne, ManyToZero, MapCard, MapCardinality, MapCardinalityFrom, MapCardinalityIllustrated, MapConfig, MapFn, MapFnInput, MapFnOutput, MapIR, MapInput, MapInputFrom, MapOR, MapOutput, MapOutputFrom, MapTo, Mapper, MapperApi, MaybeFalse, MaybeTrue, Model, Mutable, MutableProps, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, NotFilter, Numeric, NumericFilter, NumericKeys, NumericString, ObjectType, OneToMany, OneToOne, OneToZero, Opaque, OpeningBracket, OptRequired, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequireProps, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SimplifyObject, SnakeCase, SpecialCharacters, StringDelimiter, StringFilter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefault, TypeDefinition, TypeGuard, TypeOptions, UndefinedArrayIsUnknown, UndefinedTreatment, UndefinedValue, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, Uniqueness, UnwrapNot, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, Widen, WithNumericKeys, WithStringKeys, WithValue, ZeroToMany, ZeroToOne, ZeroToZero, ZipCode, and, api, arrayToKeyLookup, arrayToObject, asArray, condition, createFnWithProps, createMutationFunction, defineProperties, defineType, dictArr, dictToKv, dictionaryTransform, entries, filter, filterDictArray, fnWithProps, groupBy, idLiteral, idTypeGuard, identity, ifBoolean, ifNull, ifNumber, ifString, ifTrue, ifTypeOf, isArray, isBoolean, isFalse, isFunction, isNotFilter, isNull, isNumber, isNumericFilter, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, literal, mapTo, mapToDict, mapToFn, mapValues, nameLiteral, not, or, randomString, readonlyFnWithProps, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, withValue };
+export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AsArray, AsFinalizedConfig, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, Cardinality, Cardinality0, Cardinality1, CardinalityExplicit, CardinalityFilter0, CardinalityFilter1, CardinalityIn, CardinalityInput, CardinalityNode, CardinalityOut, CardinalityTuple, ClosingBracket, Condition, ConditionFilter, Configurator, ConfiguredMap, Constructor, DEFAULT_MANY_TO_ONE_MAPPING, DEFAULT_ONE_TO_MANY_MAPPING, DEFAULT_ONE_TO_ONE_MAPPING, DashToSnake, DashUppercase, Dasherize, DecomposeMapConfig, DefaultManyToOneMapping, DefaultOneToManyMapping, DefaultOneToOneMapping, DefinePropertiesApi, DictArrApi, DictArray, DictArrayFilterCallback, DictArrayKv, DictChangeValue, DictFromKv, DictKvTuple, DictPartialApplication, DictPrependWithFn, DictReturnValues, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, Extends, ExtendsClause, ExtendsNarrowlyClause, FilterContains, FilterDefn, FilterEnds, FilterEquals, FilterFn, FilterGreaterThan, FilterIs, FilterLessThan, FilterNotEqual, FilterStarts, FinalReturn, FinalizedMapConfig, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfBooleanLiteral, IfExtends, IfExtendsThen, IfLiteral, IfNumericLiteral, IfObject, IfOptionalLiteral, IfScalar, IfStringLiteral, Include, Includes, IntersectingKeys, IsArray, IsBoolean, IsBooleanLiteral, IsCapitalized, IsFalse, IsFunction, IsLiteral, IsNull, IsNumber, IsNumericLiteral, IsObject, IsOptionalLiteral, IsScalar, IsString, IsStringLiteral, IsTrue, KebabCase, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LogicFunction, LogicalCombinator, LowerAllCaps, LowerAlpha, ManyToMany, ManyToOne, ManyToZero, MapCard, MapCardinality, MapCardinalityFrom, MapCardinalityIllustrated, MapConfig, MapFn, MapFnInput, MapFnOutput, MapIR, MapInput, MapInputFrom, MapOR, MapOutput, MapOutputFrom, MapTo, Mapper, MapperApi, MaybeFalse, MaybeTrue, Model, Mutable, MutableProps, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, NotFilter, Numeric, NumericFilter, NumericKeys, NumericString, ObjectType, OneToMany, OneToOne, OneToZero, Opaque, OpeningBracket, OptRequired, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequireProps, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SimplifyObject, SnakeCase, SpecialCharacters, StringDelimiter, StringFilter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefault, TypeDefinition, TypeGuard, TypeOptions, UndefinedArrayIsUnknown, UndefinedTreatment, UndefinedValue, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, Uniqueness, UnwrapNot, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, Widen, WithNumericKeys, WithStringKeys, WithValue, ZeroToMany, ZeroToOne, ZeroToZero, ZipCode, and, api, arrayToKeyLookup, arrayToObject, asArray, condition, createFnWithProps, createMutationFunction, defineProperties, defineType, dictArr, dictToKv, dictionaryTransform, entries, filter, filterDictArray, fnWithProps, groupBy, idLiteral, idTypeGuard, identity, ifBoolean, ifNull, ifNumber, ifString, ifTrue, ifTypeOf, ifUndefined, isArray, isBoolean, isFalse, isFunction, isNotFilter, isNull, isNumber, isNumericFilter, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, literal, mapTo, mapToDict, mapToFn, mapValues, nameLiteral, not, or, randomString, readonlyFnWithProps, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, withValue };

package/dist/index.js

@@ -56,6 +56,7 @@ __export(src_exports, {
   ifString: () => ifString,
   ifTrue: () => ifTrue,
   ifTypeOf: () => ifTypeOf,
+  ifUndefined: () => ifUndefined,
   isArray: () => isArray,
   isBoolean: () => isBoolean,
   isFalse: () => isFalse,
@@ -342,6 +343,9 @@ function ifTrue(val, ifVal, elseVal) {
 function isUndefined(i) {
   return typeof i === "undefined";
 }
+function ifUndefined(val, ifVal, elseVal) {
+  return isUndefined(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/type.ts
 var typeApi = () => ({
@@ -508,10 +512,10 @@ var stringOps = (config, boolLogic) => {
   const combined = boolLogic === "AND" ? (input) => conditions.every((c) => c(input)) : (input) => conditions.some((c) => c(input));
   return combined;
 };
-var filterFn = (defn, logicCombinator, ifUndefined = "no-impact") => {
+var filterFn = (defn, logicCombinator, ifUndefined2 = "no-impact") => {
   const config = isNotFilter(defn) ? defn["not"] : defn;
   const filter2 = (input) => {
-    const undefValue = ifUndefined === "no-impact" ? logicCombinator === "AND" ? true : false : ifUndefined;
+    const undefValue = ifUndefined2 === "no-impact" ? logicCombinator === "AND" ? true : false : ifUndefined2;
     let flag;
     if (typeof input === "undefined") {
       flag = undefValue;
@@ -526,8 +530,8 @@ var filterFn = (defn, logicCombinator, ifUndefined = "no-impact") => {
   };
   return filter2;
 };
-var filter = (config, logicCombinator = "AND", ifUndefined = "no-impact") => {
-  return filterFn(config, logicCombinator, ifUndefined);
+var filter = (config, logicCombinator = "AND", ifUndefined2 = "no-impact") => {
+  return filterFn(config, logicCombinator, ifUndefined2);
 };
 
 // src/utility/dictionary/arrayToKeyLookup.ts
@@ -904,6 +908,7 @@ function Model(name) {
   ifString,
   ifTrue,
   ifTypeOf,
+  ifUndefined,
   isArray,
   isBoolean,
   isFalse,

package/dist/index.mjs

@@ -246,6 +246,9 @@ function ifTrue(val, ifVal, elseVal) {
 function isUndefined(i) {
   return typeof i === "undefined";
 }
+function ifUndefined(val, ifVal, elseVal) {
+  return isUndefined(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/type.ts
 var typeApi = () => ({
@@ -412,10 +415,10 @@ var stringOps = (config, boolLogic) => {
   const combined = boolLogic === "AND" ? (input) => conditions.every((c) => c(input)) : (input) => conditions.some((c) => c(input));
   return combined;
 };
-var filterFn = (defn, logicCombinator, ifUndefined = "no-impact") => {
+var filterFn = (defn, logicCombinator, ifUndefined2 = "no-impact") => {
   const config = isNotFilter(defn) ? defn["not"] : defn;
   const filter2 = (input) => {
-    const undefValue = ifUndefined === "no-impact" ? logicCombinator === "AND" ? true : false : ifUndefined;
+    const undefValue = ifUndefined2 === "no-impact" ? logicCombinator === "AND" ? true : false : ifUndefined2;
     let flag;
     if (typeof input === "undefined") {
       flag = undefValue;
@@ -430,8 +433,8 @@ var filterFn = (defn, logicCombinator, ifUndefined = "no-impact") => {
   };
   return filter2;
 };
-var filter = (config, logicCombinator = "AND", ifUndefined = "no-impact") => {
-  return filterFn(config, logicCombinator, ifUndefined);
+var filter = (config, logicCombinator = "AND", ifUndefined2 = "no-impact") => {
+  return filterFn(config, logicCombinator, ifUndefined2);
 };
 
 // src/utility/dictionary/arrayToKeyLookup.ts
@@ -807,6 +810,7 @@ export {
   ifString,
   ifTrue,
   ifTypeOf,
+  ifUndefined,
   isArray,
   isBoolean,
   isFalse,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inferred-types",
-  "version": "0.32.1",
+  "version": "0.33.0",
   "description": "Functions which provide useful type inference on TS projects",
   "license": "MIT",
   "author": "Ken Snyder<ken@ken.net>",

package/src/types/TypeInfo/IsUndefined.ts

@@ -1,9 +1,11 @@
+import { Narrowable } from "../Narrowable";
+
 /**
  * **IsUndefined**
  *
  * Boolean type utility returns `true` if `T` is undefined; `false` otherwise
  */
-export type IsUndefined<T> = T extends undefined ? true : false;
+export type IsUndefined<T extends Narrowable> = T extends undefined ? true : false;
 
 /**
  * **IfUndefined**

package/src/utility/runtime/conditions/isNull.ts

@@ -17,6 +17,10 @@ export function isNull<T extends Narrowable>(i: T) {
  * @param ifVal the value (strongly typed) returned if val is `null`
  * @param elseVal the value (strongly typed) returned if val is NOT `null`
  */
-export function ifNull<T extends Narrowable, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE) {
+export function ifNull<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(
+  val: T,
+  ifVal: IF,
+  elseVal: ELSE
+) {
   return (isNull(val) ? ifVal : elseVal) as IsNull<T> extends true ? IF : ELSE;
 }

package/src/utility/runtime/conditions/isString.ts

@@ -1,3 +1,5 @@
+import { Narrowable } from "src/types";
+
 export type IsString<T> = T extends string ? true : false;
 
 export function isString<T>(i: T) {
@@ -15,6 +17,10 @@ export function isString<T>(i: T) {
  * @param ifVal the value (strongly typed) returned if val is _string_
  * @param elseVal the value (strongly typed) returned if val is NOT a _string
  */
-export function ifString<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE) {
+export function ifString<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(
+  val: T,
+  ifVal: IF,
+  elseVal: ELSE
+) {
   return (isString(val) ? ifVal : elseVal) as IsString<T> extends true ? IF : ELSE;
 }

package/src/utility/runtime/conditions/isUndefined.ts

@@ -1,3 +1,25 @@
-export function isUndefined<T>(i: T) {
+import { Narrowable } from "src/types";
+import { IsUndefined } from "src/types/TypeInfo/IsUndefined";
+
+export function isUndefined<T extends Narrowable>(i: T) {
   return (typeof i === "undefined") as undefined extends T ? true : false;
 }
+
+/**
+ * **ifUndefined**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * _undefined_ and returns one of two values (strongly typed) based on the evaluation
+ * of this criteria.
+ *
+ * @param val the value being tested
+ * @param ifVal the value (strongly typed) returned if val is `undefined`
+ * @param elseVal the value (strongly typed) returned if val is NOT `undefined`
+ */
+export function ifUndefined<T extends Narrowable, IF extends Narrowable, ELSE extends Narrowable>(
+  val: T,
+  ifVal: IF,
+  elseVal: ELSE
+) {
+  return (isUndefined(val) ? ifVal : elseVal) as IsUndefined<T> extends true ? IF : ELSE;
+}

package/tests/runtime/if-is.spec.ts

@@ -1,7 +1,7 @@
 import { describe, it } from "vitest";
 
 import type { Expect, Equal } from "@type-challenges/utils";
-import { ifBoolean, ifNumber, ifString, ifTrue } from "src/utility";
+import { ifBoolean, ifNumber, ifString, ifTrue, ifUndefined } from "src/utility";
 
 describe("runtime if/is", () => {
   it("ifString(v,i,e)", () => {
@@ -49,4 +49,17 @@ describe("runtime if/is", () => {
     ];
     const cases: cases = [true, true, true];
   });
+
+  it("ifUndefined(v,i,e)", () => {
+    const t = ifUndefined(undefined, 42, false);
+    const f = ifUndefined(false, "yikes", 42);
+    const f2 = ifUndefined("", "yikes", 42);
+
+    type cases = [
+      Expect<Equal<typeof t, 42>>, //
+      Expect<Equal<typeof f, 42>>, //
+      Expect<Equal<typeof f2, 42>> //
+    ];
+    const cases: cases = [true, true, true];
+  });
 });