inferred-types 0.32.0 → 0.32.1

package/dist/index.d.ts

@@ -594,6 +594,18 @@ declare type IsBoolean<T> = T extends boolean ? true : false;
  * Runtime and type checks whether a variable is a boolean value.
  */
 declare function isBoolean<T extends any>(i: T): IsBoolean<T>;
+/**
+ * **ifBoolean**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * a _boolean_ 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 _boolean_
+ * @param elseVal the value (strongly typed) returned if val is NOT a _boolean
+ */
+declare function ifBoolean<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE): IsBoolean<T> extends true ? IF : ELSE;
 
 declare type IsFalse<T extends Narrowable> = IsBoolean<T> extends true ? T extends false ? true : true extends T ? false : unknown : false;
 declare function isFalse<T>(i: T): IsFalse<T>;
@@ -613,7 +625,20 @@ declare type IsFunction<T> = T extends FunctionType ? true : false;
  */
 declare function isFunction<T extends unknown>(input: T): IsFunction<T>;
 
-declare function isNull<T>(i: T): T extends null ? true : false;
+declare type IsNull<T> = T extends null ? true : false;
+declare function isNull<T extends Narrowable>(i: T): T extends null ? true : false;
+/**
+ * **ifNull**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * Null 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 `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 type IsNumber<T> = T extends number ? true : false;
 declare function isNumber<T>(i: T): T extends number ? true : false;
@@ -674,6 +699,18 @@ declare type IsTrue<T> = IsBoolean<T> extends true ? T extends true ? true : T e
  * Run-time and type checking of whether a variable is `true`.
  */
 declare function isTrue<T extends Narrowable>(i: T): IsTrue<T>;
+/**
+ * **ifTrue**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * a _true_ 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 _true_ value
+ * @param elseVal the value (strongly typed) returned if val is NOT a _true_ value
+ */
+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;
 
@@ -2334,4 +2371,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, 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, ifNumber, ifString, 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, 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

