inferred-types 0.19.0 → 0.19.1

package/dist/index.d.ts

@@ -1114,6 +1114,14 @@ declare type WrapValue<T extends {}, F extends ValueFunction<T>> = {
 };
 
 declare function createFnWithProps<F extends Function, P extends {}>(fn: F, props: P): F & P;
+/**
+ * Adds a dictionary of key/value pairs to a function.
+ */
+declare function fnWithProps<A extends any[], R extends any, P extends {}>(fn: ((...args: A) => R), props: P): ((...args: A) => R) & P;
+/**
+ * Adds read-only (and narrowly typed) key/value pairs to a function
+ */
+declare function readonlyFnWithProps<A extends any[], R extends any, N extends Narrowable, P extends Record<keyof P, N>>(fn: ((...args: A) => R), props: P): ((...args: A) => R) & Readonly<P>;
 
 /**
  * Provides the _keys_ of an object with the `keyof T` made explicit.
@@ -9788,4 +9796,4 @@ declare function KeyStorage(): {
     done: () => never[];
 };
 
-export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, ClosingBracket, Condition, Configurator, Constructor, DashToSnake, DashUppercase, Dasherize, DictArray, DictArrayFilterCallback, DictArrayKv, DictFromKv, DictKvTuple, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, ExtendsClause, ExtendsNarrowlyClause, Filter, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfExtends, IfExtendsThen, Include, Includes, IsArray, IsBoolean, IsCapitalized, IsFalse, IsFunction, IsLiteral, IsObject, IsString, IsTrue, KebabCase, KeyStorage, KeyStorageApi, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LowerAllCaps, LowerAlpha, MaybeFalse, MaybeTrue, Model, Mutable, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, NotEmptyObject, Numeric, NumericKeys, NumericString, ObjectType, Opaque, OpenningBracket, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SnakeCase, SpecialCharacters, StringDelimiter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefinition, TypeGuard, TypeOptions, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, UnwrapValue, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, WithNumericKeys, WithStringKeys, WithValue, WrapValue, ZipCode, and, api, arrayToKeyLookup, arrayToObject, condition, createFnWithProps, createMutationFunction, defineType, dictToKv, dictionaryTransform, entries, equals, filterDictArray, greater, groupBy, idLiteral, idTypeGuard, identity, ifTypeOf, isArray, isBoolean, isFalse, isFunction, isLiteral, isNull, isNumber, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, less, literal, mapValues, nameLiteral, or, randomString, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, valuesOfProp, withValue };
+export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, ClosingBracket, Condition, Configurator, Constructor, DashToSnake, DashUppercase, Dasherize, DictArray, DictArrayFilterCallback, DictArrayKv, DictFromKv, DictKvTuple, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, ExtendsClause, ExtendsNarrowlyClause, Filter, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfExtends, IfExtendsThen, Include, Includes, IsArray, IsBoolean, IsCapitalized, IsFalse, IsFunction, IsLiteral, IsObject, IsString, IsTrue, KebabCase, KeyStorage, KeyStorageApi, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LowerAllCaps, LowerAlpha, MaybeFalse, MaybeTrue, Model, Mutable, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, NotEmptyObject, Numeric, NumericKeys, NumericString, ObjectType, Opaque, OpenningBracket, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SnakeCase, SpecialCharacters, StringDelimiter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefinition, TypeGuard, TypeOptions, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, UnwrapValue, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, WithNumericKeys, WithStringKeys, WithValue, WrapValue, ZipCode, and, api, arrayToKeyLookup, arrayToObject, condition, createFnWithProps, createMutationFunction, defineType, dictToKv, dictionaryTransform, entries, equals, filterDictArray, fnWithProps, greater, groupBy, idLiteral, idTypeGuard, identity, ifTypeOf, isArray, isBoolean, isFalse, isFunction, isLiteral, isNull, isNumber, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, less, literal, mapValues, nameLiteral, or, randomString, readonlyFnWithProps, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, valuesOfProp, withValue };

package/dist/index.js

@@ -60,6 +60,7 @@ __export(src_exports, {
   entries: () => entries,
   equals: () => equals,
   filterDictArray: () => filterDictArray,
+  fnWithProps: () => fnWithProps,
   greater: () => greater,
   groupBy: () => groupBy,
   idLiteral: () => idLiteral,
@@ -89,6 +90,7 @@ __export(src_exports, {
   nameLiteral: () => nameLiteral,
   or: () => or,
   randomString: () => randomString,
+  readonlyFnWithProps: () => readonlyFnWithProps,
   ruleSet: () => ruleSet,
   strArrayToDict: () => strArrayToDict,
   type: () => type,
@@ -158,6 +160,20 @@ function createFnWithProps(fn, props) {
     return combined;
   })();
 }
+function fnWithProps(fn, props) {
+  let combined = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined;
+}
+function readonlyFnWithProps(fn, props) {
+  let combined = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined;
+}
 
 // src/utility/ruleset.ts
 function ruleSet(defn) {
@@ -641,6 +657,7 @@ module.exports = __toCommonJS(src_exports);
   entries,
   equals,
   filterDictArray,
+  fnWithProps,
   greater,
   groupBy,
   idLiteral,
@@ -670,6 +687,7 @@ module.exports = __toCommonJS(src_exports);
   nameLiteral,
   or,
   randomString,
+  readonlyFnWithProps,
   ruleSet,
   strArrayToDict,
   type,

package/dist/index.mjs

@@ -77,6 +77,20 @@ function createFnWithProps(fn, props) {
     return combined;
   })();
 }
+function fnWithProps(fn, props) {
+  let combined = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined;
+}
+function readonlyFnWithProps(fn, props) {
+  let combined = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined;
+}
 
 // src/utility/ruleset.ts
 function ruleSet(defn) {
@@ -558,6 +572,7 @@ export {
   entries,
   equals,
   filterDictArray,
+  fnWithProps,
   greater,
   groupBy,
   idLiteral,
@@ -587,6 +602,7 @@ export {
   nameLiteral,
   or,
   randomString,
+  readonlyFnWithProps,
   ruleSet,
   strArrayToDict,
   type,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inferred-types",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "description": "Functions which provide useful type inference on TS projects",
   "license": "MIT",
   "author": "Ken Snyder<ken@ken.net>",
@@ -14,6 +14,9 @@
     "build": "run-s clean autoindex lint build:bundle",
     "build:force": "run-s clean autoindex build:bundle",
     "build:bundle": "npx tsup src/index.ts --dts --format='esm,cjs'",
+    "watch": "run-p watch:*",
+    "watch:autoindex": "npx dd autoindex --watch",
+    "watch:bundle": "npx tsup src/index.ts --dts --format='esm,cjs' --watch",
     "clean": "rimraf dist/**/*",
     "lint": "eslint src/**/*.ts --fix && tsc --noEmit ",
     "lint:full": "eslint src/**/*.ts && eslint test/**/*.ts && tsc --noEmit",

