@longlast/function-provenance 0.1.0 → 0.1.2

package/README.md

@@ -15,10 +15,6 @@ pnpm add @longlast/function-provenance
 yarn add @longlast/function-provenance
 ```
 
-## Use
-
-TODO
-
 ## Documentation
 
 [Browse the docs on longlast.js.org][docs].

package/dist/index.d.ts

@@ -11,7 +11,14 @@ export interface FunctionProvenance {
     displayName: string;
     [$nonUserConstructible]: true;
 }
+type UnknownFunction = (...args: never) => unknown;
 export declare function getBoundArguments(f: AnyFunction): unknown[];
 export declare function getUnapplied(f: AnyFunction): UnknownFunction;
-type UnknownFunction = (...args: never) => unknown;
+/**
+ * Transfers provenance information from the `source` function to `dest`, which
+ * is assumed to be a partial application of `source`.
+ *
+ * @param args the arguments that were applied to create `dest` from `source`.
+ */
+export declare function trackProvenance<F extends AnyFunction>(source: UnknownFunction, args: readonly unknown[], dest: F): F;
 export {};

package/dist/index.js

@@ -3,9 +3,27 @@
  * @hidden
  */
 import { $getBoundArguments, $unapplied } from "@longlast/symbols";
+import { getFunctionName } from "@longlast/function-name";
 export function getBoundArguments(f) {
     return f[$getBoundArguments]?.() ?? [];
 }
 export function getUnapplied(f) {
     return f[$unapplied] ?? f;
 }
+/**
+ * Transfers provenance information from the `source` function to `dest`, which
+ * is assumed to be a partial application of `source`.
+ *
+ * @param args the arguments that were applied to create `dest` from `source`.
+ */
+export function trackProvenance(source, args, dest) {
+    unsafeNarrow(dest);
+    dest.displayName = getFunctionName(source);
+    dest[$getBoundArguments] = () => getBoundArguments(source).concat(args);
+    dest[$unapplied] = getUnapplied(source);
+    return dest;
+}
+// TODO: unsafeNarrow is duplicated in equals.
+function unsafeNarrow(value) {
+    value;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@longlast/function-provenance",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Imbues partially-applied functions with knowledge of their origins",
   "homepage": "https://longlast.js.org/",
   "license": "MIT",
@@ -18,6 +18,7 @@
   },
   "dependencies": {
     "@longlast/any-function": "^0.0.1",
+    "@longlast/function-name": "^0.0.1",
     "@longlast/symbols": "^1.1.0"
   }
 }