@@ -50,8 +50,11 @@ __export(src_exports, {
   idLiteral: () => idLiteral,
   idTypeGuard: () => idTypeGuard,
   identity: () => identity,
+  ifBoolean: () => ifBoolean,
+  ifNull: () => ifNull,
   ifNumber: () => ifNumber,
   ifString: () => ifString,
+  ifTrue: () => ifTrue,
   ifTypeOf: () => ifTypeOf,
   isArray: () => isArray,
   isBoolean: () => isBoolean,
@@ -279,6 +282,9 @@ function isArray(i) {
 function isBoolean(i) {
   return typeof i === "boolean";
 }
+function ifBoolean(val, ifVal, elseVal) {
+  return isBoolean(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/conditions/isFalse.ts
 function isFalse(i) {
@@ -294,6 +300,9 @@ function isFunction(input) {
 function isNull(i) {
   return i === null;
 }
+function ifNull(val, ifVal, elseVal) {
+  return isNull(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/conditions/isNumber.ts
 function isNumber(i) {
@@ -323,7 +332,10 @@ function isSymbol(i) {
 
 // src/utility/runtime/conditions/isTrue.ts
 function isTrue(i) {
-  return typeof i === "boolean" && i;
+  return typeof i === "boolean" && i === true;
+}
+function ifTrue(val, ifVal, elseVal) {
+  return isTrue(val) ? ifVal : elseVal;
 }
 
 // src/utility/runtime/conditions/isUndefined.ts
@@ -886,8 +898,11 @@ function Model(name) {
   idLiteral,
   idTypeGuard,
   identity,
+  ifBoolean,
+  ifNull,
   ifNumber,
   ifString,
+  ifTrue,
   ifTypeOf,
   isArray,
   isBoolean,

package/dist/index.mjs

@@ -186,6 +186,9 @@ function isArray(i) {
 function isBoolean(i) {
   return typeof i === "boolean";
 }
+function ifBoolean(val, ifVal, elseVal) {
+  return isBoolean(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/conditions/isFalse.ts
 function isFalse(i) {
@@ -201,6 +204,9 @@ function isFunction(input) {
 function isNull(i) {
   return i === null;
 }
+function ifNull(val, ifVal, elseVal) {
+  return isNull(val) ? ifVal : elseVal;
+}
 
 // src/utility/runtime/conditions/isNumber.ts
 function isNumber(i) {
@@ -230,7 +236,10 @@ function isSymbol(i) {
 
 // src/utility/runtime/conditions/isTrue.ts
 function isTrue(i) {
-  return typeof i === "boolean" && i;
+  return typeof i === "boolean" && i === true;
+}
+function ifTrue(val, ifVal, elseVal) {
+  return isTrue(val) ? ifVal : elseVal;
 }
 
 // src/utility/runtime/conditions/isUndefined.ts
@@ -792,8 +801,11 @@ export {
   idLiteral,
   idTypeGuard,
   identity,
+  ifBoolean,
+  ifNull,
   ifNumber,
   ifString,
+  ifTrue,
   ifTypeOf,
   isArray,
   isBoolean,

package/package.json

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

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

@@ -6,3 +6,18 @@ export type IsBoolean<T> = T extends boolean ? true : false;
 export function isBoolean<T extends any>(i: T) {
   return (typeof i === "boolean") as IsBoolean<T>;
 }
+
+/**
+ * **ifBoolean**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * a _boolean_ 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 _boolean_
+ * @param elseVal the value (strongly typed) returned if val is NOT a _boolean
+ */
+export function ifBoolean<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE) {
+  return (isBoolean(val) ? ifVal : elseVal) as IsBoolean<T> extends true ? IF : ELSE;
+}

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

@@ -1,3 +1,22 @@
-export function isNull<T>(i: T) {
+import { Narrowable } from "src/types";
+
+export type IsNull<T> = T extends null ? true : false;
+
+export function isNull<T extends Narrowable>(i: T) {
   return (i === null) as T extends null ? true : false;
 }
+
+/**
+ * **ifNull**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * Null 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 `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) {
+  return (isNull(val) ? ifVal : elseVal) as IsNull<T> extends true ? IF : ELSE;
+}

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

@@ -1,4 +1,4 @@
-import { Narrowable } from "src/types/Narrowable";
+import { Narrowable } from "src/types";
 import type { IsBoolean } from "./isBoolean";
 
 /**
@@ -28,5 +28,20 @@ export type IsTrue<T> = IsBoolean<T> extends true
  * Run-time and type checking of whether a variable is `true`.
  */
 export function isTrue<T extends Narrowable>(i: T) {
-  return (typeof i === "boolean" && i) as IsTrue<T>;
+  return (typeof i === "boolean" && i === true) as IsTrue<T>;
+}
+
+/**
+ * **ifTrue**
+ *
+ * Strongly type-aware conditional statement which checks whether a value is
+ * a _true_ 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 _true_ value
+ * @param elseVal the value (strongly typed) returned if val is NOT a _true_ value
+ */
+export function ifTrue<T, IF, ELSE>(val: T, ifVal: IF, elseVal: ELSE) {
+  return (isTrue(val) ? ifVal : elseVal) as IsTrue<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 { ifString } from "src/utility";
+import { ifBoolean, ifNumber, ifString, ifTrue } from "src/utility";
 
 describe("runtime if/is", () => {
   it("ifString(v,i,e)", () => {
@@ -14,4 +14,39 @@ describe("runtime if/is", () => {
     ];
     const cases: cases = [true, true];
   });
+
+  it("ifNumber(v,i,e)", () => {
+    const t = ifNumber(42, 42, false);
+    const f = ifNumber("foo", "yikes", 42);
+
+    type cases = [
+      Expect<Equal<typeof t, 42>>, //
+      Expect<Equal<typeof f, 42>> //
+    ];
+    const cases: cases = [true, true];
+  });
+
+  it("ifBoolean(v,i,e)", () => {
+    const t = ifBoolean(false, 42, false);
+    const f = ifBoolean(undefined, "yikes", 42);
+
+    type cases = [
+      Expect<Equal<typeof t, 42>>, //
+      Expect<Equal<typeof f, 42>> //
+    ];
+    const cases: cases = [true, true];
+  });
+
+  it("ifTrue(v,i,e)", () => {
+    const t = ifTrue(true as true, 42, false);
+    const f = ifTrue(false, "yikes", 42);
+    const f2 = ifTrue(true as boolean, "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];
+  });
 });

package/tests/runtime/type.spec.ts

@@ -130,8 +130,8 @@ describe("testing type() utility and some pre-made conditions", () => {
 
     expect(t.name).toBe("true");
 
-    const trueIsTrue = t.is(true);
-    const falseNotTrue = t.is(false);
+    const trueIsTrue = t.is(true as true);
+    const falseNotTrue = t.is(false as false);
     const nadaNotTrue = t.is("nada");
     const b = true as boolean;
     const booleanUnknown = t.is(b);