functionalscript 0.1.605 → 0.1.606

package/jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@functionalscript/functionalscript",
-  "version": "0.1.605",
+  "version": "0.1.606",
   "exports": {
     "./com/cpp": "./com/cpp/module.f.mjs",
     "./com/cs": "./com/cs/module.f.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "functionalscript",
-  "version": "0.1.605",
+  "version": "0.1.606",
   "type": "module",
   "description": "FunctionalScript is a functional subset of JavaScript",
   "main": "index.f.mjs",

package/types/function/module.f.d.mts

@@ -5,14 +5,26 @@ declare namespace _default {
     export { fn };
 }
 export default _default;
+/**
+ * A generic function type.
+ */
 export type Func<I, O> = (_: I) => O;
+/**
+ * A functional utility type that enables seamless chaining of transformations.
+ */
 export type Fn<I, O> = {
     readonly result: Func<I, O>;
     readonly then: <T>(g: Func<O, T>) => Fn<I, T>;
 };
-/** @type {<T>(value: T) => T} */
+/**
+ * A generic identity function.
+ *
+ * @type {<T>(value: T) => T}
+ */
 declare const identity: <T>(value: T) => T;
 /**
+ * A generic function type.
+ *
  * @template I
  * @template O
  * @typedef {(_: I) => O} Func
@@ -23,14 +35,32 @@ declare const identity: <T>(value: T) => T;
  * @type {<I, X>(g: Func<I, X>) => <O>(f: Func<X, O>) => Func<I, O>}
  */
 declare const compose: <I, X>(g: Func<I, X>) => <O>(f: Func<X, O>) => Func<I, O>;
-/** @type {<A, B, C>(f: (a: A) => (b: B) => C) => (b: B) => (a: A) => C} */
+/**
+ * Flips the arguments of a curried function.
+ *
+ * @type {<A, B, C>(f: (a: A) => (b: B) => C) => (b: B) => (a: A) => C}
+ */
 declare const flip: <A, B, C>(f: (a: A) => (b: B) => C) => (b: B) => (a: A) => C;
 /**
+ * A functional utility type that enables seamless chaining of transformations.
+ *
  * @template I,O
  * @typedef {{
  *  readonly result: Func<I, O>
  *  readonly then: <T>(g: Func<O, T>) => Fn<I, T>
  * }} Fn
  */
-/** @type {<I, O>(f: (i: I) => O) => Fn<I, O>} */
+/**
+ * Creates an `Fn` instance from a function, enabling chaining of transformations.
+ *
+ * @type {<I, O>(f: (i: I) => O) => Fn<I, O>}
+ *
+ * @example
+ * const add2 = (x) => x + 2; // Adds 2
+ * const multiply3 = (x) => x * 3; // Multiplies by 3
+ *
+ * // Chain transformations
+ * const add2multiply3 = fn(add2).then(multiply3).result;
+ * const result = add2multiply3(5); // result is 21. (5 + 2) * 3.
+ */
 declare const fn: <I, O>(f: (i: I) => O) => Fn<I, O>;

package/types/function/module.f.mjs

@@ -1,5 +1,8 @@
 // @ts-self-types="./module.f.d.mts"
+
 /**
+ * A generic function type.
+ *
  * @template I
  * @template O
  * @typedef {(_: I) => O} Func
@@ -12,13 +15,23 @@
  */
 const compose = g => f => x => f(g(x))
 
-/** @type {<T>(value: T) => T} */
+/**
+ * A generic identity function.
+ *
+ * @type {<T>(value: T) => T}
+ */
 const identity = value => value
 
-/** @type {<A, B, C>(f: (a: A) => (b: B) => C) => (b: B) => (a: A) => C} */
+/**
+ * Flips the arguments of a curried function.
+ *
+ * @type {<A, B, C>(f: (a: A) => (b: B) => C) => (b: B) => (a: A) => C}
+ */
 const flip = f => b => a => f(a)(b)
 
 /**
+ * A functional utility type that enables seamless chaining of transformations.
+ *
  * @template I,O
  * @typedef {{
  *  readonly result: Func<I, O>
@@ -26,7 +39,19 @@ const flip = f => b => a => f(a)(b)
  * }} Fn
  */
 
-/** @type {<I, O>(f: (i: I) => O) => Fn<I, O>} */
+/**
+ * Creates an `Fn` instance from a function, enabling chaining of transformations.
+ *
+ * @type {<I, O>(f: (i: I) => O) => Fn<I, O>}
+ *
+ * @example
+ * const add2 = (x) => x + 2; // Adds 2
+ * const multiply3 = (x) => x * 3; // Multiplies by 3
+ *
+ * // Chain transformations
+ * const add2multiply3 = fn(add2).then(multiply3).result;
+ * const result = add2multiply3(5); // result is 21. (5 + 2) * 3.
+ */
 const fn = result => ({
     result,
     then: g => fn(compose(result)(g))