@dereekb/util 7.4.0 → 7.5.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [7.5.0](https://github.com/dereekb/dbx-components/compare/v7.4.0-dev...v7.5.0) (2022-06-08)
+
+
+### Features
+
+* added UseFunction, MappedUseFunction ([84b6cbe](https://github.com/dereekb/dbx-components/commit/84b6cbe23b7e020ad7de49633642429d7e32f7d4))
+
+
+
 # [7.4.0](https://github.com/dereekb/dbx-components/compare/v7.3.0-dev...v7.4.0) (2022-06-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "type": "commonjs",
   "exports": {
     ".": {

package/src/lib/value/index.d.ts

@@ -5,3 +5,4 @@ export * from './maybe.type';
 export * from './maybe';
 export * from './modifier';
 export * from './url';
+export * from './use';

package/src/lib/value/index.js

@@ -8,4 +8,5 @@ tslib_1.__exportStar(require("./maybe.type"), exports);
 tslib_1.__exportStar(require("./maybe"), exports);
 tslib_1.__exportStar(require("./modifier"), exports);
 tslib_1.__exportStar(require("./url"), exports);
+tslib_1.__exportStar(require("./use"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/value/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,kDAAwB;AACxB,gDAAsB;AACtB,uDAA6B;AAC7B,kDAAwB;AACxB,qDAA2B;AAC3B,gDAAsB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,kDAAwB;AACxB,gDAAsB;AACtB,uDAA6B;AAC7B,kDAAwB;AACxB,qDAA2B;AAC3B,gDAAsB;AACtB,gDAAsB"}

package/src/lib/value/use.d.ts

@@ -0,0 +1,22 @@
+import { GetterOrValue } from '../getter';
+import { MapFunction } from './map';
+import { Maybe } from './maybe.type';
+/**
+ * A map function with the intent of using the input value, and returning another value.
+ */
+export declare type UseValue<I, O = void> = MapFunction<I, O>;
+export declare function useValue<I, O = void>(input: Maybe<I>, use: UseValue<I, O>, defaultValue?: Maybe<GetterOrValue<O>>): Maybe<O>;
+export declare type UseFunction<I> = MappedUseFunction<I, I>;
+export declare type MappedUseFunction<A, I> = <O = void>(input: Maybe<A>, use: UseValue<I, O>, defaultValue?: Maybe<GetterOrValue<O>>) => Maybe<O>;
+/**
+ * Creates a MappedUseFunction.
+ */
+export declare function mappedUseFunction<A, I>(map: MapFunction<A, Maybe<I>>): MappedUseFunction<A, I>;
+/**
+ * Runs a pre-determined function on the input to return a value.
+ */
+export declare type UseContextFunction<I> = <O>(input: Maybe<I>) => Maybe<O>;
+/**
+ * Creates a UseContextFunction.
+ */
+export declare function useContextFunction<I, O>(use: UseValue<I, O>, defaultValue?: GetterOrValue<O>): UseContextFunction<I>;

package/src/lib/value/use.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useContextFunction = exports.mappedUseFunction = exports.useValue = void 0;
+const getter_1 = require("../getter");
+function useValue(input, use, defaultValue) {
+    let result;
+    if (input != null) {
+        result = use(input);
+    }
+    else {
+        result = (0, getter_1.getValueFromGetter)(defaultValue);
+    }
+    return result;
+}
+exports.useValue = useValue;
+/**
+ * Creates a MappedUseFunction.
+ */
+function mappedUseFunction(map) {
+    return ((input, useFn, defaultValue) => {
+        return useValue(input, ((value) => useValue(map(value), useFn, defaultValue)), defaultValue);
+    });
+}
+exports.mappedUseFunction = mappedUseFunction;
+/**
+ * Creates a UseContextFunction.
+ */
+function useContextFunction(use, defaultValue) {
+    return ((input) => {
+        let result;
+        if (input != null) {
+            result = use(input);
+        }
+        else {
+            result = (0, getter_1.getValueFromGetter)(defaultValue);
+        }
+        return result;
+    });
+}
+exports.useContextFunction = useContextFunction;
+//# sourceMappingURL=use.js.map

package/src/lib/value/use.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/use.ts"],"names":[],"mappings":";;;AAAA,sCAA8D;AAU9D,SAAgB,QAAQ,CAAc,KAAe,EAAE,GAAmB,EAAE,YAAsC;IAChH,IAAI,MAAgB,CAAC;IAErB,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAa,CAAC;KACjC;SAAM;QACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;KAC3C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,4BAUC;AAKD;;GAEG;AACH,SAAgB,iBAAiB,CAAO,GAA6B;IACnE,OAAO,CAAC,CAAW,KAAe,EAAE,KAAqB,EAAE,YAAsC,EAAE,EAAE;QACnG,OAAO,QAAQ,CAAO,KAAK,EAAE,CAAC,CAAC,KAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAmB,EAAE,YAAY,CAAC,CAAC;IAC1H,CAAC,CAA4B,CAAC;AAChC,CAAC;AAJD,8CAIC;AAOD;;GAEG;AACH,SAAgB,kBAAkB,CAAO,GAAmB,EAAE,YAA+B;IAC3F,OAAO,CAAC,CAAC,KAAe,EAAE,EAAE;QAC1B,IAAI,MAAgB,CAAC;QAErB,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;SACrB;aAAM;YACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;SAC3C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAA0B,CAAC;AAC9B,CAAC;AAZD,gDAYC"}

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [7.5.0](https://github.com/dereekb/dbx-components/compare/v7.4.0-dev...v7.5.0) (2022-06-08)
+
+
+
 # [7.4.0](https://github.com/dereekb/dbx-components/compare/v7.3.0-dev...v7.4.0) (2022-06-08)
 
 

package/test/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/util/test",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@dereekb/util": "7.4.0",
+    "@dereekb/util": "7.5.0",
     "make-error": "^1.3.0",
     "ts-essentials": "^9.1.2",
     "extra-set": "^2.2.11",