package/src/types/FunctionType.ts

@@ -6,4 +6,4 @@
  */
 export type FunctionType<T extends {} = {}> = {} extends T
   ? Function | (Function & { [key: string]: any })
-  : Function | (Function & T);
+  : Function | (Function & T);

package/src/utility/createFnWithProps.ts

@@ -1,3 +1,4 @@
+import { Narrowable } from "../types/Narrowable";
 import { keys } from "./keys";
 
 export function createFnWithProps<F extends Function, P extends {}>(fn: F, props: P) {
@@ -9,4 +10,28 @@ export function createFnWithProps<F extends Function, P extends {}>(fn: F, props
     }
     return combined;
   })() as unknown as F & P;
-}
+}
+
+/**
+ * Adds a dictionary of key/value pairs to a function.
+ */
+export function fnWithProps<A extends any[], R extends any, P extends {}>(fn: ((...args: A) => R), props: P) {
+  // eslint-disable-next-line prefer-const
+  let combined: any = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined as ((...args: A) => R) & P;
+}
+
+/**
+ * Adds read-only (and narrowly typed) key/value pairs to a function
+ */
+export function readonlyFnWithProps<A extends any[], R extends any, N extends Narrowable, P extends Record<keyof P, N>>(fn: ((...args: A) => R), props: P) {
+  // eslint-disable-next-line prefer-const
+  let combined: any = fn;
+  for (const prop of keys(props)) {
+    combined[prop] = props[prop];
+  }
+  return combined as ((...args: A) => R) & Readonly<P>;
+}